Class VectorSearchClient

Constructors

constructor

new VectorSearchClient(options: ClientOptions): VectorSearchClient
Parameters
- options: ClientOptions
Returns VectorSearchClient
- Defined in client.ts:105

Methods

createEndpoint

createEndpoint(
req: CreateEndpointRequest,
options?: CallOptions,
): Promise<CreateEndpointWaiter>
Create a new endpoint.
Parameters
- req: CreateEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<CreateEndpointWaiter>
- Defined in client.ts:151

createVectorIndex

createVectorIndex(
req: CreateVectorIndexRequest,
options?: CallOptions,
): Promise<VectorIndex>
Create a new index.
Parameters
- req: CreateVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<VectorIndex>
- Defined in client.ts:163

deleteDataVectorIndex

deleteDataVectorIndex(
req: DeleteDataVectorIndexRequest,
options?: CallOptions,
): Promise<DeleteDataVectorIndexResponse>
Handles the deletion of data from a specified vector index.
Parameters
- req: DeleteDataVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteDataVectorIndexResponse>
- Defined in client.ts:193

deleteEndpoint

deleteEndpoint(
req: DeleteEndpointRequest,
options?: CallOptions,
): Promise<DeleteEndpointResponse>
Delete an AI Search endpoint.
Parameters
- req: DeleteEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteEndpointResponse>
- Defined in client.ts:231

deleteVectorIndex

deleteVectorIndex(
req: DeleteVectorIndexRequest,
options?: CallOptions,
): Promise<DeleteVectorIndexResponse>
Delete an index.
Parameters
- req: DeleteVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteVectorIndexResponse>
- Defined in client.ts:260

getEndpoint

getEndpoint(req: GetEndpointRequest, options?: CallOptions): Promise<Endpoint>
Get details for a single AI Search endpoint.
Parameters
- req: GetEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<Endpoint>
- Defined in client.ts:289

getVectorIndex

getVectorIndex(
req: GetVectorIndexRequest,
options?: CallOptions,
): Promise<VectorIndex>
Get an index.
Parameters
- req: GetVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<VectorIndex>
- Defined in client.ts:318

listEndpoints

listEndpoints(
req: ListEndpointsRequest,
options?: CallOptions,
): Promise<ListEndpointResponse>
List all AI Search endpoints in the workspace.
Parameters
- req: ListEndpointsRequest
- Optionaloptions: CallOptions
Returns Promise<ListEndpointResponse>
- Defined in client.ts:356

listEndpointsIter

listEndpointsIter(
req: ListEndpointsRequest,
options?: CallOptions,
): AsyncGenerator<Endpoint>
Parameters
- req: ListEndpointsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Endpoint>
- Defined in client.ts:390

listVectorIndex

listVectorIndex(
req: ListVectorIndexRequest,
options?: CallOptions,
): Promise<ListVectorIndexResponse>
List all indexes in the given endpoint.
Parameters
- req: ListVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<ListVectorIndexResponse>
- Defined in client.ts:408

listVectorIndexIter

listVectorIndexIter(
req: ListVectorIndexRequest,
options?: CallOptions,
): AsyncGenerator<MiniVectorIndex>
Parameters
- req: ListVectorIndexRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<MiniVectorIndex>
- Defined in client.ts:445

patchEndpoint

patchEndpoint(
req: PatchEndpointRequest,
options?: CallOptions,
): Promise<Endpoint>
Update an endpoint
Parameters
- req: PatchEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<Endpoint>
- Defined in client.ts:463

patchEndpointBudgetPolicy

patchEndpointBudgetPolicy(
req: PatchEndpointBudgetPolicyRequest,
options?: CallOptions,
): Promise<PatchEndpointBudgetPolicyResponse>
Update the budget policy of an endpoint
Parameters
- req: PatchEndpointBudgetPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<PatchEndpointBudgetPolicyResponse>
- Defined in client.ts:493

queryVectorIndex

queryVectorIndex(
req: QueryVectorIndexRequest,
options?: CallOptions,
): Promise<QueryVectorIndexResponse>
Query the specified vector index.
Parameters
- req: QueryVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<QueryVectorIndexResponse>
- Defined in client.ts:529

queryVectorIndexNextPage

queryVectorIndexNextPage(
req: QueryVectorIndexNextPageRequest,
options?: CallOptions,
): Promise<QueryVectorIndexResponse>
Use next_page_token returned from previous QueryVectorIndex or QueryVectorIndexNextPage request to fetch next page of results.
Parameters
- req: QueryVectorIndexNextPageRequest
- Optionaloptions: CallOptions
Returns Promise<QueryVectorIndexResponse>
- Defined in client.ts:559

retrieveUserVisibleMetrics

retrieveUserVisibleMetrics(
req: RetrieveUserVisibleMetricsRequest,
options?: CallOptions,
): Promise<RetrieveUserVisibleMetricsResponse>
Retrieve user-visible metrics for an endpoint
Parameters
- req: RetrieveUserVisibleMetricsRequest
- Optionaloptions: CallOptions
Returns Promise<RetrieveUserVisibleMetricsResponse>
- Defined in client.ts:592

scanVectorIndex

scanVectorIndex(
req: ScanVectorIndexRequest,
options?: CallOptions,
): Promise<ScanVectorIndexResponse>
Scan the specified vector index and return the first num_results entries after the exclusive primary_key.
Parameters
- req: ScanVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<ScanVectorIndexResponse>
- Defined in client.ts:628

syncVectorIndex

syncVectorIndex(
req: SyncVectorIndexRequest,
options?: CallOptions,
): Promise<SyncVectorIndexResponse>
Triggers a synchronization process for a specified vector index.
Parameters
- req: SyncVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<SyncVectorIndexResponse>
- Defined in client.ts:658

updateEndpointCustomTags

updateEndpointCustomTags(
req: UpdateEndpointCustomTagsRequest,
options?: CallOptions,
): Promise<UpdateEndpointCustomTagsResponse>
Update the custom tags of an endpoint.
Parameters
- req: UpdateEndpointCustomTagsRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateEndpointCustomTagsResponse>
- Defined in client.ts:688

upsertDataVectorIndex

upsertDataVectorIndex(
req: UpsertDataVectorIndexRequest,
options?: CallOptions,
): Promise<UpsertDataVectorIndexResponse>
Handles the upserting of data into a specified vector index.
Parameters
- req: UpsertDataVectorIndexRequest
- Optionaloptions: CallOptions
Returns Promise<UpsertDataVectorIndexResponse>
- Defined in client.ts:724