Create a Vector Search Index

Create a Vector Search Index activity in the Databricks connector.

Project compatibility

Windows | Cross-platform

Overview

Description	API Method	API Path
Create a Vector Search index. Requires name, endpoint_name, index_type and primary_key; DELTA_SYNC keeps the index in step with a source Delta table, DIRECT_ACCESS is written through the API.	POST	/vector_search_indexes

Input

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. For example, my-vs-endpoint.	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. For example, id.	string
Delta Sync Index Spec	For DELTA_SYNC: source_table, pipeline_type, embedding_source_columns. For example, {"source_table": "main.default.docs", "pipeline_type": "TRIGGERED", "embedding_source_columns": [{"name": "text", "embedding_model_endpoint_name": "databricks-bge-large-en"}]}.	object
Direct Access Index Spec	For DIRECT_ACCESS: schema_json and embedding config. For example, {"schema_json": "{\"id\": \"string\", \"text\": \"string\"}"}.	object

* 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
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.