Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to interact programmatically with various Dataiku DSS resources and operations. Specifically, for the Machine Learning - Lab resource and the Download Model Documentation of Trained Model operation, the node allows downloading the documentation file associated with a trained machine learning model within a project.

Typical use cases include:

  • Automating retrieval of model documentation for reporting or auditing purposes.
  • Integrating model documentation download into larger workflows that manage ML lifecycle.
  • Archiving or sharing model documentation files as part of deployment pipelines.

For example, a user can configure this node to download the latest documentation of a trained model after training completes, then store or distribute it automatically.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the trained model.
Export ID The identifier of the exported model documentation to download (required for this operation).

These properties are required to specify which project's model documentation to download and which specific export/documentation file to retrieve.

Output

The output contains either:

  • Binary data: The downloaded model documentation file is returned as binary data under the binary.data field. The filename is set to "model_documentation.docx", indicating a Word document format.

  • JSON data: In other operations (not this one), JSON responses from the API would be returned in the json field.

For this operation, the main output is the binary content of the model documentation file, suitable for saving or further processing.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials including the DSS server URL and a user API key.
  • The node uses HTTP requests to the Dataiku DSS REST API endpoints.
  • No additional external libraries beyond those bundled with n8n are needed.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error "Missing Dataiku DSS API Credentials". Ensure you have configured the API key credential correctly.
  • Required Parameter Missing: Errors like "Project Key is required" or "Export ID is required" indicate missing mandatory input parameters. Verify all required fields are filled.
  • HTTP Request Failures: Network issues, incorrect server URLs, or permission problems on the Dataiku side may cause request failures. Check connectivity and permissions.
  • Unexpected Response Format: If the response cannot be parsed as expected, ensure the API endpoint and parameters are correct and compatible with your Dataiku DSS version.

Links and References


This summary focuses on the "Machine Learning - Lab" resource and the "Download Model Documentation of Trained Model" operation, describing how to use the node to download model documentation files from Dataiku DSS projects.

Discussion