com.databricks.sdk.service.aisearch

Class AiSearchAPI

java.lang.Object

com.databricks.sdk.service.aisearch.AiSearchAPI

@Generated
public class AiSearchAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
AiSearchAPI(AiSearchService mock) Constructor for mocks
AiSearchAPI(ApiClient apiClient) Regular-use constructor

Method Summary

Modifier and Type	Method and Description
Endpoint	createEndpoint(CreateEndpointRequest request) Create a new AI Search endpoint.
Index	createIndex(CreateIndexRequest request) Create a new AI Search index.
void	deleteEndpoint(DeleteEndpointRequest request) Delete an AI Search endpoint.
void	deleteEndpoint(String name)
void	deleteIndex(DeleteIndexRequest request) Delete an AI Search index.
void	deleteIndex(String name)
Endpoint	getEndpoint(GetEndpointRequest request) Get details for a single AI Search endpoint.
Endpoint	getEndpoint(String name)
Index	getIndex(GetIndexRequest request) Get details for a single AI Search index.
Index	getIndex(String name)
AiSearchService	impl()
Iterable<Endpoint>	listEndpoints(ListEndpointsRequest request) List AI Search endpoints in a workspace.
Iterable<Endpoint>	listEndpoints(String parent)
Iterable<Index>	listIndexes(ListIndexesRequest request) List AI Search indexes on an endpoint.
Iterable<Index>	listIndexes(String parent)
QueryIndexResponse	queryIndex(QueryIndexRequest request) Query (search) an AI Search index.
RemoveDataResponse	removeData(RemoveDataRequest request) Remove rows by primary key from a Direct Access AI Search index.
ScanIndexResponse	scanIndex(ScanIndexRequest request) Scan (paginate over) the rows of an AI Search index.
SyncIndexResponse	syncIndex(SyncIndexRequest request) Synchronize a Delta Sync AI Search index with its source Delta table.
Endpoint	updateEndpoint(UpdateEndpointRequest request) Update an existing AI Search endpoint.
UpsertDataResponse	upsertData(UpsertDataRequest request) Upsert rows into a Direct Access AI Search index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AiSearchAPI

public AiSearchAPI(ApiClient apiClient)

Regular-use constructor

AiSearchAPI

public AiSearchAPI(AiSearchService mock)

Constructor for mocks

Method Detail

createEndpoint

public Endpoint createEndpoint(CreateEndpointRequest request)

Create a new AI Search endpoint.

createIndex

public Index createIndex(CreateIndexRequest request)

Create a new AI Search index.

deleteEndpoint

public void deleteEndpoint(String name)

deleteEndpoint

public void deleteEndpoint(DeleteEndpointRequest request)

Delete an AI Search endpoint.

deleteIndex

public void deleteIndex(String name)

deleteIndex

public void deleteIndex(DeleteIndexRequest request)

Delete an AI Search index.

getEndpoint

public Endpoint getEndpoint(String name)

getEndpoint

public Endpoint getEndpoint(GetEndpointRequest request)

Get details for a single AI Search endpoint.

getIndex

public Index getIndex(String name)

getIndex

public Index getIndex(GetIndexRequest request)

Get details for a single AI Search index.

listEndpoints

public Iterable<Endpoint> listEndpoints(String parent)

listEndpoints

public Iterable<Endpoint> listEndpoints(ListEndpointsRequest request)

List AI Search endpoints in a workspace.

listIndexes

public Iterable<Index> listIndexes(String parent)

listIndexes

public Iterable<Index> listIndexes(ListIndexesRequest request)

List AI Search indexes on an endpoint.

queryIndex

public QueryIndexResponse queryIndex(QueryIndexRequest request)

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

removeData

public RemoveDataResponse removeData(RemoveDataRequest request)

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

scanIndex

public ScanIndexResponse scanIndex(ScanIndexRequest request)

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

syncIndex

public SyncIndexResponse syncIndex(SyncIndexRequest request)

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

public Endpoint updateEndpoint(UpdateEndpointRequest request)

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

public UpsertDataResponse upsertData(UpsertDataRequest request)

Upsert rows into a Direct Access AI Search index.

impl

public AiSearchService impl()