Skip to main content

VectorQueryBuilder

Struct VectorQueryBuilder 

Source
pub struct VectorQueryBuilder { /* private fields */ }
Expand description

Builder for VectorQuery. Covers every knob on the query except set_query_params (the untyped escape hatch); HNSW / IVF / Flat parameters still go through their respective builders and .params(...).

Implementations§

Source§

impl VectorQueryBuilder

Source

pub fn field(self, name: impl Into<String>) -> Self

Source

pub fn topk(self, k: i32) -> Self

Source

pub fn filter(self, expr: impl Into<String>) -> Self

Source

pub fn include_vector(self, include: bool) -> Self

Source

pub fn include_doc_id(self, include: bool) -> Self

Source

pub fn output_fields<I, S>(self, fields: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn vector_fp32(self, vec: &[f32]) -> Self

Source

pub fn vector_fp64(self, vec: &[f64]) -> Self

Source

pub fn vector_raw(self, bytes: Vec<u8>) -> Self

Raw vector bytes. Prefer Self::vector_fp32 / Self::vector_fp64 when possible.

Source

pub fn hnsw_params(self, params: HnswQueryParams) -> Self

Source

pub fn ivf_params(self, params: IvfQueryParams) -> Self

Source

pub fn flat_params(self, params: FlatQueryParams) -> Self

Source

pub fn build(self) -> Result<VectorQuery>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.