Databricks icon

Databricks

Interact with Databricks API

Overview

The node integrates with the Databricks API, specifically supporting multiple resources including Vector Search. For the Vector Search - Scan Index operation, it allows scanning or retrieving data from a specified vector search index within Databricks. This is useful for applications involving similarity search, recommendation systems, or any scenario where you need to query and explore vector embeddings stored in an index.

Practical examples include:

  • Scanning a vector index to retrieve all vectors or metadata for analysis.
  • Using the scan results as input for further processing or filtering in an n8n workflow.
  • Integrating vector search capabilities into automated pipelines for machine learning or data enrichment.

Properties

Name Meaning
Index Name The name of the vector search index to scan. This identifies which vector index in Databricks to operate on.

Output

The output consists of JSON objects representing the response from the Databricks Vector Search API when scanning an index. The exact structure depends on the API response but typically includes:

  • Data entries or vectors retrieved from the scanned index.
  • Metadata about the scan operation or the index contents.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication token credential for Databricks (an API key or token).
  • Needs the Databricks host URL configured in the credentials.
  • Relies on the Databricks Vector Search API endpoint to perform the scan operation.

Troubleshooting

  • Common issues:

    • Invalid or missing index name will cause the API call to fail.
    • Network connectivity problems can prevent reaching the Databricks API.
    • Insufficient permissions or invalid API token may result in authorization errors.
  • Error messages:

    • API Error: <status> <statusText> indicates the Databricks API returned an error status. Check the index name, permissions, and API token validity.
    • Network Error: No response received from server suggests network issues or incorrect host configuration.
    • Other errors are logged with details; enabling "Continue On Fail" allows workflows to handle errors gracefully.

Links and References


Note: The provided source code shows that the node supports many resources and operations, but only the Vector Search resource with the Scan Index operation was analyzed here per your request.

Discussion