indexers.VectorStore.reverse_search

indexers.VectorStore.reverse_search(
    query,
    max_n_results=100,
    partial_match=False,
)

Reverse searches the vector store using a VectorStoreReverseSearchInput object and returns matched results in VectorStoreReverseSearchOutput object. If using partial matching, matches if document label starts with query label.

Parameters

Name	Type	Description	Default
query	VectorStoreReverseSearchInput	A VectorStoreReverseSearchInput object containing the text query or list of queries to search for with ids.	required
max_n_results	int	[optional] Number of top results to return for each query, set to -1 to return all results. Default 100.	100
partial_match	bool	[optional] Set the search behaviour to use join_where to match query checks that document id startsWith query. Default False	False

Returns

Name	Type	Description
result_df	VectorStoreReverseSearchOutput	A VectorStoreReverseSearchOutput object containing reverse search results with columns for query ID, query text, document ID, document text and any associated metadata columns.

Raises

Name	Type	Description
	DataValidationError	Raised if invalid arguments are passed.
	HookError	Raised if user-defined hooks fail.
	ClassifaiError	Raised if reverse search operation fails.