Skip to main content

MultiVectorSearchRequest

Struct MultiVectorSearchRequest

pub struct MultiVectorSearchRequest {Show 14 fields
    pub positive_vectors: Vec<Vec<f32>>,
    pub positive_weights: Option<Vec<f32>>,
    pub negative_vectors: Option<Vec<Vec<f32>>>,
    pub negative_weights: Option<Vec<f32>>,
    pub top_k: usize,
    pub distance_metric: DistanceMetric,
    pub score_threshold: Option<f32>,
    pub enable_mmr: bool,
    pub mmr_lambda: f32,
    pub include_metadata: bool,
    pub include_vectors: bool,
    pub filter: Option<FilterExpression>,
    pub consistency: ReadConsistency,
    pub staleness_config: Option<StalenessConfig>,
}

Expand description

Request for multi-vector search with positive and negative vectors

Fields§

§positive_vectors: Vec<Vec<f32>>

Positive vectors to search towards (required, at least one)

§positive_weights: Option<Vec<f32>>

Weights for positive vectors (optional, defaults to equal weights)

§negative_vectors: Option<Vec<Vec<f32>>>

Negative vectors to search away from (optional)

§negative_weights: Option<Vec<f32>>

Weights for negative vectors (optional, defaults to equal weights)

§top_k: usize

Number of results to return

§distance_metric: DistanceMetric

Distance metric to use

§score_threshold: Option<f32>

Minimum score threshold

§enable_mmr: bool

Enable MMR (Maximal Marginal Relevance) for diversity

§mmr_lambda: f32

Lambda parameter for MMR (0 = max diversity, 1 = max relevance)

§include_metadata: bool

Include metadata in results

§include_vectors: bool

Include vectors in results

§filter: Option<FilterExpression>

Optional metadata filter

§consistency: ReadConsistency

Read consistency level (Turbopuffer-inspired)

§staleness_config: Option<StalenessConfig>

Staleness configuration for bounded_staleness consistency

Trait Implementations§

impl Debug for MultiVectorSearchRequest

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for MultiVectorSearchRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

impl Freeze for MultiVectorSearchRequest

impl RefUnwindSafe for MultiVectorSearchRequest

impl Send for MultiVectorSearchRequest

impl Sync for MultiVectorSearchRequest

impl Unpin for MultiVectorSearchRequest

impl UnsafeUnpin for MultiVectorSearchRequest

impl UnwindSafe for MultiVectorSearchRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,