Overview

This node operation retrieves detailed information about a specific vector search index from the Databricks API. It is useful in scenarios where users need to inspect the configuration or metadata of a vector search index used for semantic search with vector embeddings. For example, a user might want to verify the properties of an index before running queries or managing indexes programmatically.

Use Case Examples

1. Retrieve metadata of a vector search index named 'my_index' to check its configuration.
2. Use the index details to audit or document the vector search setup in Databricks.

Properties

Output

JSON

• json - The detailed information and metadata of the requested vector search index as returned by the Databricks API.

Dependencies

• Databricks API authentication token and host URL

Troubleshooting

• Ensure the 'Index Name' is correctly specified and the index exists in Databricks.
• Check that the API credentials (host and token) are valid and have permissions to access vector search indexes.
• API errors will be logged and can be returned in the output if 'Continue On Fail' is enabled.
• Network errors or invalid responses from the Databricks API will cause the node to throw errors unless 'Continue On Fail' is enabled.

Links

• Databricks Vector Search Documentation - Official documentation for Databricks Vector Search feature, including API details and usage.