RetrievalQuery#

class scikitplot.corpus.RetrievalQuery(query_id, text, top_k=10, filters=<factory>, embedding=None)[source]#

A query submitted to the corpus retrieval layer.

Parameters:
query_idstr

Unique query identifier.

textstr

Raw query text.

top_kint

Maximum number of results to return.

filtersMetadataDict

Metadata filter predicates (e.g. {"doc_id": "d1"}).

embeddingEmbeddingVector or None

Pre-computed query embedding. When None, the retrieval backend is responsible for encoding the query text.

Parameters:
embedding: list[float] | None = None#
filters: dict[str, Any][source]#
query_id: str[source]#
text: str[source]#
top_k: int = 10#