Struct SearchContract 

pub struct SearchContract {
    pub mode: GuaranteeMode,
    pub k: usize,
    pub stopping_rule: StoppingRule,
    pub include_envelopes: bool,
}

Complete search contract specifying guarantees

Fields

mode: GuaranteeMode

Guarantee mode

k: usize

Number of results requested

stopping_rule: StoppingRule

Stopping rule

include_envelopes: bool

Whether to include score envelopes in results

Implementations

impl SearchContract

pub fn approximate(k: usize, n_probes: u32) -> Self

Create contract for approximate search

pub fn calibrated(k: usize, recall_target: f32, confidence: f32) -> Self

Create contract for calibrated search

pub fn certified(k: usize) -> Self

Create contract for certified search

pub fn with_budget(self, max_ram_bytes: u64, max_latency: Duration) -> Self

Add budget constraints

Trait Implementations

impl Clone for SearchContract

fn clone(&self) -> SearchContract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchContract

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

Formats the value using the given formatter.