Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API to manage various resources within a Dataiku project. Specifically, for the Machine Learning - Saved Model resource and the Generate Model Documentation From Default Template operation, it triggers the generation of model documentation for a specified saved model version using a default template.

This functionality is useful when you want to automatically create standardized documentation for machine learning models stored in Dataiku DSS, facilitating model governance, auditing, and sharing insights about the model's characteristics and performance.

Practical example:
You have a saved ML model version in your Dataiku project and want to generate its documentation using the default template without manual intervention. This node can be used in an automation workflow to trigger that documentation generation process programmatically.

Properties

Output

The node outputs the response from the Dataiku DSS API call as JSON data. For this operation, the output typically includes information about the status or result of the documentation generation request.

• The json field contains the parsed JSON response from the API.
• No binary data output is expected for this operation.

Dependencies

• Requires valid Dataiku DSS API credentials, including:
  • The DSS server URL.
  • A user API key for authentication.
• The node must be configured with these credentials in n8n before use.
• The Dataiku DSS instance must have the saved model and version available and accessible by the API key.

Troubleshooting

• Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials," ensure that the API credentials are properly set up in n8n.
• Required Parameter Errors: The node validates required parameters such as Project Key, Save Model ID, and Version ID. Missing any of these will cause errors like "Project Key is required" or "Save Model ID is required." Provide all mandatory inputs.
• API Request Failures: Network issues, incorrect server URLs, or insufficient permissions may cause API call failures. Check connectivity and API key permissions.
• Unexpected Response Format: If the API returns non-JSON or unexpected responses, the node attempts to parse JSON and may fail. Review the API response and ensure the Dataiku DSS version supports this operation.

Links and References

• Dataiku DSS API Documentation (general reference for API endpoints)
• Dataiku DSS Machine Learning Saved Models (conceptual overview)
• Model Documentation Generation (details on documentation templates and generation)

Note: This summary is based on static analysis of the node's source code and property definitions related to the specified Resource and Operation. It does not execute the node or resolve runtime dynamic behavior.