Struct SearchParams 

pub struct SearchParams {
    pub k: usize,
    pub ef: Option<usize>,
    pub metric: DistanceMetric,
    pub filter: Option<Filter>,
}

The parameters of a nearest-neighbor search.

k is how many results to return, metric is how distance is measured, ef is an optional search-breadth knob (the candidate-list size some approximate indexes expose; ignored by exact search), and filter is an optional metadata predicate restricting which records are eligible. Start from SearchParams::new and set the optional fields as needed.

Examples

use iqdb_types::{DistanceMetric, Filter, SearchParams, Value};

let params = SearchParams {
    filter: Some(Filter::eq("published", Value::Bool(true))),
    ..SearchParams::new(10, DistanceMetric::Cosine)
};

assert_eq!(params.k, 10);
assert_eq!(params.metric, DistanceMetric::Cosine);
assert_eq!(params.ef, None);
assert!(params.filter.is_some());

Fields

k: usize

The number of nearest neighbors to return.

ef: Option<usize>

Optional search breadth (candidate-list size) for approximate indexes; None lets the engine choose, and exact search ignores it.

metric: DistanceMetric

The distance metric used to rank candidates.

filter: Option<Filter>

Optional metadata predicate restricting which records are eligible.

Implementations

impl SearchParams

pub fn new(k: usize, metric: DistanceMetric) -> SearchParams

Creates parameters for a top-k search under metric, with no search breadth and no filter.

Examples

use iqdb_types::{DistanceMetric, SearchParams};

let params = SearchParams::new(5, DistanceMetric::Euclidean);
assert_eq!(params.k, 5);
assert_eq!(params.ef, None);
assert!(params.filter.is_none());

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SearchParams, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchParams