Struct elasticsearch_dsl::search::queries::full_text::MultiMatchQuery

source ·

pub struct MultiMatchQuery { /* private fields */ }

Expand description

Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

The match query is the standard query for performing a full-text search, including options for fuzzy matching.

To create a Match query with numeric values:

Query::multi_match(vec!["test"], "search text")
    .boost(2)
    .name("test");

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

Implementations§

source §

impl MultiMatchQuery

source

pub fn type(self, type: TextQueryType) -> Self

The way the multi_match query is executed internally depends on the type parameter

source

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

Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. Defaults to 0.0.

You can use the tie_breaker value to assign higher relevance scores to documents that contain the same term in multiple fields than documents that contain this term in only the best of those multiple fields, without confusing this with the better case of two different terms in the multiple fields.

If a document matches multiple clauses, the dis_max query calculates the relevance score for the document as follows:

Take the relevance score from a matching clause with the highest score.
Multiply the score from any other matching clauses by the tie_breaker value.
Add the highest score to the multiplied scores.

If the tie_breaker value is greater than 0.0, all matching clauses count, but the clause with the highest score counts most.

source

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

Analyzer used to convert the text in the query value into tokens. Defaults to the index-time analyzer mapped for the <field>. If no analyzer is mapped, the index’s default analyzer is used.

source

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

If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.

See Use synonyms with match query for an example.

source

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.

source

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

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

source

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

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

source

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

If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.

source

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

Method used to rewrite the query. See the rewrite parameter for valid values and more information.

If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.

source

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

If true, format-based errors, such as providing a text query value for a numeric field, are ignored. Defaults to false.

source

pub fn operator(self, operator: Operator) -> Self

Boolean logic used to interpret text in the query value

source

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

Minimum number of clauses that must match for a document to be returned. See the minimum_should_match parameter for valid values and more information.

source

pub fn zero_terms_query(self, zero_terms_query: ZeroTermsQuery) -> Self

Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

source

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.

source

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