com.databricks.sdk.service.vectorsearch

Class VectorSearchIndexesAPI

java.lang.Object

com.databricks.sdk.service.vectorsearch.VectorSearchIndexesAPI

@Generated
public class VectorSearchIndexesAPI
extends Object

**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.

Constructor Summary

Constructors

Constructor and Description
VectorSearchIndexesAPI(ApiClient apiClient) Regular-use constructor
VectorSearchIndexesAPI(VectorSearchIndexesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
VectorIndex	createIndex(CreateVectorIndexRequest request) Create a new index.
VectorIndex	createIndex(String name, String endpointName, String primaryKey, VectorIndexType indexType)
DeleteDataVectorIndexResponse	deleteDataVectorIndex(DeleteDataVectorIndexRequest request) Handles the deletion of data from a specified vector index.
DeleteDataVectorIndexResponse	deleteDataVectorIndex(String indexName, Collection<String> primaryKeys)
void	deleteIndex(DeleteIndexRequest request) Delete an index.
void	deleteIndex(String indexName)
VectorIndex	getIndex(GetIndexRequest request) Get an index.
VectorIndex	getIndex(String indexName)
VectorSearchIndexesService	impl()
Iterable<MiniVectorIndex>	listIndexes(ListIndexesRequest request) List all indexes in the given endpoint.
Iterable<MiniVectorIndex>	listIndexes(String endpointName)
QueryVectorIndexResponse	queryIndex(QueryVectorIndexRequest request) Query the specified vector index.
QueryVectorIndexResponse	queryIndex(String indexName, Collection<String> columns)
QueryVectorIndexResponse	queryNextPage(QueryVectorIndexNextPageRequest request) Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request to fetch next page of results.
QueryVectorIndexResponse	queryNextPage(String indexName)
ScanVectorIndexResponse	scanIndex(ScanVectorIndexRequest request) Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.
ScanVectorIndexResponse	scanIndex(String indexName)
void	syncIndex(String indexName)
void	syncIndex(SyncIndexRequest request) Triggers a synchronization process for a specified vector index.
UpsertDataVectorIndexResponse	upsertDataVectorIndex(String indexName, String inputsJson)
UpsertDataVectorIndexResponse	upsertDataVectorIndex(UpsertDataVectorIndexRequest request) Handles the upserting of data into a specified vector index.

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorSearchIndexesAPI

public VectorSearchIndexesAPI(ApiClient apiClient)

Regular-use constructor

VectorSearchIndexesAPI

public VectorSearchIndexesAPI(VectorSearchIndexesService mock)

Constructor for mocks

Method Detail

createIndex

public VectorIndex createIndex(String name,
                               String endpointName,
                               String primaryKey,
                               VectorIndexType indexType)

createIndex

public VectorIndex createIndex(CreateVectorIndexRequest request)

Create a new index.

deleteDataVectorIndex

public DeleteDataVectorIndexResponse deleteDataVectorIndex(String indexName,
                                                           Collection<String> primaryKeys)

deleteDataVectorIndex

public DeleteDataVectorIndexResponse deleteDataVectorIndex(DeleteDataVectorIndexRequest request)

Handles the deletion of data from a specified vector index.

deleteIndex

public void deleteIndex(String indexName)

deleteIndex

public void deleteIndex(DeleteIndexRequest request)

Delete an index.

getIndex

public VectorIndex getIndex(String indexName)

getIndex

public VectorIndex getIndex(GetIndexRequest request)

Get an index.

listIndexes

public Iterable<MiniVectorIndex> listIndexes(String endpointName)

listIndexes

public Iterable<MiniVectorIndex> listIndexes(ListIndexesRequest request)

List all indexes in the given endpoint.

queryIndex

public QueryVectorIndexResponse queryIndex(String indexName,
                                           Collection<String> columns)

queryIndex

public QueryVectorIndexResponse queryIndex(QueryVectorIndexRequest request)

Query the specified vector index.

queryNextPage

public QueryVectorIndexResponse queryNextPage(String indexName)

queryNextPage

public QueryVectorIndexResponse queryNextPage(QueryVectorIndexNextPageRequest request)

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

scanIndex

public ScanVectorIndexResponse scanIndex(String indexName)

scanIndex

public ScanVectorIndexResponse scanIndex(ScanVectorIndexRequest request)

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

syncIndex

public void syncIndex(String indexName)

syncIndex

public void syncIndex(SyncIndexRequest request)

Triggers a synchronization process for a specified vector index.

upsertDataVectorIndex

public UpsertDataVectorIndexResponse upsertDataVectorIndex(String indexName,
                                                           String inputsJson)

upsertDataVectorIndex

public UpsertDataVectorIndexResponse upsertDataVectorIndex(UpsertDataVectorIndexRequest request)

Handles the upserting of data into a specified vector index.

impl

public VectorSearchIndexesService impl()