indexers.dataclasses.VectorStoreSearchOutput

indexers.dataclasses.VectorStoreSearchOutput(data)

DataFrame-like object for storing and validating search results with rankings and similarity scores.

This class represents the output of vector store search operations, containing query information, matched documents, scores, and similarity rankings.

Attributes

Name	Type	Description
query_id	pd.Series	Identifier for the source query.
query_text	pd.Series	The original query text.
doc_id	pd.Series	Identifier for the retrieved document.
doc_text	pd.Series	The text content of the retrieved document.
rank	pd.Series	The ranking position of the result (0-indexed, non-negative).
score	pd.Series	The similarity score or relevance metric.

Methods

Name	Description
from_data	Create a validated VectorStoreSearchOutput from a dictionary or DataFrame.
validate	Validate an existing instance against the schema and return a VectorStoreSearchOutput.

from_data

indexers.dataclasses.VectorStoreSearchOutput.from_data(data)

Create a validated VectorStoreSearchOutput from a dictionary or DataFrame.

validate

indexers.dataclasses.VectorStoreSearchOutput.validate(df)

Validate an existing instance against the schema and return a VectorStoreSearchOutput.