w.vector_search_endpoints: Endpoints

class databricks.sdk.service.vectorsearch.VectorSearchEndpointsAPI

Endpoint: Represents the compute resources to host AI Search indexes.

create_endpoint(name: str, endpoint_type: EndpointType [, budget_policy_id: Optional[str], target_qps: Optional[int], usage_policy_id: Optional[str]]) → Wait[EndpointInfo]

Create a new endpoint.

Parameters:

  • name – str Name of the AI Search endpoint

  • endpoint_type – EndpointType Type of endpoint

  • budget_policy_id – str (optional) The budget policy id to be applied

  • target_qps – int (optional) 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.

  • usage_policy_id – str (optional) The usage policy id to be applied once we’ve migrated to usage policies

Returns:

Long-running operation waiter for EndpointInfo. See :method:wait_get_endpoint_vector_search_endpoint_online for more details.

create_endpoint_and_wait(name: str, endpoint_type: EndpointType [, budget_policy_id: Optional[str], target_qps: Optional[int], usage_policy_id: Optional[str], timeout: datetime.timedelta = 0:20:00]) → EndpointInfo
delete_endpoint(endpoint_name: str)

Delete an AI Search endpoint.

Parameters:

endpoint_name – str Name of the AI Search endpoint

get_endpoint(endpoint_name: str) → EndpointInfo

Get details for a single AI Search endpoint.

Parameters:

endpoint_name – str Name of the endpoint

Returns:

EndpointInfo

get_permission_levels(endpoint_id: str) → GetVectorSearchEndpointPermissionLevelsResponse

Gets the permission levels that a user can have on an object.

Parameters:

endpoint_id – str The vector search endpoint for which to get or manage permissions.

Returns:

GetVectorSearchEndpointPermissionLevelsResponse

get_permissions(endpoint_id: str) → VectorSearchEndpointPermissions

Gets the permissions of a vector search endpoint. Vector search endpoints can inherit permissions from their root object.

Parameters:

endpoint_id – str The vector search endpoint for which to get or manage permissions.

Returns:

VectorSearchEndpointPermissions

list_endpoints([, page_token: Optional[str]]) → Iterator[EndpointInfo]

List all AI Search endpoints in the workspace.

Parameters:

page_token – str (optional) Token for pagination

Returns:

Iterator over EndpointInfo

patch_endpoint(endpoint_name: str [, target_qps: Optional[int]]) → EndpointInfo

Update an endpoint

Parameters:

  • endpoint_name – str Name of the AI Search endpoint

  • target_qps – int (optional) Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS will be achieved.

Returns:

EndpointInfo

retrieve_user_visible_metrics(name: str [, end_time: Optional[str], granularity_in_seconds: Optional[int], metrics: Optional[List[Metric]], page_token: Optional[str], start_time: Optional[str]]) → RetrieveUserVisibleMetricsResponse

Retrieve user-visible metrics for an endpoint

Parameters:

  • name – str AI Search endpoint name

  • end_time – str (optional) End time for metrics query

  • granularity_in_seconds – int (optional) Granularity in seconds

  • metrics – List[Metric] (optional) List of metrics to retrieve

  • page_token – str (optional) Token for pagination

  • start_time – str (optional) Start time for metrics query

Returns:

RetrieveUserVisibleMetricsResponse

set_permissions(endpoint_id: str [, access_control_list: Optional[List[VectorSearchEndpointAccessControlRequest]]]) → VectorSearchEndpointPermissions

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

Parameters:
Returns:

VectorSearchEndpointPermissions

update_endpoint_budget_policy(endpoint_name: str, budget_policy_id: str) → PatchEndpointBudgetPolicyResponse

Update the budget policy of an endpoint

Parameters:

  • endpoint_name – str Name of the AI Search endpoint

  • budget_policy_id – str The budget policy id to be applied

Returns:

PatchEndpointBudgetPolicyResponse

update_endpoint_custom_tags(endpoint_name: str, custom_tags: List[CustomTag]) → UpdateEndpointCustomTagsResponse

Update the custom tags of an endpoint.

Parameters:

  • endpoint_name – str Name of the AI Search endpoint

  • custom_tags – List[CustomTag] The new custom tags for the AI Search endpoint

Returns:

UpdateEndpointCustomTagsResponse

update_permissions(endpoint_id: str [, access_control_list: Optional[List[VectorSearchEndpointAccessControlRequest]]]) → VectorSearchEndpointPermissions

Updates the permissions on a vector search endpoint. Vector search endpoints can inherit permissions from their root object.

Parameters:
Returns:

VectorSearchEndpointPermissions

wait_get_endpoint_vector_search_endpoint_online(endpoint_name: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[EndpointInfo], None]]) → EndpointInfo