Get a Vector Search Index

Get a Vector Search Index activity in the Databricks connector.

Project compatibility

Windows | Cross-platform

Overview

Description	API Method	API Path
Retrieve one Vector Search index by its three-level name, including index_type, primary_key and sync status.	GET	/vector_search_indexes/{name}

Input

Parameter	Description	Data Type
Databricks Vector Search Index Name *	Three-level Databricks Vector Search index name in catalog.schema.index form, for example main.default.docs_index.	string

* Required parameter.

Output

Parameter	Description	Data Type
Index Name	Three-level index name, for example main.default.my_index.	string
Endpoint Name	Vector search endpoint that hosts the index.	string
Index Type	DELTA_SYNC keeps in sync with a Delta table; DIRECT_ACCESS is written via the API. Allowed values: DELTA_SYNC, DIRECT_ACCESS.	string
Primary Key	Column that uniquely identifies each row.	string
Delta Sync Index Spec	For DELTA_SYNC: source_table, pipeline_type, embedding_source_columns.	object
Direct Access Index Spec	For DIRECT_ACCESS: schema_json and embedding config.	object
Vector Indexes	Indexes returned by the list call.	array
Status	Current status of the Vector Search index, including whether it is ready to query.	object
Creator	Principal that created the Vector Search index.	string

Note:

You might see variations in the output depending on where you run the activity. In API workflows and Maestro Flow, a single response object containing all the fields is returned. In RPA workflows, not all fields are exposed, but you can still retrieve them from the exposed response object.