Module elasticsearch_dsl::search::queries::params

Strongly typed Elasticsearch query params

Structs

• Decay
  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.
• FieldValueFactor
  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.
• InnerHits
  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.
• NegativeBoost
  A container type for boost values
• PinnedDocument
  Pinned document
• RandomScore
  The random_score generates scores that are uniformly distributed from 0 up to but not including 1.
• Script
  Wherever scripting is supported in the Elasticsearch APIs, the syntax follows the same pattern; you specify the language of your script, provide the script logic (or source, and add parameters that are passed into the script.
• ScriptScore
  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
• TermsSetScript
  Custom script containing the number of matching terms required to return a document.
• Weight
  The weight score allows you to multiply the score by the provided weight.

Enums

• DecayFunction
  Decay function variants
• FieldValueFactorModifier
  Modifier to apply to the field value
• Function
  Functions available for use in FunctionScoreQuery
• FunctionBoostMode
  The newly computed score is combined with the score of the query. The parameter boost_mode defines how.
• FunctionScoreMode
  Each document is scored by the defined functions. The parameter score_mode specifies how the computed scores are combined
• Fuzziness
  Some queries and APIs support parameters to allow inexact fuzzy matching, using the fuzziness parameter.
• GeoBoundingBox
  Different representations of geo bounding box
• HasChildScoreMode
  Indicates how scores for matching child documents affect the root parent document’s relevance score.
• NestedQueryScoreMode
  Indicates how scores for matching child objects affect the root parent document’s relevance score.
• Operator
  Boolean logic used to interpret text in the query value
• PercolateSource
  Values that can be percolated
• PinnedQueryValues
  Ids or documents to filter by
• RangeRelation
  Indicates how the range query matches values for range fields.
• RegexpFlag
  You can use the flags parameter to enable more optional operators for Lucene’s regular expression engine.
• Rewrite
  Method used to rewrite the query.
• ScriptLang
  Available scripting language
• ScriptSource
  The script itself, which you specify as source for an inline script or id for a stored script. Use the stored script APIs to create and manage stored scripts.
• SimpleQueryStringQueryFlags
  You can use the flags parameter to enable more optional operators for Lucene’s regular expression engine.
• SpatialRelation
  Relation between coordinates
• StoredFields
  It’s also possible to store an individual field’s values by using the store mapping option.
• TermsSetMinimumShouldMatch
  Number of matching terms to be required
• TextQueryType
  The way the multi_match query is executed internally.
• ValidationMethod
  Strategies to verify the correctness of coordinates
• ZeroTermsQuery
  Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.