Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Machine Learning - Saved Model resource and the Generate Model Documentation From Custom Template operation, it allows starting the generation of model documentation for a saved model version using a custom template file.

Common scenarios where this node is beneficial include automating interactions with Dataiku DSS projects, managing machine learning models, generating documentation for models programmatically, and integrating these capabilities into larger workflows.

For example, a user can automate the generation of detailed documentation for a specific version of a saved machine learning model by providing the project key, saved model ID, version ID, and uploading a custom template file. This helps maintain up-to-date model documentation without manual intervention.

Properties

Output

The output depends on the operation:

• For Generate Model Documentation From Custom Template, the node initiates the documentation generation process and returns the API response JSON indicating the status or result of the request.
• If the operation involves downloading documentation or other files, the node outputs binary data representing the downloaded file, prepared for further use in n8n workflows.
• In general, the json output field contains the parsed JSON response from the Dataiku DSS API corresponding to the requested operation.
• When binary data is returned (e.g., documentation files, scoring jars), it is provided in the binary output field under the key data.

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Requires valid API credentials: specifically, a Dataiku DSS server URL and a user API key credential.
• The node uses HTTP requests to interact with the Dataiku DSS REST API endpoints.
• The user must configure the node with appropriate credentials that have permissions to access the specified project and saved model.

Troubleshooting

• Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is configured correctly in n8n.
• Required Parameter Missing: Errors like "Project Key is required" or "Save Model ID is required" indicate missing mandatory input parameters. Verify all required fields are filled.
• Invalid Resource or Operation: If an unknown resource or operation error occurs, confirm that the selected resource and operation match those supported by the node.
• File Upload Issues: For operations requiring a file upload (like custom templates), ensure the file is properly attached as binary data in n8n.
• API Request Failures: Network issues, incorrect URLs, or insufficient permissions may cause API call failures. Check the Dataiku DSS server accessibility and user permissions.
• Parsing Errors: If the response cannot be parsed as JSON, the node attempts to return raw text or binary data. Confirm the API response format matches expectations.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Machine Learning Saved Models API
• n8n Documentation on Credentials
• n8n Node Development Guide

This summary focuses on the Machine Learning - Saved Model resource and the Generate Model Documentation From Custom Template operation, based on the provided source code and property definitions.