Struct elasticsearch_dsl::search::queries::specialized::RankFeatureSaturationQuery

pub struct RankFeatureSaturationQuery { /* private fields */ }

Boosts the relevance score of documents based on the numeric value of a rank_feature or rank_features field.

To create a rank feature query:

Query::rank_feature("test");

To apply mathematical functions:

Query::rank_feature("test").saturation();
Query::rank_feature("test").saturation().pivot(2.2);
Query::rank_feature("test").logarithm(3.0);
Query::rank_feature("test").sigmoid(1.0, 2.0);
Query::rank_feature("test").linear();

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

Implementations

impl RankFeatureSaturationQuery

pub fn pivot<T>(self, pivot: T) -> Selfwhere
    T: Into<f64>,

Sets pivot value

pub fn boost<T>(self, boost: T) -> Selfwhere
    T: AsPrimitive<f32>,

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) -> Selfwhere
    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 RankFeatureSaturationQuery

fn clone(&self) -> RankFeatureSaturationQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RankFeatureSaturationQuery

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

Formats the value using the given formatter.

impl From<RankFeatureSaturationQuery> for Option<Query>

fn from(q: RankFeatureSaturationQuery) -> Self

Converts to this type from the input type.

impl From<RankFeatureSaturationQuery> for Query

fn from(q: RankFeatureSaturationQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for RankFeatureSaturationQuery

type Item = RankFeatureSaturationQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<RankFeatureSaturationQuery as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Query> for RankFeatureSaturationQuery

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RankFeatureSaturationQuery> for Query

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RankFeatureSaturationQuery> for RankFeatureSaturationQuery

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RankFeatureSaturationQuery

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 RankFeatureSaturationQuery