vector_search_endpoints

Creates, updates, deletes, gets or lists a vector_search_endpoints resource.

Overview

Name	vector_search_endpoints
Type	Resource
Id	databricks_workspace.vectorsearch.vector_search_endpoints

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
update	update	endpoint_name, deployment_name		Update an endpoint
patch_throughput	exec	endpoint_name, deployment_name		Update the throughput (concurrency) of an endpoint

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
endpoint_name	string	Name of the AI Search endpoint

UPDATE examples

update

Update an endpoint

UPDATE databricks_workspace.vectorsearch.vector_search_endpoints
SET 
replication_factor = {{ replication_factor }},
target_qps = {{ target_qps }}
WHERE 
endpoint_name = '{{ endpoint_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
RETURNING
id,
name,
budget_policy_id,
effective_budget_policy_id,
creation_timestamp,
creator,
custom_tags,
endpoint_status,
endpoint_type,
last_updated_timestamp,
last_updated_user,
num_indexes,
scaling_info,
throughput_info;

Lifecycle Methods

patch_throughput

Update the throughput (concurrency) of an endpoint

EXEC databricks_workspace.vectorsearch.vector_search_endpoints.patch_throughput 
@endpoint_name='{{ endpoint_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"all_or_nothing": {{ all_or_nothing }}, 
"concurrency": {{ concurrency }}, 
"maximum_concurrency_allowed": {{ maximum_concurrency_allowed }}, 
"minimal_concurrency_allowed": {{ minimal_concurrency_allowed }}, 
"num_replicas": {{ num_replicas }}
}'
;