Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

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 Set Version User Meta operation, it allows updating the user metadata associated with a specific version of a saved machine learning model within a project.

Common scenarios where this node is beneficial include:

  • Managing metadata for different versions of machine learning models stored in Dataiku DSS.
  • Automating updates to model version information as part of a CI/CD pipeline or model governance workflow.
  • Enhancing model documentation or tracking by programmatically setting custom user metadata.

Practical example:

  • You have multiple versions of a saved ML model in a project and want to tag a particular version with additional descriptive metadata (e.g., notes about training data, performance metrics, or deployment status). This node can update that metadata via the API.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the saved model.
Save Model ID The identifier of the saved model whose version metadata you want to update.
Version ID The identifier of the specific version of the saved model to update.
Request Body A JSON object containing the user metadata fields and values to set for the specified version.

Output

The node outputs the response from the Dataiku DSS API after attempting to update the user metadata of the specified saved model version. The output is a JSON object representing the updated metadata or confirmation of the update.

If the operation involves downloading files or binary content (not applicable specifically for this operation), the node would output binary data accordingly. For this operation, the output is purely JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials: a server URL and an API key credential for authentication.
  • The node uses HTTP requests to interact with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly configured in n8n.
  • Required Parameter Missing: Errors like "Project Key is required", "Save Model ID is required", or "Version ID is required" indicate that these mandatory inputs were not provided. Verify all required properties are set.
  • API Request Failures: Network issues, incorrect URLs, or insufficient permissions may cause API call failures. Check the API endpoint URL, network connectivity, and user permissions in Dataiku DSS.
  • Invalid JSON in Request Body: Ensure the Request Body property contains valid JSON syntax; otherwise, the request will fail.

Links and References


This summary focuses on the Machine Learning - Saved Model resource and the Set Version User Meta operation as requested, based on static analysis of the provided source code and input properties.

Discussion