Module elasticsearch_dsl::search::queries::params[][src]

Expand description

Strongly typed Elasticsearch query params

Structs

A container type for boost values

Decay functions score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to a range query, but with smooth edges instead of boxes.

The field_value_factor function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting. If used on a multi-valued field, only the first value of the field is used in calculations.

The parent-join and nested features allow the return of documents that have matches in a different scope. In the parent/child case, parent documents are returned based on matches in child documents or child documents are returned based on matches in parent documents. In the nested case, documents are returned based on matches in nested inner objects.

A container type for boost values

A document to percolate

A collection of documents to percolate

Percolate document from another index

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

The script_score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression

Terms lookup fetches the field values of an existing document. Elasticsearch then uses those values as search terms. This can be helpful when searching for a large set of terms.

Custom script containing the number of matching terms required to return a document.

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

The weight score allows you to multiply the score by the provided weight.

Enums

Decay function variants

Modifier to apply to the field value

Functions available for use in FunctionScoreQuery

The newly computed score is combined with the score of the query. The parameter boost_mode defines how.

Each document is scored by the defined functions. The parameter score_mode specifies how the computed scores are combined

Some queries and APIs support parameters to allow inexact fuzzy matching, using the fuzziness parameter.

The way the multi_match query is executed internally.

Indicates how scores for matching child objects affect the root parent document’s relevance score.

Boolean logic used to interpret text in the query value

Values that can be percolated

Indicates how the range query matches values for range fields.

You can use the flags parameter to enable more optional operators for Lucene’s regular expression engine.

Method used to rewrite the query.

Number of matching terms to be required

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

Traits

Marker trait for percolate query values

Marker trait for terms query values

Type Definitions

The minimum_should_match type alias