Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku resources. Specifically for the Notebook resource and the Clear Jupyter Notebook Outputs operation, it clears all outputs from a specified Jupyter notebook within a given project. This is useful when you want to reset a notebook's state by removing all cell outputs, for example before sharing or versioning the notebook without output clutter.

Common scenarios include:

  • Cleaning notebooks before committing them to version control.
  • Resetting notebooks in automated workflows to ensure fresh execution.
  • Removing outputs to reduce notebook file size.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the notebook.
Notebook Name The name of the Jupyter notebook whose outputs will be cleared.

Output

The node returns the response from the Dataiku DSS API after clearing the notebook outputs. The output is JSON formatted and typically contains confirmation or status information about the operation.

If the operation involves downloading files (not applicable here), binary data would be returned, but for clearing notebook outputs, only JSON response is expected.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires an API key credential for authenticating requests to 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 key credential is not provided or invalid, the node will throw an error indicating missing credentials.
  • Missing Required Parameters: The node validates that both "Project Key" and "Notebook Name" are provided; if either is missing, it throws an error specifying which parameter is required.
  • API Request Failures: Network issues, incorrect project or notebook names, or insufficient permissions can cause API errors. The node surfaces these errors with messages prefixed by "Error calling Dataiku DSS API".
  • Unexpected Response Format: If the API returns non-JSON or unexpected content, the node attempts to handle it gracefully but may return raw text or binary data depending on the operation.

To resolve issues:

  • Ensure correct and complete input parameters.
  • Verify API credentials and permissions.
  • Check network connectivity to the Dataiku DSS server.
  • Review API error messages for specific causes.

Links and References


This summary focuses on the "Notebook" resource and the "Clear Jupyter Notebook Outputs" operation as requested.

Discussion