com.databricks.sdk.service.vectorsearch

Interface VectorSearchIndexesService

@Generated
public interface VectorSearchIndexesService

**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries.

There are 2 types of Vector Search indexes: - **Delta Sync Index**: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - **Direct Vector Access Index**: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.

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
VectorIndex	createIndex(CreateVectorIndexRequest createVectorIndexRequest) Create a new index.
DeleteDataVectorIndexResponse	deleteDataVectorIndex(DeleteDataVectorIndexRequest deleteDataVectorIndexRequest) Handles the deletion of data from a specified vector index.
void	deleteIndex(DeleteIndexRequest deleteIndexRequest) Delete an index.
VectorIndex	getIndex(GetIndexRequest getIndexRequest) Get an index.
ListVectorIndexesResponse	listIndexes(ListIndexesRequest listIndexesRequest) List all indexes in the given endpoint.
QueryVectorIndexResponse	queryIndex(QueryVectorIndexRequest queryVectorIndexRequest) Query the specified vector index.
QueryVectorIndexResponse	queryNextPage(QueryVectorIndexNextPageRequest queryVectorIndexNextPageRequest) Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request to fetch next page of results.
ScanVectorIndexResponse	scanIndex(ScanVectorIndexRequest scanVectorIndexRequest) Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.
void	syncIndex(SyncIndexRequest syncIndexRequest) Triggers a synchronization process for a specified vector index.
UpsertDataVectorIndexResponse	upsertDataVectorIndex(UpsertDataVectorIndexRequest upsertDataVectorIndexRequest) Handles the upserting of data into a specified vector index.

Method Detail

createIndex

VectorIndex createIndex(CreateVectorIndexRequest createVectorIndexRequest)

Create a new index.

deleteDataVectorIndex

DeleteDataVectorIndexResponse deleteDataVectorIndex(DeleteDataVectorIndexRequest deleteDataVectorIndexRequest)

Handles the deletion of data from a specified vector index.

deleteIndex

void deleteIndex(DeleteIndexRequest deleteIndexRequest)

Delete an index.

getIndex

VectorIndex getIndex(GetIndexRequest getIndexRequest)

Get an index.

listIndexes

ListVectorIndexesResponse listIndexes(ListIndexesRequest listIndexesRequest)

List all indexes in the given endpoint.

queryIndex

QueryVectorIndexResponse queryIndex(QueryVectorIndexRequest queryVectorIndexRequest)

Query the specified vector index.

queryNextPage

QueryVectorIndexResponse queryNextPage(QueryVectorIndexNextPageRequest queryVectorIndexNextPageRequest)

Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request to fetch next page of results.

scanIndex

ScanVectorIndexResponse scanIndex(ScanVectorIndexRequest scanVectorIndexRequest)

Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.

syncIndex

void syncIndex(SyncIndexRequest syncIndexRequest)

Triggers a synchronization process for a specified vector index.

upsertDataVectorIndex

UpsertDataVectorIndexResponse upsertDataVectorIndex(UpsertDataVectorIndexRequest upsertDataVectorIndexRequest)

Handles the upserting of data into a specified vector index.