Struct elasticsearch_dsl::search::queries::specialized::ScriptScoreQuery

pub struct ScriptScoreQuery { /* private fields */ }

A query allowing 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 create script score query:

Query::script_score(
    Query::r#match("message", "elasticsearch"),
    Script::source("doc['my-int'].value / 10"),
);

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

Implementations

impl ScriptScoreQuery

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 ScriptScoreQuery

fn clone(&self) -> ScriptScoreQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptScoreQuery

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

Formats the value using the given formatter.

impl From<ScriptScoreQuery> for Option<Query>

fn from(q: ScriptScoreQuery) -> Self

Converts to this type from the input type.

impl From<ScriptScoreQuery> for Query

fn from(q: ScriptScoreQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for ScriptScoreQuery

type Item = ScriptScoreQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<ScriptScoreQuery 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 ScriptScoreQuery

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ScriptScoreQuery> for Query

fn eq(&self, other: &ScriptScoreQuery) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ScriptScoreQuery> for ScriptScoreQuery

fn eq(&self, other: &ScriptScoreQuery) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScriptScoreQuery

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 ScriptScoreQuery