Struct Query 

#[non_exhaustive]
pub struct Query { /* private fields */ }

A search query.

Implementations

impl Query

pub fn semantic(text: impl Into<String>) -> Self

Pure semantic search.

pub fn text(text: impl Into<String>) -> Self

Pure lexical search.

pub fn hybrid(text: impl Into<String>) -> Self

Hybrid (RRF) search; default alpha = 0.6.

pub fn hierarchical(self) -> Self

Plan 10: opt into hierarchical descent. The search starts at the configured scope (or the tenant root if unset) and descends through internal nodes, scoring child summaries at each level and pruning branches whose top scores fall below Query::prune_threshold. Leaves are searched only after the parent’s index has identified them as relevant. Defaults to flat (whole-tree) search when off.

pub fn prune_threshold(self, t: f32) -> Self

Plan 10: prune children whose mid-level summary score is below t. Default is no pruning — every child whose score made the top-K of the parent’s index is descended into. Clamped to [-1, 1] (cosine range).

pub fn descend_factor(self, n: u32) -> Self

Plan 10: at each internal level, descend into the top k * descend_factor children. Higher = wider beam = slower but more recall; lower = narrower beam = faster but more risk of pruning the right answer. Default 4. Clamped to >= 1.

pub fn is_hierarchical(&self) -> bool

Whether this query is in hierarchical mode.

pub fn alpha(self, alpha: f32) -> Self

Override hybrid alpha. No effect on non-hybrid queries.

pub fn within(self, path: PartitionPath) -> Self

Restrict the search to a partition (and its descendants).

pub fn with_embedding(self, vector: Vec<f32>) -> Self

Caller hands the engine a pre-computed query vector. Used by caller-owned-models pathways (Apple Foundation Models, OpenAI proxies, Swift FFI consumers) where the model runs outside the library on the query side.

When set, the engine bypasses its Embedder (if any) for the query step. The vector’s length must match schema_meta.embedder_dims; mismatch surfaces from the underlying vector index. Has no effect on QueryMode::Text (lexical search ignores the vector).

See spec § 12 (caller-owned models) and § 12.13.

pub fn precomputed_embedding(&self) -> Option<&[f32]>

Borrow the precomputed query vector, if any. None means the engine must invoke its configured Embedder to derive the query vector.

pub fn text_str(&self) -> &str

Borrow the query text.

pub fn mode(&self) -> &QueryMode

Borrow the mode.

pub fn scope(&self) -> Option<&PartitionPath>

Borrow the partition restriction (if any).

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.