Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Notebook resource and the Get Jupyter Notebook operation, it retrieves the content or metadata of a specified Jupyter notebook within a given project.

Typical use cases include:

  • Automating retrieval of Jupyter notebooks from Dataiku projects for further processing or analysis.
  • Integrating notebook data into workflows that require programmatic access to notebook contents.
  • Managing notebooks as part of larger automation pipelines involving Dataiku DSS.

Example: Fetching a Jupyter notebook named "Analysis.ipynb" from project "MY_PROJECT" to analyze its structure or extract code cells.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the notebook.
Notebook Name The name of the Jupyter notebook to retrieve within the specified project.

Output

The node outputs the response from the Dataiku DSS API call to get the Jupyter notebook. The output is structured as JSON in the json field of the returned item.

  • The JSON contains the notebook's details as provided by the Dataiku DSS API, which typically includes metadata and the notebook content.
  • If the notebook content includes binary data (not typical for this operation), it would be handled accordingly, but for "Get Jupyter Notebook," the output is JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameters Missing: The node validates required parameters such as Project Key and Notebook Name. Omitting these will cause errors specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions can cause API request failures. Check connectivity and credential permissions.
  • Parsing Errors: If the API returns unexpected data formats, JSON parsing might fail. This is rare for this operation but possible if the server response is malformed.

Links and References

Discussion