Class AiSearchClient

Index

Constructors

Methods

createEndpoint createIndex deleteEndpoint deleteIndex getEndpoint getIndex listEndpoints listEndpointsIter listIndexes listIndexesIter queryIndex removeData scanIndex syncIndex updateEndpoint upsertData

Constructors

constructor

new AiSearchClient(options: ClientOptions): AiSearchClient
Parameters
- options: ClientOptions
Returns AiSearchClient
- Defined in client.ts:81

Methods

createEndpoint

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

createIndex

createIndex(req: CreateIndexRequest, options?: CallOptions): Promise<Index>
Create a new AI Search index.
Parameters
- req: CreateIndexRequest
- Optionaloptions: CallOptions
Returns Promise<Index>
- Defined in client.ts:97

deleteEndpoint

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

deleteIndex

deleteIndex(req: DeleteIndexRequest, options?: CallOptions): Promise<void>
Delete an AI Search index.
Parameters
- req: DeleteIndexRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:139

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:461

getIndex

getIndex(req: GetIndexRequest, options?: CallOptions): Promise<Index>
Get details for a single AI Search index.
Parameters
- req: GetIndexRequest
- Optionaloptions: CallOptions
Returns Promise<Index>
- Defined in client.ts:162

listEndpoints

listEndpoints(
req: ListEndpointsRequest,
options?: CallOptions,
): Promise<ListEndpointsResponse>
List AI Search endpoints in a workspace.
Parameters
- req: ListEndpointsRequest
- Optionaloptions: CallOptions
Returns Promise<ListEndpointsResponse>
- Defined in client.ts:490

listEndpointsIter

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

listIndexes

listIndexes(
req: ListIndexesRequest,
options?: CallOptions,
): Promise<ListIndexesResponse>
List AI Search indexes on an endpoint.
Parameters
- req: ListIndexesRequest
- Optionaloptions: CallOptions
Returns Promise<ListIndexesResponse>
- Defined in client.ts:188

listIndexesIter

listIndexesIter(
req: ListIndexesRequest,
options?: CallOptions,
): AsyncGenerator<Index>
Parameters
- req: ListIndexesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Index>
- Defined in client.ts:225

queryIndex

queryIndex(
req: QueryIndexRequest,
options?: CallOptions,
): Promise<QueryIndexResponse>
Query (search) an AI Search index. Read-only, so a read-scoped token may invoke it.
Parameters
- req: QueryIndexRequest
- Optionaloptions: CallOptions
Returns Promise<QueryIndexResponse>
- Defined in client.ts:243

removeData

removeData(
req: RemoveDataRequest,
options?: CallOptions,
): Promise<RemoveDataResponse>
Remove rows by primary key from a Direct Access AI Search index.
Parameters
- req: RemoveDataRequest
- Optionaloptions: CallOptions
Returns Promise<RemoveDataResponse>
- Defined in client.ts:273

scanIndex

scanIndex(
req: ScanIndexRequest,
options?: CallOptions,
): Promise<ScanIndexResponse>
Scan (paginate over) the rows of an AI Search index.
Parameters
- req: ScanIndexRequest
- Optionaloptions: CallOptions
Returns Promise<ScanIndexResponse>
- Defined in client.ts:303

syncIndex

syncIndex(
req: SyncIndexRequest,
options?: CallOptions,
): Promise<SyncIndexResponse>
Synchronize a Delta Sync AI Search index with its source Delta table. Applies only to Delta Sync indexes; Direct Access indexes are written via the data-plane upsert path.
Parameters
- req: SyncIndexRequest
- Optionaloptions: CallOptions
Returns Promise<SyncIndexResponse>
- Defined in client.ts:336

updateEndpoint

updateEndpoint(
req: UpdateEndpointRequest,
options?: CallOptions,
): Promise<Endpoint>
Update an existing AI Search endpoint. Multi-bucket masks are supported and dispatched in deterministic bucket order: budget policy, custom tags, throughput, then scaling/replicas. Per-bucket dispatch is not atomic across buckets — if a later bucket fails, earlier buckets may already have been applied.
Parameters
- req: UpdateEndpointRequest
- Optionaloptions: CallOptions
Returns Promise<Endpoint>
- Defined in client.ts:550

upsertData

upsertData(
req: UpsertDataRequest,
options?: CallOptions,
): Promise<UpsertDataResponse>
Upsert rows into a Direct Access AI Search index.
Parameters
- req: UpsertDataRequest
- Optionaloptions: CallOptions
Returns Promise<UpsertDataResponse>
- Defined in client.ts:366

Class AiSearchClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AiSearchClient

Methods

createEndpoint

Parameters

Returns Promise<Endpoint>

createIndex

Parameters

Returns Promise<Index>

deleteEndpoint

Parameters

Returns Promise<void>

deleteIndex

Parameters

Returns Promise<void>

getEndpoint

Parameters

Returns Promise<Endpoint>

getIndex

Parameters

Returns Promise<Index>

listEndpoints

Parameters

Returns Promise<ListEndpointsResponse>

listEndpointsIter

Parameters

Returns AsyncGenerator<Endpoint>

listIndexes

Parameters

Returns Promise<ListIndexesResponse>

listIndexesIter

Parameters

Returns AsyncGenerator<Index>

queryIndex

Parameters

Returns Promise<QueryIndexResponse>

removeData

Parameters

Returns Promise<RemoveDataResponse>

scanIndex

Parameters

Returns Promise<ScanIndexResponse>

syncIndex

Parameters

Returns Promise<SyncIndexResponse>

updateEndpoint

Parameters

Returns Promise<Endpoint>

upsertData

Parameters

Returns Promise<UpsertDataResponse>

Settings

On This Page