Struct MultiQuery 

pub struct MultiQuery { /* private fields */ }

A multi-query operation combining multiple SubQuery objects.

Use MultiQuery::new to construct, then MultiQuery::add_sub_query to attach individual sub-queries. Configure top-k, filters, and rerank strategy before passing to crate::Collection::multi_query.

Implementations

impl MultiQuery

pub fn new() -> Result<Self>

Creates a new multi-query.

pub unsafe fn as_raw(&self) -> *mut zvec_multi_query_t

Returns the raw FFI handle.

Safety

The caller must not use the handle after the MultiQuery is dropped.

pub fn add_sub_query(&mut self, sub: &SubQuery) -> Result<()>

Adds a sub-query to this multi-query.

The sub-query is copied internally; the caller retains ownership.

pub fn sub_query_count(&self) -> usize

Returns the number of sub-queries currently registered.

pub fn set_topk(&mut self, topk: i32) -> Result<()>

Sets the top-k parameter for the merged result.

pub fn topk(&self) -> i32

Returns the configured top-k value.

pub fn set_filter(&mut self, filter: &str) -> Result<()>

Sets the filter expression applied to the final merged result.

pub fn set_include_vector(&mut self, include: bool) -> Result<()>

Sets whether vector data is returned in the result documents.

pub fn include_vector(&self) -> bool

Returns whether vector data is included in the result documents.

pub fn set_output_fields(&mut self, fields: &[&str]) -> Result<()>

Sets the output field whitelist.

pub fn set_rerank_rrf(&mut self, rank_constant: i32) -> Result<()>

Configures Reciprocal Rank Fusion (RRF) as the rerank strategy.

pub fn set_rerank_weighted(&mut self, weights: &[f64]) -> Result<()>

Configures a weighted rerank strategy with the given per-sub-query weights.

Trait Implementations

impl Drop for MultiQuery

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for MultiQuery