Struct Parameters 

#[non_exhaustive]
pub struct Parameters {
    pub approximate_neighbor_candidates: i32,
    pub leaf_nodes_search_fraction: f64,
    /* private fields */
}

Available on crate feature feature-online-store-service only.

Parameters that can be overrided in each query to tune query latency and recall.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

approximate_neighbor_candidates: i32

Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.

leaf_nodes_search_fraction: f64

Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.

Implementations

impl Parameters

pub fn new() -> Self

pub fn set_approximate_neighbor_candidates<T: Into<i32>>(self, v: T) -> Self

Sets the value of approximate_neighbor_candidates.

Example

let x = Parameters::new().set_approximate_neighbor_candidates(42);

pub fn set_leaf_nodes_search_fraction<T: Into<f64>>(self, v: T) -> Self

Sets the value of leaf_nodes_search_fraction.

Example

let x = Parameters::new().set_leaf_nodes_search_fraction(42.0);

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameters

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

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Parameters

Returns the “default value” for a type.

impl Message for Parameters

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Parameters

fn eq(&self, other: &Parameters) -> 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 StructuralPartialEq for Parameters