Searches the vector store 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 VectoreStoreSearchInput 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
result_df
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.