Struct elasticsearch_dsl::search::queries::params::TieBreaker

pub struct TieBreaker(_);

Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. Defaults to 0.0.

You can use the tie_breaker value to assign higher relevance scores to documents that contain the same term in multiple fields than documents that contain this term in only the best of those multiple fields, without confusing this with the better case of two different terms in the multiple fields.

If a document matches multiple clauses, the dis_max query calculates the relevance score for the document as follows:

1. Take the relevance score from a matching clause with the highest score.
2. Multiply the score from any other matching clauses by the tie_breaker value.
3. Add the highest score to the multiplied scores.

If the tie_breaker value is greater than 0.0, all matching clauses count, but the clause with the highest score counts most.

Trait Implementations

impl Clone for TieBreaker

fn clone(&self) -> TieBreaker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TieBreaker

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

Formats the value using the given formatter.

impl PartialEq<TieBreaker> for TieBreaker

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for TieBreaker

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<f32> for TieBreaker

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for TieBreaker

impl StructuralPartialEq for TieBreaker