Struct RetrievalQuery 

#[non_exhaustive]
pub struct RetrievalQuery {
    pub text: String,
    pub top_k: usize,
    pub min_score: Option<f32>,
    pub filter: Option<VectorFilter>,
}

Declarative description of one retrieval call.

Carries the text query plus optional knobs: a metadata filter, a minimum score floor, and a top-k cap. Future hybrid-search dimensions (per-field boosts, dense+keyword fusion, reranker hints) ride on #[non_exhaustive] without breaking call sites.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

Free-text query. Backends interpret it however they like — dense vector embed-and-search, BM25 token match, hybrid fusion.

top_k: usize

Maximum number of hits to return. Backends truncate at this cap; exceeding it is a backend bug.

min_score: Option<f32>

Minimum similarity score required to include a hit. None surfaces every hit regardless of score; useful when score semantics differ across backends. Comparable only within a single query’s result set.

filter: Option<VectorFilter>

Metadata predicate. None is identity (no filter). Backends that cannot honour the supplied VectorFilter variant fall back to filterless retrieval and emit a LossyEncode-style warning at the operator layer.

Implementations

impl RetrievalQuery

pub fn new(text: impl Into<String>, top_k: usize) -> Self

Build a query with sensible defaults — no filter, no floor, top-k cap supplied.

pub fn with_filter(self, filter: VectorFilter) -> Self

Attach a metadata filter. Builder-style.

pub const fn with_min_score(self, min_score: f32) -> Self

Attach a minimum-score floor. Builder-style.

Trait Implementations

impl Clone for RetrievalQuery

fn clone(&self) -> RetrievalQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetrievalQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.