Struct elasticsearch_dsl::search::queries::specialized::DistanceFeatureQuery

pub struct DistanceFeatureQuery<O>where
    O: Origin,{ /* private fields */ }

Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location.

You can use the distance_feature query to find the nearest neighbors to a location. You can also use the query in a bool search’s should filter to add boosted relevance scores to the bool query’s scores.

How the distance_feature query calculates relevance scores

The distance_feature query dynamically calculates the distance between the origin value and a document’s field values. It then uses this distance as a feature to boost the relevance-scores of closer documents.

The distance_feature query calculates a document’s relevance score as follows:

relevance score = boost * pivot / (pivot + distance)

The distance is the absolute difference between the origin value and a document’s field value.

Skip non-competitive hits

Unlike the function_score query or other ways to change relevance scores , the distance_feature query efficiently skips non-competitive hits when the track_total_hits parameter is not true.

To create distance feature query date query:

Query::distance_feature("test", Utc.ymd(2014, 7, 8).and_hms(9, 1, 0), Time::Days(7))
    .boost(1.5)
    .name("test");

To create distance feature query geo query:

Query::distance_feature("test", GeoLocation::new(-71.34, 40.12), Distance::Kilometers(15))
    .boost(1.5)
    .name("test");

Distance Feature is built to allow only valid origin and pivot values, the following won’t compile:

Query::distance_feature("test", Utc.ymd(2014, 7, 8).and_hms(9, 1, 0), Distance::Kilometers(15))
    .boost(1.5)
    .name("test");

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

Implementations

impl<O> DistanceFeatureQuery<O>where
    O: Origin,

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<O: Clone> Clone for DistanceFeatureQuery<O>where
    O: Origin,

fn clone(&self) -> DistanceFeatureQuery<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for DistanceFeatureQuery<O>where
    O: Origin,

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

Formats the value using the given formatter.

impl From<DistanceFeatureQuery<DateTime<Utc>>> for Option<Query>

fn from(q: DistanceFeatureQuery<DateTime<Utc>>) -> Self

Converts to this type from the input type.

impl From<DistanceFeatureQuery<DateTime<Utc>>> for Query

fn from(q: DistanceFeatureQuery<DateTime<Utc>>) -> Self

Converts to this type from the input type.

impl From<DistanceFeatureQuery<GeoLocation>> for Option<Query>

fn from(q: DistanceFeatureQuery<GeoLocation>) -> Self

Converts to this type from the input type.

impl From<DistanceFeatureQuery<GeoLocation>> for Query

fn from(q: DistanceFeatureQuery<GeoLocation>) -> Self

Converts to this type from the input type.

impl IntoIterator for DistanceFeatureQuery<DateTime<Utc>>

type Item = DistanceFeatureQuery<DateTime<Utc>>

The type of the elements being iterated over.

type IntoIter = IntoIter<<DistanceFeatureQuery<DateTime<Utc>> 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 IntoIterator for DistanceFeatureQuery<GeoLocation>

type Item = DistanceFeatureQuery<GeoLocation>

The type of the elements being iterated over.

type IntoIter = IntoIter<<DistanceFeatureQuery<GeoLocation> 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<DistanceFeatureQuery<DateTime<Utc>>> for Query

fn eq(&self, other: &DistanceFeatureQuery<DateTime<Utc>>) -> 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<DistanceFeatureQuery<GeoLocation>> for Query

fn eq(&self, other: &DistanceFeatureQuery<GeoLocation>) -> 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<O: PartialEq> PartialEq<DistanceFeatureQuery<O>> for DistanceFeatureQuery<O>where
    O: Origin,

fn eq(&self, other: &DistanceFeatureQuery<O>) -> 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<Query> for DistanceFeatureQuery<DateTime<Utc>>

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<Query> for DistanceFeatureQuery<GeoLocation>

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 Serialize for DistanceFeatureQuery<DateTime<Utc>>

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

Serialize this value into the given Serde serializer.

impl Serialize for DistanceFeatureQuery<GeoLocation>

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

Serialize this value into the given Serde serializer.

impl<O> StructuralPartialEq for DistanceFeatureQuery<O>where
    O: Origin,