Struct SearchParams 

pub struct SearchParams {
    pub k: usize,
    pub filter: Option<Filter>,
    pub ef_search: usize,
    pub with_payload: bool,
    pub with_vector: bool,
}

Parameters for a Database::search.

Fields

k: usize

Number of results to return.

filter: Option<Filter>

Optional payload predicate. The planner pre-filters through the collection’s secondary indexes when the filter is selective enough, and otherwise post-filters the ANN candidates; either way the full predicate is re-checked, so results are exact.

ef_search: usize

Search beam width (recall/latency knob), clamped up to at least k.

with_payload: bool

Include payloads in the results.

with_vector: bool

Include vectors in the results.

Trait Implementations

impl Clone for SearchParams

fn clone(&self) -> SearchParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchParams

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

Formats the value using the given formatter.

impl Default for SearchParams

fn default() -> Self

Returns the “default value” for a type.