com.databricks.sdk.service.aisearch

Interface AiSearchService

@Generated
public interface AiSearchService

**AI Search Endpoint**: Represents the compute resources to host AI Search indexes. AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Endpoint	createEndpoint(CreateEndpointRequest createEndpointRequest) Create a new AI Search endpoint.
Index	createIndex(CreateIndexRequest createIndexRequest) Create a new AI Search index.
void	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Delete an AI Search endpoint.
void	deleteIndex(DeleteIndexRequest deleteIndexRequest) Delete an AI Search index.
Endpoint	getEndpoint(GetEndpointRequest getEndpointRequest) Get details for a single AI Search endpoint.
Index	getIndex(GetIndexRequest getIndexRequest) Get details for a single AI Search index.
ListEndpointsResponse	listEndpoints(ListEndpointsRequest listEndpointsRequest) List AI Search endpoints in a workspace.
ListIndexesResponse	listIndexes(ListIndexesRequest listIndexesRequest) List AI Search indexes on an endpoint.
QueryIndexResponse	queryIndex(QueryIndexRequest queryIndexRequest) Query (search) an AI Search index.
RemoveDataResponse	removeData(RemoveDataRequest removeDataRequest) Remove rows by primary key from a Direct Access AI Search index.
ScanIndexResponse	scanIndex(ScanIndexRequest scanIndexRequest) Scan (paginate over) the rows of an AI Search index.
SyncIndexResponse	syncIndex(SyncIndexRequest syncIndexRequest) Synchronize a Delta Sync AI Search index with its source Delta table.
Endpoint	updateEndpoint(UpdateEndpointRequest updateEndpointRequest) Update an existing AI Search endpoint.
UpsertDataResponse	upsertData(UpsertDataRequest upsertDataRequest) Upsert rows into a Direct Access AI Search index.

Method Detail

createEndpoint

Endpoint createEndpoint(CreateEndpointRequest createEndpointRequest)

Create a new AI Search endpoint.

createIndex

Index createIndex(CreateIndexRequest createIndexRequest)

Create a new AI Search index.

deleteEndpoint

void deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

Delete an AI Search endpoint.

deleteIndex

void deleteIndex(DeleteIndexRequest deleteIndexRequest)

Delete an AI Search index.

getEndpoint

Endpoint getEndpoint(GetEndpointRequest getEndpointRequest)

Get details for a single AI Search endpoint.

getIndex

Index getIndex(GetIndexRequest getIndexRequest)

Get details for a single AI Search index.

listEndpoints

ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest)

List AI Search endpoints in a workspace.

listIndexes

ListIndexesResponse listIndexes(ListIndexesRequest listIndexesRequest)

List AI Search indexes on an endpoint.

queryIndex

QueryIndexResponse queryIndex(QueryIndexRequest queryIndexRequest)

Query (search) an AI Search index. Read-only, so a read-scoped token may invoke it.

removeData

RemoveDataResponse removeData(RemoveDataRequest removeDataRequest)

Remove rows by primary key from a Direct Access AI Search index.

scanIndex

ScanIndexResponse scanIndex(ScanIndexRequest scanIndexRequest)

Scan (paginate over) the rows of an AI Search index.

syncIndex

SyncIndexResponse syncIndex(SyncIndexRequest syncIndexRequest)

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.

updateEndpoint

Endpoint updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

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.

upsertData

UpsertDataResponse upsertData(UpsertDataRequest upsertDataRequest)

Upsert rows into a Direct Access AI Search index.