Struct elasticsearch_dsl::search::queries::params::RandomScore

pub struct RandomScore { /* private fields */ }

The random_score generates scores that are uniformly distributed from 0 up to but not including 1.

By default, it uses the internal Lucene doc ids as a source of randomness, which is very efficient but unfortunately not reproducible since documents might be renumbered by merges.

In case you want scores to be reproducible, it is possible to provide a seed and field. The final score will then be computed based on this seed, the minimum value of field for the considered document and a salt that is computed based on the index name and shard id so that documents that have the same value but are stored in different indexes get different scores. Note that documents that are within the same shard and have the same value for field will however get the same score, so it is usually desirable to use a field that has unique values for all documents. A good default choice might be to use the _seq_no field, whose only drawback is that scores will change if the document is updated since update operations also update the value of the _seq_no field.

Implementations

impl RandomScore

pub fn new() -> Self

Creates an instance of RandomScore

pub fn seed<T>(self, seed: T) -> Selfwhere
    T: Serialize,

Sets seed value

pub fn field<T>(self, field: T) -> Selfwhere
    T: ToString,

Sets field value

Trait Implementations

impl Clone for RandomScore

fn clone(&self) -> RandomScore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RandomScore

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

Formats the value using the given formatter.

impl Default for RandomScore

fn default() -> RandomScore

Returns the “default value” for a type.

impl From<RandomScore> for Function

fn from(q: RandomScore) -> Self

Converts to this type from the input type.

impl From<RandomScore> for Option<Function>

fn from(q: RandomScore) -> Self

Converts to this type from the input type.

impl PartialEq<RandomScore> for RandomScore

fn eq(&self, other: &RandomScore) -> 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 RandomScore

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 RandomScore