indexers.VectorStore.search

indexers.VectorStore.search(query, n_results=10, batch_size=8)

Searches the VectorStore using queries from a VectorStoreSearchInput object and returns ranked results in VectorStoreSearchOutput object. In batches, converts users text queries into vector embeddings, computes cosine similarity with stored document vectors, and retrieves the top results.

Parameters

Name Type Description Default
query VectorStoreSearchInput A VectorStoreSearchInput object containing the text query or list of queries to search for with ids. required
n_results int [optional] Number of top results to return for each query. Default 10. 10
batch_size int [optional] The batch size for processing queries. Default 8. 8

Returns

Name Type Description
VectorStoreSearchOutput A VectorStoreSearchOutput object containing search results with columns for query_id, query_text, document_id, document_text, rank, score, and any associated metadata columns.

Raises

Name Type Description
DataValidationError Raised if invalid arguments are passed.
ConfigurationError Raised if the vector store is not initialized.
HookError Raised if user-defined hooks fail.
VectorisationError Raised if embedding queries fails.