Struct elasticsearch_dsl::search::queries::compound::FunctionScoreQuery

pub struct FunctionScoreQuery { /* private fields */ }

The function_score allows you to modify the score of documents that are retrieved by a query.

This can be useful if, for example, a score function is computationally expensive and it is sufficient to compute the score on a filtered set of documents.

To use function_score, the user has to define a query and one or more functions, that compute a new score for each document returned by the query.

To create function_score query:

Query::function_score(Query::term("test", 1))
    .function(RandomScore::new())
    .function(Weight::new(2.0))
    .max_boost(2.2)
    .min_score(2.3)
    .score_mode(FunctionScoreMode::Avg)
    .boost_mode(FunctionScoreBoostMode::Max)
    .boost(1.1)
    .name("test");

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html

Implementations

impl FunctionScoreQuery

pub fn function(self, function: impl Into<Option<Function>>) -> Self

Push function to the list

pub fn max_boost(self, max_boost: impl TryInto<Boost>) -> Self

Maximum score value after applying all the functions

pub fn min_score(self, min_score: impl Into<f32>) -> Self

By default, modifying the score does not change which documents match. To exclude documents that do not meet a certain score threshold the min_score parameter can be set to the desired score threshold.

pub fn score_mode(self, score_mode: FunctionScoreMode) -> Self

Each document is scored by the defined functions. The parameter score_mode specifies how the computed scores are combined

pub fn boost_mode(self, boost_mode: FunctionScoreBoostMode) -> Self

The newly computed score is combined with the score of the query. The parameter boost_mode defines how.

pub fn boost<B>(self, boost: B) -> Self where
    B: TryInto<Boost>, 

Floating point number used to decrease or increase the relevance scores of a query. Defaults to 1.0.

You can use the boost parameter to adjust relevance scores for searches containing two or more queries.

Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

pub fn name<S>(self, name: S) -> Self where
    S: ToString, 

You can use named queries to track which queries matched returned documents. If named queries are used, the response includes a matched_queries property for each hit.

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html#named-queries

Trait Implementations

impl Clone for FunctionScoreQuery

fn clone(&self) -> FunctionScoreQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionScoreQuery

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

Formats the value using the given formatter.

impl From<FunctionScoreQuery> for Query

fn from(q: FunctionScoreQuery) -> Self

Converts to this type from the input type.

impl From<FunctionScoreQuery> for Option<Query>

fn from(q: FunctionScoreQuery) -> Self

Converts to this type from the input type.

impl From<FunctionScoreQuery> for Queries

fn from(q: FunctionScoreQuery) -> Self

Converts to this type from the input type.

impl PartialEq<FunctionScoreQuery> for FunctionScoreQuery

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

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

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

This method tests for !=.

impl PartialEq<FunctionScoreQuery> for Query

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

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

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

This method tests for !=.

impl PartialEq<Query> for FunctionScoreQuery

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

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

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

This method tests for !=.

impl Serialize for FunctionScoreQuery

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 FunctionScoreQuery