Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API to perform various operations related to machine learning saved models, specifically including generating model documentation from a file template. It allows users to trigger the generation of model documentation for a saved model version using a predefined template stored in a managed folder within a Dataiku project.

Common scenarios where this node is beneficial include:

• Automating the creation of detailed documentation for machine learning models stored in Dataiku DSS.
• Integrating model documentation generation into an automated workflow or pipeline.
• Using custom templates stored in managed folders to standardize documentation format across projects.

For example, a user can specify a saved model ID and version ID along with the project key and invoke the operation to generate documentation based on a template file located in a managed folder, enabling consistent and repeatable documentation generation.

Properties

Note: The "Query Parameters" property supports multiple optional parameters such as active, archivePath, limit, page, etc., which can be used to further refine the API call if applicable.

Output

The node outputs the response from the Dataiku DSS API call. For the "Generate Model Documentation From File Template" operation, the output typically includes JSON data confirming the initiation of the documentation generation process or details about the generated documentation.

If the operation involves downloading files (not the case here), the node would output binary data representing the downloaded file.

Dependencies

• Requires valid Dataiku DSS API credentials, including the DSS server URL and a user API key.
• The node uses HTTP requests to interact with the Dataiku DSS REST API.
• The user must have appropriate permissions in the Dataiku project to access saved models and generate documentation.
• Managed folders in Dataiku must contain the template files used for documentation generation.

Troubleshooting

• Missing Credentials: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are configured correctly in n8n.
• Required Parameters Missing: Errors indicating missing "Project Key", "Save Model ID", or "Version ID" mean these inputs were not provided but are mandatory for this operation.
• API Errors: If the API returns errors, verify that the specified project, saved model, and version exist and that the user has sufficient permissions.
• Template File Issues: If documentation generation fails, confirm that the template file exists in the managed folder and is accessible.
• Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL.

Links and References

• Dataiku DSS API Documentation
• Dataiku Managed Folders Documentation
• Dataiku Machine Learning Saved Models
• n8n HTTP Request Node Documentation (for understanding underlying HTTP calls)