Struct SearchParams

pub struct SearchParams {
    pub hnsw_ef: Option<u64>,
    pub exact: Option<bool>,
    pub quantization: Option<QuantizationSearchParams>,
    pub indexed_only: Option<bool>,
}

Fields

hnsw_ef: Option<u64>

Params relevant to HNSW index. Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.

exact: Option<bool>

Search without approximation. If set to true, search may run long but with exact results.

quantization: Option<QuantizationSearchParams>

If set to true, search will ignore quantized vector data

indexed_only: Option<bool>

If enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors will be included in search results

Implementations

impl SearchParams

pub fn hnsw_ef(&self) -> u64

Returns the value of hnsw_ef, or the default value if hnsw_ef is unset.

pub fn exact(&self) -> bool

Returns the value of exact, or the default value if exact is unset.

pub fn indexed_only(&self) -> bool

Returns the value of indexed_only, or the default value if indexed_only is unset.

Trait Implementations

impl Clone for SearchParams

fn clone(&self) -> SearchParams

Returns a copy 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 From<SearchParamsBuilder> for SearchParams

fn from(value: SearchParamsBuilder) -> Self

Converts to this type from the input type.

impl Message for SearchParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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 Copy for SearchParams

impl StructuralPartialEq for SearchParams