Struct elasticsearch_dsl::search::queries::params::FieldValueFactor

pub struct FieldValueFactor { /* private fields */ }

The field_value_factor function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting. If used on a multi-valued field, only the first value of the field is used in calculations.

As an example, imagine you have a document indexed with a numeric my-int field and wish to influence the score of a document with this field, an example doing so would look like:

FieldValueFactor::new("my-int")
    .factor(1.2)
    .modifier(FieldValueFactorModifier::Sqrt)
    .missing(1.0)

Which will translate into the following formula for scoring:

sqrt(1.2 * doc['my-int'].value)

Implementations

impl FieldValueFactor

pub fn new(field: impl Into<String>) -> Self

Creates an instance of FieldValueFactor

• field - Field to be extracted from the document.

pub fn factor(self, factor: f32) -> Self

Factor to multiply the field value with

pub fn modifier(self, modifier: FieldValueFactorModifier) -> Self

Modifier to apply to the field value

pub fn missing(self, missing: f32) -> Self

Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document

Trait Implementations

impl Clone for FieldValueFactor

fn clone(&self) -> FieldValueFactor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldValueFactor

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

Formats the value using the given formatter.

impl From<FieldValueFactor> for Function

fn from(q: FieldValueFactor) -> Self

Converts to this type from the input type.

impl From<FieldValueFactor> for Option<Function>

fn from(q: FieldValueFactor) -> Self

Converts to this type from the input type.

impl PartialEq<FieldValueFactor> for FieldValueFactor

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

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

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

This method tests for !=.

impl Serialize for FieldValueFactor

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldValueFactor