indexers.VectorStore.reverse_search

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

Reverse searches the VectorStore using a VectorStoreReverseSearchInput 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 doc_labels to look up in the VectorStore and their corresponding ids.	required
max_n_results	int	[optional] Number of top results to return for each query, set to -1 to return all results. Defaults to 100.	100
partial_match	bool	[optional] If True, the search behaviour is set to return results where the doc_label is a prefixed of any vectorstore entries labels. Defaults to False.	False

Returns

Name	Type	Description
	VectorStoreReverseSearchOutput	A VectorStoreReverseSearchOutput object containing reverse search results with columns for id, searched_doc_label, retrieved doc_label, doc_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.