Vector Search

View as Markdown

Create and query Vector Search indexes

List EndpointsGET /api/2.0/vector-search/endpoints

List Endpoints GA

GET /api/2.0/vector-search/endpoints

List all AI Search endpoints in the workspace.

API scopes: vector-search

Parameters

page_tokenstringquery

Token for pagination

Response

endpointsarray of object

An array of Endpoint objects

Show child attributesHide child attributes

namestring

Name of the AI Search endpoint

Example: docs-endpoint

creatorstring

Creator of the endpoint

Example: john@example.com

creation_timestampint64

Timestamp of endpoint creation

Example: 1702013512061

last_updated_timestampint64

Timestamp of last update to the endpoint

Example: 1702013512061

endpoint_typestring

Type of endpoint

Values: STORAGE_OPTIMIZED, STANDARD

last_updated_userstring

User who last updated the endpoint

Example: john@example.com

idstring

Unique identifier of the endpoint

Example: c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76

endpoint_statusobject

Current status of the endpoint

Show child attributesHide child attributes

statestring

Current state of the endpoint

Values: PROVISIONING, ONLINE, OFFLINE, RED_STATE, YELLOW_STATE, DELETED

Example: PROVISIONING

messagestring

Additional status message

num_indexesint32

Number of indexes on the endpoint

budget_policy_idstringPublic Preview

The user-selected budget policy id for the endpoint.

effective_budget_policy_idstringPublic Preview

The budget policy id applied to the endpoint

Example: 8b0444ff-8b60-48b0-9d31-e391f6126e0f

scaling_infoobject

Scaling information for the endpoint

Show child attributesHide child attributes

statestringBeta

The current state of the scaling change request.

Values: SCALING_CHANGE_UNSPECIFIED, SCALING_CHANGE_APPLIED, SCALING_CHANGE_IN_PROGRESS

Example: SCALING_CHANGE_APPLIED

requested_target_qpsint64

The requested QPS target for the endpoint. Best-effort; the system does not guarantee this QPS will be achieved.

Example: 500

next_page_tokenstring

A token that can be used to get the next page of results. If not present, there are no more results to show.

View as Markdown

Response

{
  "endpoints": [
    {
      "name": "docs-endpoint",
      "creator": "john@example.com",
      "creation_timestamp": 1702013512061,
      "last_updated_timestamp": 1702013512061,
      "endpoint_type": "string",
      "last_updated_user": "john@example.com",
      "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
      "endpoint_status": {},
      "num_indexes": 0,
      "budget_policy_id": "string",
      "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
      "scaling_info": {}
    }
  ],
  "next_page_token": "string"
}