Struct elasticsearch_dsl::search::queries::term_level::FuzzyQuery

pub struct FuzzyQuery { /* private fields */ }

Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

An edit distance is the number of one-character changes needed to turn one term into another. These changes can include:

• Changing a character (box → fox)
• Removing a character (black → lack)
• Inserting a character (sic → sick)
• Transposing two adjacent characters (act → cat) To find similar terms, the fuzzy query creates a set of all possible variations, or expansions, of the search term within a specified edit distance. The query then returns exact matches for each expansion.

To create a fuzzy query with numeric values:

Query::fuzzy("test", 123);

To create a fuzzy query with string values and optional fields:

Query::fuzzy("test", "username")
    .boost(2)
    .name("test");

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

Implementations

impl FuzzyQuery

pub fn fuzziness<T>(self, fuzziness: T) -> Selfwhere
    T: Into<Fuzziness>,

Maximum edit distance allowed for matching. See Fuzziness for valid values and more information. See Fuzziness in the match query for an example.

pub fn max_expansions(self, max_expansions: u8) -> Self

Maximum number of terms to which the query will expand. Defaults to 50.

pub fn prefix_length(self, prefix_length: u8) -> Self

Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

pub fn transpositions(self, transpositions: bool) -> Self

Indicates whether edits include transpositions of two adjacent characters (ab → ba). Defaults to true

pub fn rewrite(self, rewrite: Rewrite) -> Self

Method used to rewrite the query. For valid values and more information, see the rewrite parameter.

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 FuzzyQuery

fn clone(&self) -> FuzzyQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuzzyQuery

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

Formats the value using the given formatter.

impl From<FuzzyQuery> for MultiTermQuery

fn from(q: FuzzyQuery) -> Self

Converts to this type from the input type.

impl From<FuzzyQuery> for Option<MultiTermQuery>

fn from(q: FuzzyQuery) -> Self

Converts to this type from the input type.

impl From<FuzzyQuery> for Option<Query>

fn from(q: FuzzyQuery) -> Self

Converts to this type from the input type.

impl From<FuzzyQuery> for Query

fn from(q: FuzzyQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for FuzzyQuery

type Item = FuzzyQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<FuzzyQuery 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<FuzzyQuery> for FuzzyQuery

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

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

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

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

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 FuzzyQuery

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 FuzzyQuery