Skip to main content

SearchParams

Struct SearchParams 

Source
pub struct SearchParams {
    pub hnsw_ef: Option<u64>,
    pub exact: Option<bool>,
    pub acorn: Option<bool>,
    pub max_selectivity: Option<f64>,
    pub indexed_only: Option<bool>,
    pub quantization: Option<QuantizationSearchParams>,
    pub rrf_k: Option<u64>,
    pub rrf_weights: Option<Vec<f64>>,
    pub idf: Option<IdfParams>,
    pub timeout: Option<u64>,
    pub consistency: Option<ReadConsistency>,
}
Expand description

PARAMS (…) execution knobs for a query.

Fields§

§hnsw_ef: Option<u64>

HNSW candidate list size (hnsw_ef).

§exact: Option<bool>

Force exact (brute-force) search.

§acorn: Option<bool>

Enable or disable ACORN filter-aware search.

§max_selectivity: Option<f64>

ACORN selectivity ceiling in (0, 1]. Only valid with acorn = true.

§indexed_only: Option<bool>

Restrict the search to indexed points only.

§quantization: Option<QuantizationSearchParams>

Quantization search overrides.

§rrf_k: Option<u64>

RRF smoothing constant k.

§rrf_weights: Option<Vec<f64>>

Per-prefetch RRF weights.

§idf: Option<IdfParams>

Per-query IDF corpus for sparse vectors. None = collection-wide (global).

§timeout: Option<u64>

Request-level timeout in seconds (OpenAPI query param / proto field). Not part of body SearchParams.

§consistency: Option<ReadConsistency>

Request-level read consistency (OpenAPI query param / proto field).

Trait Implementations§

Source§

impl Clone for SearchParams

Source§

fn clone(&self) -> SearchParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SearchParams

Source§

fn default() -> SearchParams

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SearchParams

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SearchParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.