Struct SearchParams 

pub struct SearchParams {
    pub ef_search: usize,
    pub num_candidates: usize,
    pub over_fetch_ratio: f64,
    pub rerank_depth: usize,
    pub early_termination: bool,
}

Tunable search parameters for vector index queries.

Fields

ef_search: usize

HNSW ef_search: number of candidates to explore during search.

num_candidates: usize

Number of candidates to pre-fetch before re-ranking.

over_fetch_ratio: f64

Over-fetch ratio: fetch this many times more candidates than k.

rerank_depth: usize

Re-ranking depth: how many candidates to re-rank with exact distances.

early_termination: bool

Whether to enable approximate early termination.

Implementations

impl SearchParams

pub fn high_recall() -> Self

Create parameters optimized for high recall.

pub fn low_latency() -> Self

Create parameters optimized for low latency.

pub fn clamp(&mut self)

Clamp all parameters to valid ranges.

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.

impl<'de> Deserialize<'de> for SearchParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchParams

fn eq(&self, other: &SearchParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchParams