Struct Mmr 

pub struct Mmr {
    pub diversity: Option<f32>,
    pub candidates_limit: Option<u32>,
}

Maximal Marginal Relevance (MMR) algorithm for re-ranking the points.

Fields

diversity: Option<f32>

Tunable parameter for the MMR algorithm. Determines the balance between diversity and relevance.

A higher value favors diversity (dissimilarity to selected results), while a lower value favors relevance (similarity to the query vector).

Must be in the range [0, 1]. Default value is 0.5.

candidates_limit: Option<u32>

The maximum number of candidates to consider for re-ranking.

If not specified, the limit value is used.

Implementations

impl Mmr

pub fn diversity(&self) -> f32

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

pub fn candidates_limit(&self) -> u32

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

Trait Implementations

impl Clone for Mmr

fn clone(&self) -> Mmr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mmr

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

Formats the value using the given formatter.

impl Default for Mmr

fn default() -> Self

Returns the “default value” for a type.

impl From<MmrBuilder> for Mmr

fn from(value: MmrBuilder) -> Self

Converts to this type from the input type.

impl Message for Mmr

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 Mmr

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

impl StructuralPartialEq for Mmr