Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku resources. Specifically, for the Machine Learning - Saved Model resource and the Get Version Snippet operation, it retrieves a snippet (a short summary) of a specific version of a saved machine learning model within a project.

This functionality is useful when you want to quickly access metadata or a brief summary about a particular version of a saved ML model in Dataiku DSS without fetching the entire model details. For example, you might use this to display version summaries in dashboards, logs, or to verify version information before deploying or evaluating models.

Properties

Output

The node outputs JSON data representing the snippet (short summary) of the specified saved model version. This typically includes metadata or summary information about that version.

If the operation involves downloading files (not applicable here), the node can output binary data, but for the "Get Version Snippet" operation, the output is JSON.

Example output structure (conceptual):

{
  "versionId": "string",
  "snippet": {
    "summary": "string",
    "createdAt": "timestamp",
    "author": "string",
    ...
  }
}

The exact fields depend on the Dataiku DSS API response for the version snippet.

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 uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
• No additional external services are required beyond the Dataiku DSS server.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing credentials, ensure that the API key credential for Dataiku DSS is configured correctly 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. Double-check that all required inputs are provided.
• API Endpoint Errors: If the Dataiku DSS server URL is incorrect or unreachable, the node will fail to connect. Verify network connectivity and server address.
• Permission Issues: Ensure the API key used has sufficient permissions to access the saved model and its versions.
• Unexpected Response Format: If the API response cannot be parsed as JSON, the node may throw parsing errors. This could indicate an issue with the API or unexpected server responses.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Machine Learning Saved Models API
• n8n Documentation on Creating Custom Nodes

This summary focuses on the "Machine Learning - Saved Model" resource and the "Get Version Snippet" operation as requested.