endpoints

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

Overview

Name	endpoints
Type	Resource
Id	databricks_workspace.aisearch.endpoints

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Unique identifier of the endpoint
name	string	Name of the AI Search endpoint. Server-assigned full resource path (``workspaces/{workspace}/endpoints/{endpoint}``) on output. On create, the user-supplied short name is conveyed via ``CreateEndpointRequest.endpoint_id``; the server composes the full ``name`` and returns it on the response.
budget_policy_id	string	The user-selected budget policy id for the endpoint.
effective_budget_policy_id	string	The budget policy id applied to the endpoint
usage_policy_id	string	The usage policy id applied to the endpoint.
create_time	string (date-time)	Time the endpoint was created.
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. Required on create and immutable thereafter. (STANDARD, STORAGE_OPTIMIZED)
index_count	integer	Number of indexes on the endpoint
last_updated_user	string	User who last updated the endpoint
replica_count	integer	The client-supplied desired number of replicas for the endpoint, applied at create/update time. Mutually exclusive with ``target_qps``.
▶scaling_info	object	Scaling information for the endpoint
target_qps	integer	Target QPS for the endpoint. Mutually exclusive with ``replica_count``. Best-effort; the system does not guarantee this QPS will be achieved.
▶throughput_info	object	Throughput information for the endpoint
update_time	string (date-time)	Time the endpoint was last updated.
▶warnings	array	Advisory warnings surfaced when target_qps is set on a Standard endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent, deployment_name	page_size, page_token	List AI Search endpoints in a workspace.
create	insert	parent, deployment_name, endpoint	endpoint_id	Create a new AI Search endpoint.
update	update	name, update_mask, deployment_name, endpoint		Update an existing AI Search endpoint. Multi-bucket masks are supported and dispatched in

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)
name	string	Name of the AI Search endpoint. Server-assigned full resource path (workspaces/{workspace}/endpoints/{endpoint}) on output. On create, the user-supplied short name is conveyed via CreateEndpointRequest.endpoint_id; the server composes the full name and returns it on the response.
parent	string	The Workspace where this Endpoint will be created. Format: workspaces/{workspace_id}
update_mask	object	The list of fields to update.
endpoint_id	string	The user-supplied short name for the Endpoint, per AIP-133. The server composes the full Endpoint.name as {parent}/endpoints/{endpoint_id}. AIP-133 does not list endpoint_id as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE.
page_size	integer	Best-effort upper bound on the number of results to return. Honored as an upper bound by the shim: page_size only narrows the legacy backend's response, never widens it, so the practical cap is min(page_size, legacy_fixed_page_size).
page_token	string	Page token from a previous response. If not provided, returns the first page.

SELECT examples

list

List AI Search endpoints in a workspace.

SELECT
id,
name,
budget_policy_id,
effective_budget_policy_id,
usage_policy_id,
create_time,
creator,
custom_tags,
endpoint_status,
endpoint_type,
index_count,
last_updated_user,
replica_count,
scaling_info,
target_qps,
throughput_info,
update_time,
warnings
FROM databricks_workspace.aisearch.endpoints
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a new AI Search endpoint.

INSERT INTO databricks_workspace.aisearch.endpoints (
endpoint,
parent,
deployment_name,
endpoint_id
)
SELECT 
'{{ endpoint }}' /* required */,
'{{ parent }}',
'{{ deployment_name }}',
'{{ endpoint_id }}'
RETURNING
id,
name,
budget_policy_id,
effective_budget_policy_id,
usage_policy_id,
create_time,
creator,
custom_tags,
endpoint_status,
endpoint_type,
index_count,
last_updated_user,
replica_count,
scaling_info,
target_qps,
throughput_info,
update_time,
warnings
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the endpoints resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the endpoints resource.
  - name: endpoint
    description: |
      The Endpoint resource to create. Fields other than ``endpoint.name`` carry the desired configuration; ``endpoint.name`` is server-assigned from ``parent`` and ``endpoint_id``.
    value:
      endpoint_type: "{{ endpoint_type }}"
      budget_policy_id: "{{ budget_policy_id }}"
      create_time: "{{ create_time }}"
      creator: "{{ creator }}"
      custom_tags:
        - key: "{{ key }}"
          value: "{{ value }}"
      effective_budget_policy_id: "{{ effective_budget_policy_id }}"
      endpoint_status:
        message: "{{ message }}"
        state: "{{ state }}"
      id: "{{ id }}"
      index_count: {{ index_count }}
      last_updated_user: "{{ last_updated_user }}"
      name: "{{ name }}"
      replica_count: {{ replica_count }}
      scaling_info:
        requested_target_qps: {{ requested_target_qps }}
        state: "{{ state }}"
      target_qps: {{ target_qps }}
      throughput_info:
        change_request_message: "{{ change_request_message }}"
        change_request_state: "{{ change_request_state }}"
        current_concurrency: {{ current_concurrency }}
        current_concurrency_utilization_percentage: {{ current_concurrency_utilization_percentage }}
        current_num_replicas: {{ current_num_replicas }}
        maximum_concurrency_allowed: {{ maximum_concurrency_allowed }}
        minimal_concurrency_allowed: {{ minimal_concurrency_allowed }}
        requested_concurrency: {{ requested_concurrency }}
        requested_num_replicas: {{ requested_num_replicas }}
      update_time: "{{ update_time }}"
      usage_policy_id: "{{ usage_policy_id }}"
      warnings:
        - index_names: "{{ index_names }}"
          message: "{{ message }}"
          status_code: "{{ status_code }}"
  - name: endpoint_id
    value: "{{ endpoint_id }}"
    description: The user-supplied short name for the Endpoint, per AIP-133. The server composes the full ``Endpoint.name`` as ``{parent}/endpoints/{endpoint_id}``. AIP-133 does not list ``endpoint_id`` as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE.
    description: The user-supplied short name for the Endpoint, per AIP-133. The server composes the full ``Endpoint.name`` as ``{parent}/endpoints/{endpoint_id}``. AIP-133 does not list ``endpoint_id`` as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE.

UPDATE examples

update

Update an existing AI Search endpoint. Multi-bucket masks are supported and dispatched in

UPDATE databricks_workspace.aisearch.endpoints
SET 
endpoint = '{{ endpoint }}'
WHERE 
name = '{{ name }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
id,
name,
budget_policy_id,
effective_budget_policy_id,
usage_policy_id,
create_time,
creator,
custom_tags,
endpoint_status,
endpoint_type,
index_count,
last_updated_user,
replica_count,
scaling_info,
target_qps,
throughput_info,
update_time,
warnings;