Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on Dataiku DSS resources directly from n8n workflows. Specifically, for the Machine Learning - Lab resource and the Generate Model Documentation From Custom Template operation, the node starts the generation of model documentation using a custom template file attached by the user.

This functionality is useful when you want to automate the creation of detailed documentation for machine learning models managed in Dataiku DSS, leveraging your own custom templates to tailor the output to your organization's standards or specific needs.

Practical example:
You have trained a machine learning model in Dataiku DSS and want to generate comprehensive documentation that includes model details, performance metrics, and explanations formatted according to your company's branding and style guidelines. Using this node operation, you can trigger the documentation generation process with your custom template automatically as part of an automated workflow.

Properties

Name Meaning
Project Key The key identifier of the Dataiku DSS project where the ML model resides.
Analysis ID The identifier of the analysis within the project related to the ML task.
ML Task ID The identifier of the machine learning task associated with the model.
Model Full ID The full identifier of the trained model for which documentation will be generated.
File The custom template file content (binary) used to generate the model documentation.

Output

The node outputs the response from the Dataiku DSS API after initiating the documentation generation. The output is typically JSON data indicating the status or result of the request.

If the operation involves downloading files (not specifically this operation), the node can output binary data representing the downloaded file. However, for this operation, the output is JSON confirming the start of the documentation generation process.

Example output JSON structure:

{
  "status": "success",
  "message": "Model documentation generation started",
  "details": {
    "projectKey": "PROJECT_KEY",
    "analysisId": "ANALYSIS_ID",
    "mlTaskId": "ML_TASK_ID",
    "modelFullId": "MODEL_FULL_ID"
  }
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key token) for authentication with the Dataiku DSS API.
  • The node expects the custom template file to be provided as binary data input in the File property.
  • Network access to the Dataiku DSS server must be configured properly in n8n environment.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are correctly set up in n8n.
  • Required Parameter Missing: Errors like "Project Key is required" or "Analysis ID is required" indicate that mandatory parameters were not provided. Verify all required fields are filled.
  • Invalid Model Full ID: If the model identifier is incorrect or does not exist, the API call will fail. Confirm the model ID is accurate.
  • File Upload Issues: Ensure the custom template file is correctly attached as binary data; otherwise, the upload will fail.
  • API Connection Errors: Network issues or incorrect server URLs can cause failures. Check connectivity and server address configuration.
  • Unexpected API Response: If the API returns errors, review the message for clues and verify that the Dataiku DSS instance supports the requested operation.

Links and References

This summary focuses on the Machine Learning - Lab resource and the Generate Model Documentation From Custom Template operation, describing its purpose, inputs, outputs, dependencies, and common troubleshooting tips based on static code analysis of the node implementation.

Discussion