w.vector_search_endpoints: Endpoints

class databricks.sdk.service.vectorsearch.VectorSearchEndpointsAPI

Endpoint: Represents the compute resources to host vector search indexes.

create_endpoint(name: str, endpoint_type: EndpointType [, budget_policy_id: Optional[str]]) Wait[EndpointInfo]

Create an endpoint.

Create a new endpoint.

Parameters:
  • name – str Name of the vector search endpoint

  • endpoint_typeEndpointType Type of endpoint

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

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], timeout: datetime.timedelta = 0:20:00]) EndpointInfo
delete_endpoint(endpoint_name: str)

Delete an endpoint.

Delete a vector search endpoint.

Parameters:

endpoint_name – str Name of the vector search endpoint

get_endpoint(endpoint_name: str) EndpointInfo

Get an endpoint.

Get details for a single vector search endpoint.

Parameters:

endpoint_name – str Name of the endpoint

Returns:

EndpointInfo

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

List all endpoints.

List all vector search endpoints in the workspace.

Parameters:

page_token – str (optional) Token for pagination

Returns:

Iterator over EndpointInfo

update_endpoint_budget_policy(endpoint_name: str, budget_policy_id: str) PatchEndpointBudgetPolicyResponse

Update the budget policy of an endpoint.

Update the budget policy of an endpoint

Parameters:
  • endpoint_name – str Name of the vector 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 vector search endpoint

  • custom_tags – List[CustomTag] The new custom tags for the vector search endpoint

Returns:

UpdateEndpointCustomTagsResponse

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