endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	databricks_workspace.vectorsearch.endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Unique identifier of the endpoint
name	string	Name of the AI Search endpoint
budget_policy_id	string
effective_budget_policy_id	string	The budget policy id applied to the endpoint
creation_timestamp	integer	Timestamp of endpoint creation
creator	string	Creator of the endpoint
▶custom_tags	array	The custom tags assigned to the endpoint
▶endpoint_status	object	Current status of the endpoint
endpoint_type	string	Type of endpoint (STANDARD, STORAGE_OPTIMIZED)
last_updated_timestamp	integer	Timestamp of last update to the endpoint
last_updated_user	string	User who last updated the endpoint
num_indexes	integer	Number of indexes on the endpoint
▶scaling_info	object	Scaling information for the endpoint

list

Name	Datatype	Description
id	string	Unique identifier of the endpoint
name	string	Name of the AI Search endpoint
budget_policy_id	string
effective_budget_policy_id	string	The budget policy id applied to the endpoint
creation_timestamp	integer	Timestamp of endpoint creation
creator	string	Creator of the endpoint
▶custom_tags	array	The custom tags assigned to the endpoint
▶endpoint_status	object	Current status of the endpoint
endpoint_type	string	Type of endpoint (STANDARD, STORAGE_OPTIMIZED)
last_updated_timestamp	integer	Timestamp of last update to the endpoint
last_updated_user	string	User who last updated the endpoint
num_indexes	integer	Number of indexes on the endpoint
▶scaling_info	object	Scaling information for the endpoint

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	endpoint_name, deployment_name, workspace_domain		Get details for a single AI Search endpoint.
list	select	deployment_name, workspace_domain	page_token	List all AI Search endpoints in the workspace.
create	insert	deployment_name, workspace_domain, name, endpoint_type		Create a new endpoint.
delete	delete	endpoint_name, deployment_name, workspace_domain		Delete an AI Search endpoint.
retrieve_user_visible_metrics	exec	name, deployment_name, workspace_domain		Retrieve user-visible metrics for an endpoint
start	exec	endpoint_name, deployment_name, workspace_domain		Start a stopped endpoint. The endpoint serves the same indexes it had when it stopped.
stop	exec	endpoint_name, deployment_name, workspace_domain		Stop an endpoint. Stopping removes the endpoint's serving compute and retains its indexes. A stopped
update_endpoint_budget_policy	exec	endpoint_name, deployment_name, workspace_domain, budget_policy_id		Update the budget policy of an endpoint
update_endpoint_custom_tags	exec	endpoint_name, deployment_name, workspace_domain, custom_tags		Update the custom tags 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: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
endpoint_name	string	Name of the AI Search endpoint
name	string	AI Search endpoint name
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})
page_token	string	Token for pagination

SELECT examples

get

Get details for a single AI Search endpoint.

SELECT
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
FROM databricks_workspace.vectorsearch.endpoints
WHERE endpoint_name = '{{ endpoint_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

List all AI Search endpoints in the workspace.

SELECT
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
FROM databricks_workspace.vectorsearch.endpoints
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a new endpoint.

INSERT INTO databricks_workspace.vectorsearch.endpoints (
name,
endpoint_type,
budget_policy_id,
target_qps,
usage_policy_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ name }}' /* required */,
'{{ endpoint_type }}' /* required */,
'{{ budget_policy_id }}',
{{ target_qps }},
'{{ usage_policy_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
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
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the endpoints resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the endpoints resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the AI Search endpoint
  - name: endpoint_type
    value: "{{ endpoint_type }}"
    description: |
      Type of endpoint
  - name: budget_policy_id
    value: "{{ budget_policy_id }}"
    description: |
      The budget policy id to be applied
  - name: target_qps
    value: {{ target_qps }}
    description: |
      Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is calculated at index creation/sync time based on this value. Best-effort target; the system does not guarantee this QPS will be achieved.
  - name: usage_policy_id
    value: "{{ usage_policy_id }}"
    description: |
      The usage policy id to be applied once we've migrated to usage policies

DELETE examples

delete

Delete an AI Search endpoint.

DELETE FROM databricks_workspace.vectorsearch.endpoints
WHERE endpoint_name = '{{ endpoint_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
;

Lifecycle Methods

retrieve_user_visible_metrics

Retrieve user-visible metrics for an endpoint

EXEC databricks_workspace.vectorsearch.endpoints.retrieve_user_visible_metrics 
@name='{{ name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required 
@@json=
'{
"end_time": "{{ end_time }}", 
"granularity_in_seconds": {{ granularity_in_seconds }}, 
"metrics": "{{ metrics }}", 
"page_token": "{{ page_token }}", 
"start_time": "{{ start_time }}"
}'
;

start

Start a stopped endpoint. The endpoint serves the same indexes it had when it stopped.

EXEC databricks_workspace.vectorsearch.endpoints.start 
@endpoint_name='{{ endpoint_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required
;

stop

Stop an endpoint. Stopping removes the endpoint's serving compute and retains its indexes. A stopped

EXEC databricks_workspace.vectorsearch.endpoints.stop 
@endpoint_name='{{ endpoint_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required
;

update_endpoint_budget_policy

Update the budget policy of an endpoint

EXEC databricks_workspace.vectorsearch.endpoints.update_endpoint_budget_policy 
@endpoint_name='{{ endpoint_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required 
@@json=
'{
"budget_policy_id": "{{ budget_policy_id }}"
}'
;

update_endpoint_custom_tags

Update the custom tags of an endpoint.

EXEC databricks_workspace.vectorsearch.endpoints.update_endpoint_custom_tags 
@endpoint_name='{{ endpoint_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required 
@@json=
'{
"custom_tags": "{{ custom_tags }}"
}'
;