Struct FunctionScoreQuery 

pub struct FunctionScoreQuery<S = Root> { /* private fields */ }

A function_score clause. Add functions with weight / function and tune combination with score_mode / boost_mode / max_boost / min_score.

Implementations

impl<S> FunctionScoreQuery<S>

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

Add a constant weight function applied to every match.

pub fn weight_when(self, weight: f32, filter: impl AsQuery<S>) -> Self

Add a constant weight function applied only to matches of filter.

pub fn function(self, function: Value) -> Self

Add a raw function entry (e.g. a field_value_factor, gauss, or script_score object) — the escape hatch for the long tail of function types, still composed into the typed clause.

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

How the functions combine (ScoreMode::Multiply is the default).

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

How the function score combines with the query score (BoostMode::Multiply is the default).

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

Cap on the combined function score.

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

Drop hits scoring below this threshold.

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

Multiply this clause’s relevance score by boost.

pub fn name(self, name: impl Into<String>) -> Self

Tag this clause with _name, surfaced in a hit’s matched_queries.

Trait Implementations

impl<S> AsQuery<S> for FunctionScoreQuery<S>

fn into_query(self) -> Option<Query<S>>

The clause this produces, or None to contribute nothing.

fn and(self, other: impl AsQuery<S>) -> Query<S>

where Self: Sized,

self AND other. An absent side is the identity.

fn or(self, other: impl AsQuery<S>) -> Query<S>

where Self: Sized,

self OR other. An absent side is the identity.

fn not(self) -> Query<S>

where Self: Sized,

NOT self (negating an absent clause matches everything).

fn to_value(&self) -> Value

where Self: Sized + Clone,

Render this clause to the OpenSearch query DSL. An absent clause renders as match_all. Handy for tests and debugging.

impl<S: Clone> Clone for FunctionScoreQuery<S>

fn clone(&self) -> FunctionScoreQuery<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for FunctionScoreQuery<S>

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

Formats the value using the given formatter.