Run an async search Generally available; Added in 7.7.0

POST /{index}/_async_search

When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.

Path parameters

  • index string | array[string] Required

    A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

Query parameters

  • wait_for_completion_timeout string

    Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.

    Values are -1 or 0.

  • keep_alive string

    Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

    Values are -1 or 0.

  • keep_on_completion boolean

    If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout.

  • allow_no_indices boolean

    Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

  • allow_partial_search_results boolean

    Indicate if an error should be returned if there is a partial search failure or timeout

  • analyzer string

    The analyzer to use for the query string

  • analyze_wildcard boolean

    Specify whether wildcard and prefix queries should be analyzed (default: false)

  • batched_reduce_size number

    Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).

  • ccs_minimize_roundtrips boolean

    The default value is the only supported value.

  • default_operator string

    The default operator for query string query (AND or OR)

    Values are and, AND, or, or OR.

  • df string

    The field to use as default where no field prefix is given in the query string

  • docvalue_fields string | array[string]

    A comma-separated list of fields to return as the docvalue representation of a field for each hit

  • expand_wildcards string | array[string]

    Whether to expand wildcard expression to concrete indices that are open, closed or both.

    Values are all, open, closed, hidden, or none.

  • explain boolean

    Specify whether to return detailed information about score computation as part of a hit

  • ignore_throttled boolean

    Whether specified concrete, expanded or aliased indices should be ignored when throttled

  • ignore_unavailable boolean

    Whether specified concrete indices should be ignored when unavailable (missing or closed)

  • lenient boolean

    Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

  • max_concurrent_shard_requests number

    The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

  • preference string

    Specify the node or shard the operation should be performed on (default: random)

  • request_cache boolean

    Specify if request cache should be used for this request or not, defaults to true

  • routing string

    A comma-separated list of specific routing values

  • search_type string

    Search operation type

    Values are query_then_fetch or dfs_query_then_fetch.

  • stats array[string]

    Specific 'tag' of the request for logging and statistical purposes

  • stored_fields string | array[string]

    A comma-separated list of stored fields to return as part of a hit

  • suggest_field string

    Specifies which field to use for suggestions.

  • suggest_mode string

    Specify suggest mode

    Values are missing, popular, or always.

  • suggest_size number

    How many suggestions to return in response

  • suggest_text string

    The source text for which the suggestions should be returned.

  • terminate_after number

    The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

  • timeout string

    Explicit operation timeout

    Values are -1 or 0.

  • track_total_hits boolean | number

    Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.

  • track_scores boolean

    Whether to calculate and return scores even if they are not used for sorting

  • typed_keys boolean

    Specify whether aggregation and suggester names should be prefixed by their respective types in the response

  • rest_total_hits_as_int boolean

    Indicates whether hits.total should be rendered as an integer or an object in the rest search response

  • version boolean

    Specify whether to return document version as part of a hit

  • _source boolean | string | array[string]

    True or false to return the _source field or not, or a list of fields to return

  • _source_excludes string | array[string]

    A list of fields to exclude from the returned _source field

  • _source_includes string | array[string]

    A list of fields to extract and return from the _source field

  • seq_no_primary_term boolean

    Specify whether to return sequence number and primary term of the last modification of each hit

  • q string

    Query in the Lucene query string syntax

  • size number

    Number of hits to return (default: 10)

  • from number

    Starting offset (default: 0)

  • sort string | array[string]

    A comma-separated list of : pairs

application/json

Body

  • aggregations object
  • collapse object
    Hide collapse attributes Show collapse attributes object
    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • inner_hits object | array[object]

      The number of inner hits and their sort order

      One of:
      InnerHits object array-2 array[object]
      Hide attributes Show attributes object
      • name string
      • size number

        The maximum number of hits to return per inner_hits.

      • from number

        Inner hit starting document offset.

      • collapse object
      • docvalue_fields array[object]
        Hide docvalue_fields attributes Show docvalue_fields attributes object
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • format string

          The format in which the values are returned.

        • include_unmapped boolean
      • explain boolean
      • highlight object
        Hide highlight attributes Show highlight attributes object
        • type
        • boundary_chars string

          A string that contains each boundary character.

        • boundary_max_scan number

          How far to scan for boundary characters.

        • boundary_scanner string

          Values are chars, sentence, or word.

        • boundary_scanner_locale string

          Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

        • force_source boolean Deprecated
        • fragmenter string

          Values are simple or span.

        • fragment_size number

          The size of the highlighted fragment in characters.

        • highlight_filter boolean
        • highlight_query object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • max_fragment_length number
        • max_analyzed_offset number

          If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

        • no_match_size number

          The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

        • number_of_fragments number

          The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

        • options object
        • order string

          Value is score.

        • phrase_limit number

          Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

        • post_tags array[string]

          Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • pre_tags array[string]

          Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • require_field_match boolean

          By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

        • tags_schema string

          Value is styled.

        • encoder string

          Values are default or html.

        • fields
      • ignore_unmapped boolean
      • script_fields object
        Hide script_fields attribute Show script_fields attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • script object Required
          • ignore_failure boolean
      • seq_no_primary_term boolean
      • fields array[string]

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • sort string | object | array[string | object]

        One of:
        Field string SortOptions object Sort array[string | object]

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • _source boolean | object

        Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

        One of:
        SourceConfig boolean SourceFilter object
      • stored_fields string | array[string]
      • track_scores boolean
      • version boolean
    • max_concurrent_group_searches number

      The number of concurrent requests allowed to retrieve the inner_hits per group

    • collapse object
  • explain boolean

    If true, returns detailed information about score computation as part of a hit.

  • ext object

    Configuration of search extensions defined by Elasticsearch plugins.

    Hide ext attribute Show ext attribute object
    • * object Additional properties
  • from number

    Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

  • highlight object
    Hide highlight attributes Show highlight attributes object

    • type string

      Any of:
      HighlighterType string HighlighterType string

      Values are plain, fvh, or unified.

    • boundary_chars string

      A string that contains each boundary character.

    • boundary_max_scan number

      How far to scan for boundary characters.

    • boundary_scanner string

      Values are chars, sentence, or word.

    • boundary_scanner_locale string

      Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

    • force_source boolean Deprecated
    • fragmenter string

      Values are simple or span.

    • fragment_size number

      The size of the highlighted fragment in characters.

    • highlight_filter boolean
    • highlight_query object

      An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      External documentation
      Hide highlight_query attributes Show highlight_query attributes object
      • bool object
        Hide bool attributes Show bool attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string

        • filter object | array[object]

          The clause (query) must appear in matching documents. However, unlike must, the score of the query will be ignored.

          One of:
          QueryContainer object array-2 array[object]

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string

        • must object | array[object]

          The clause (query) must appear in matching documents and will contribute to the score.

          One of:
          QueryContainer object array-2 array[object]

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • must_not object | array[object]

          The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of 0 is returned for all documents.

          One of:
          QueryContainer object array-2 array[object]

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • should object | array[object]

          The clause (query) should appear in the matching document.

          One of:
          QueryContainer object array-2 array[object]

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • boosting object
        Hide boosting attributes Show boosting attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • negative_boost number Required

          Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

        • negative object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • positive object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • common object Deprecated
      • combined_fields object
        Hide combined_fields attributes Show combined_fields attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • fields array[string] Required

          List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.

        • query string Required

          Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.

        • auto_generate_synonyms_phrase_query boolean

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

        • operator string

          Values are or or and.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string
        • zero_terms_query string

          Values are none or all.

      • constant_score object
        Hide constant_score attributes Show constant_score attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • filter object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • dis_max object
        Hide dis_max attributes Show dis_max attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • queries array[object] Required

          One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • tie_breaker number

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

      • distance_feature object

        One of:
        UntypedDistanceFeatureQuery object GeoDistanceFeatureQuery object DateDistanceFeatureQuery object
      • exists object
        Hide exists attributes Show exists attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • function_score object
        Hide function_score attributes Show function_score attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • boost_mode string

          Values are multiply, replace, sum, avg, max, or min.

        • functions array[object]

          One or more functions that compute a new score for each document returned by the query.

        • max_boost number

          Restricts the new score to not exceed the provided limit.

        • min_score number

          Excludes documents that do not meet the provided score threshold.

        • query object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • score_mode string

          Values are multiply, sum, avg, first, max, or min.

      • fuzzy object

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

        External documentation
      • geo_bounding_box object
        Hide geo_bounding_box attributes Show geo_bounding_box attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • type string

          Values are memory or indexed.

        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • geo_distance object
        Hide geo_distance attributes Show geo_distance attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • distance string Required
        • distance_type string

          Values are arc or plane.

        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • geo_grid object

        Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

      • geo_polygon object
        Hide geo_polygon attributes Show geo_polygon attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean
      • geo_shape object
        Hide geo_shape attributes Show geo_shape attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • has_child object
        Hide has_child attributes Show has_child attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped type and not return any documents instead of an error.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object
          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • ignore_unmapped boolean
          • script_fields object
          • seq_no_primary_term boolean
          • fields array[string]

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • max_children number

          Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

        • min_children number

          Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

        • query object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • score_mode string

          Values are none, avg, sum, max, or min.

        • type string Required
      • has_parent object
        Hide has_parent attributes Show has_parent attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the parent_type.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object
          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • ignore_unmapped boolean
          • script_fields object
          • seq_no_primary_term boolean
          • fields array[string]

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • parent_type string Required
        • query object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • score boolean

          Indicates whether the relevance score of a matching parent document is aggregated into its child documents.

      • ids object
        Hide ids attributes Show ids attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string

        • values string | array[string]

          One of:
          Id string Ids array[string]
      • intervals object

        Returns documents based on the order and proximity of matching terms.

        External documentation
      • knn object
        Hide knn attributes Show knn attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query_vector array[number]
        • query_vector_builder object
          Hide query_vector_builder attribute Show query_vector_builder attribute object
          • text_embedding object
        • num_candidates number

          The number of nearest neighbor candidates to consider per shard

        • k number

          The final number of nearest neighbors to return as top hits

        • filter object | array[object]

          Filters for the kNN search query

          One of:
          QueryContainer object array-2 array[object]

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • similarity number

          The minimum similarity for a vector to be considered a match

        • rescore_vector object
          Hide rescore_vector attribute Show rescore_vector attribute object
          • oversample number Required

            Applies the specified oversample factor to k on the approximate kNN search

      • match object

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

        External documentation
      • match_all object
        Hide match_all attributes Show match_all attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
      • match_bool_prefix object

        Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

        External documentation
      • match_none object
        Hide match_none attributes Show match_none attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
      • match_phrase object

        Analyzes the text and creates a phrase query out of the analyzed text.

        External documentation
      • match_phrase_prefix object

        Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

        External documentation
      • more_like_this object
        Hide more_like_this attributes Show more_like_this attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • analyzer string

          The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.

          External documentation
        • boost_terms number

          Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).

        • fail_on_unsupported_field boolean

          Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword).

        • fields array[string]

          A list of fields to fetch and analyze the text from. Defaults to the index.query.default_field index setting, which has a default value of *.

        • include boolean

          Specifies whether the input documents should also be included in the search results returned.

        • like array[string | object] Required
        • max_doc_freq number

          The maximum document frequency above which the terms are ignored from the input document.

        • max_query_terms number

          The maximum number of query terms that can be selected.

        • max_word_length number

          The maximum word length above which the terms are ignored. Defaults to unbounded (0).

        • min_doc_freq number

          The minimum document frequency below which the terms are ignored from the input document.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string
        • min_term_freq number

          The minimum term frequency below which the terms are ignored from the input document.

        • min_word_length number

          The minimum word length below which the terms are ignored.

        • routing string

        • stop_words string | array[string]

          Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.

          One of:
          StopWordLanguage string StopWords array[string]

          Values are _arabic_, _armenian_, _basque_, _bengali_, _brazilian_, _bulgarian_, _catalan_, _cjk_, _czech_, _danish_, _dutch_, _english_, _estonian_, _finnish_, _french_, _galician_, _german_, _greek_, _hindi_, _hungarian_, _indonesian_, _irish_, _italian_, _latvian_, _lithuanian_, _norwegian_, _persian_, _portuguese_, _romanian_, _russian_, _serbian_, _sorani_, _spanish_, _swedish_, _thai_, _turkish_, or _none_.

        • unlike array[string | object]
        • version number
        • version_type string

          Values are internal, external, external_gte, or force.

      • multi_match object
        Hide multi_match attributes Show multi_match attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • analyzer string

          Analyzer used to convert the text in the query value into tokens.

        • auto_generate_synonyms_phrase_query boolean

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

        • cutoff_frequency number Deprecated
        • fields string | array[string]

        • fuzziness string | number

          One of:
          Fuzziness string Fuzziness number
        • fuzzy_rewrite string
        • fuzzy_transpositions boolean

          If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.

        • lenient boolean

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

        • max_expansions number

          Maximum number of terms to which the query will expand.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string
        • operator string

          Values are and, AND, or, or OR.

        • prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • query string Required

          Text, number, boolean value or date you wish to find in the provided field.

        • slop number

          Maximum number of positions allowed between matching tokens.

        • tie_breaker number

          Determines how scores for each per-term blended query and scores across groups are combined.

        • type string

          Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

        • zero_terms_query string

          Values are all or none.

      • nested object
        Hide nested attributes Show nested attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped path and not return any documents instead of an error.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object
          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • ignore_unmapped boolean
          • script_fields object
          • seq_no_primary_term boolean
          • fields array[string]

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • path string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • score_mode string

          Values are none, avg, sum, max, or min.

      • parent_id object
        Hide parent_id attributes Show parent_id attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • id string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped type and not return any documents instead of an error.

        • type string
      • percolate object
        Hide percolate attributes Show percolate attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • document object

          The source of the document being percolated.

        • documents array[object]

          An array of sources of the documents being percolated.

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • id string
        • index string
        • name string

          The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

        • preference string

          Preference used to fetch document to percolate.

        • routing string
        • version number
      • pinned object
        Hide pinned attributes Show pinned attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • organic object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • ids array[string]

          Document IDs listed in the order they are to appear in results. Required if docs is not specified.

        • docs array[object]

          Documents listed in the order they are to appear in results. Required if ids is not specified.

      • prefix object

        Returns documents that contain a specific prefix in a provided field.

        External documentation
      • query_string object
        Hide query_string attributes Show query_string attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • allow_leading_wildcard boolean

          If true, the wildcard characters * and ? are allowed as the first character of the query string.

        • analyzer string

          Analyzer used to convert text in the query string into tokens.

        • analyze_wildcard boolean

          If true, the query attempts to analyze wildcard terms in the query string.

        • auto_generate_synonyms_phrase_query boolean

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

        • default_field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • default_operator string

          Values are and, AND, or, or OR.

        • enable_position_increments boolean

          If true, enable position increments in queries constructed from a query_string search.

        • escape boolean
        • fields array[string]

          Array of fields to search. Supports wildcards (*).

        • fuzziness string | number

          One of:
          Fuzziness string Fuzziness number
        • fuzzy_max_expansions number

          Maximum number of terms to which the query expands for fuzzy matching.

        • fuzzy_prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • fuzzy_rewrite string
        • fuzzy_transpositions boolean

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

        • lenient boolean

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

        • max_determinized_states number

          Maximum number of automaton states required for the query.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string
        • phrase_slop number

          Maximum number of positions allowed between matching tokens for phrases.

        • query string Required

          Query string you wish to parse and use for search.

        • quote_analyzer string

          Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.

        • quote_field_suffix string

          Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.

        • rewrite string
        • tie_breaker number

          How to combine the queries generated from the individual search terms in the resulting dis_max query.

        • time_zone string
        • type string

          Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

      • range object

        Returns documents that contain terms within a provided range.

        External documentation
      • rank_feature object
        Hide rank_feature attributes Show rank_feature attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • saturation object
        • log object
        • linear object
        • sigmoid object
      • regexp object

        Returns documents that contain terms matching a regular expression.

        External documentation
      • rule object
        Hide rule attributes Show rule attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • organic object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • ruleset_ids string | array[string]

          One of:
          Id string array-2 array[string]
        • ruleset_id string
        • match_criteria object Required
      • script object
        Hide script attributes Show script attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • script object Required
          Hide script attributes Show script attributes object
          • source
          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
      • script_score object
        Hide script_score attributes Show script_score attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • min_score number

          Documents with a score lower than this floating point number are excluded from the search results.

        • query object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • script object Required
          Hide script attributes Show script attributes object
          • source
          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
      • semantic object
        Hide semantic attributes Show semantic attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          The field to query, which must be a semantic_text field type

        • query string Required

          The query text

      • shape object
        Hide shape attributes Show shape attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • ignore_unmapped boolean

          When set to true the query ignores an unmapped field and will not match any documents.

      • simple_query_string object
        Hide simple_query_string attributes Show simple_query_string attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • analyzer string

          Analyzer used to convert text in the query string into tokens.

        • analyze_wildcard boolean

          If true, the query attempts to analyze wildcard terms in the query string.

        • auto_generate_synonyms_phrase_query boolean

          If true, the parser creates a match_phrase query for each multi-position token.

        • default_operator string

          Values are and, AND, or, or OR.

        • fields array[string]

          Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

        • flags
        • fuzzy_max_expansions number

          Maximum number of terms to which the query expands for fuzzy matching.

        • fuzzy_prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • fuzzy_transpositions boolean

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

        • lenient boolean

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

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:
          MinimumShouldMatch number MinimumShouldMatch string
        • query string Required

          Query string in the simple query string syntax you wish to parse and use for search.

        • quote_field_suffix string

          Suffix appended to quoted text in the query string.

      • span_containing object
        Hide span_containing attributes Show span_containing attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • big object Required
          Hide big attributes Show big attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

        • little object Required
          Hide little attributes Show little attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

      • span_field_masking object
        Hide span_field_masking attributes Show span_field_masking attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query object Required
          Hide query attributes Show query attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

      • span_first object
        Hide span_first attributes Show span_first attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • end number Required

          Controls the maximum end position permitted in a match.

        • match object Required
          Hide match attributes Show match attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

      • span_multi object
        Hide span_multi attributes Show span_multi attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • match object Required

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • span_near object
        Hide span_near attributes Show span_near attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • clauses array[object] Required

          Array of one or more other span type queries.

        • in_order boolean

          Controls whether matches are required to be in-order.

        • slop number

          Controls the maximum number of intervening unmatched positions permitted.

      • span_not object
        Hide span_not attributes Show span_not attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • dist number

          The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

        • exclude object Required
          Hide exclude attributes Show exclude attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

        • include object Required
          Hide include attributes Show include attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

        • post number

          The number of tokens after the include span that can’t have overlap with the exclude span.

        • pre number

          The number of tokens before the include span that can’t have overlap with the exclude span.

      • span_or object
        Hide span_or attributes Show span_or attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • clauses array[object] Required

          Array of one or more other span type queries.

      • span_term object

        Matches spans containing a term.

        External documentation
      • span_within object
        Hide span_within attributes Show span_within attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • big object Required
          Hide big attributes Show big attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

        • little object Required
          Hide little attributes Show little attributes object
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_term object

            The equivalent of the term query but for use with other span queries.

      • sparse_vector object
        Hide sparse_vector attributes Show sparse_vector attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query string

          The query text you want to use for search. If inference_id is specified, query must also be specified.

        • prune boolean Technical preview; Added in 8.15.0

          Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false

        • pruning_config object
        • query_vector object

          Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.

        • inference_id string
      • term object

        Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

        External documentation
      • terms object
        Hide terms attributes Show terms attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
      • terms_set object

        Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

        External documentation
      • text_expansion object Deprecated Generally available; Added in 8.8.0

        Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

        External documentation
      • weighted_tokens object Deprecated Generally available; Added in 8.13.0

        Supports returning text_expansion query results by sending in precomputed tokens with the query.

        External documentation
      • wildcard object

        Returns documents that contain terms matching a wildcard pattern.

        External documentation
      • wrapper object
        Hide wrapper attributes Show wrapper attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • query string Required

          A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings

      • type object
        Hide type attributes Show type attributes object
        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. 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.

        • _name string
        • value string Required
    • max_fragment_length number
    • max_analyzed_offset number

      If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

    • no_match_size number

      The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

    • number_of_fragments number

      The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

    • options object
      Hide options attribute Show options attribute object
      • * object Additional properties
    • order string

      Value is score.

    • phrase_limit number

      Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

    • post_tags array[string]

      Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

    • pre_tags array[string]

      Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

    • require_field_match boolean

      By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

    • tags_schema string

      Value is styled.

    • encoder string

      Values are default or html.

    • fields object | array[object] Required

      One of:
      object-1 object array-2 array[object]
  • track_total_hits boolean | number

    Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

  • indices_boost array[object]

    Boosts the _score of documents from specified indices.

    Hide indices_boost attribute Show indices_boost attribute object
    • * number Additional properties
  • docvalue_fields array[object]

    Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

    Hide docvalue_fields attributes Show docvalue_fields attributes object
    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • format string

      The format in which the values are returned.

    • include_unmapped boolean

  • knn object | array[object]

    Defines the approximate kNN search to run.

    One of:
    KnnSearch object array-2 array[object]
    Hide attributes Show attributes object
    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • query_vector array[number]
    • query_vector_builder object
      Hide query_vector_builder attribute Show query_vector_builder attribute object
      • text_embedding object
        Hide text_embedding attributes Show text_embedding attributes object
        • model_id string Required
        • model_text string Required
    • k number

      The final number of nearest neighbors to return as top hits

    • num_candidates number

      The number of nearest neighbor candidates to consider per shard

    • boost number

      Boost value to apply to kNN scores

    • filter object | array[object]

      Filters for the kNN search query

      One of:
      QueryContainer object array-2 array[object]

      An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      Hide attributes Show attributes object
      External documentation
      • bool
      • boosting
      • common object Deprecated
      • combined_fields
      • constant_score
      • dis_max
      • distance_feature
      • exists
      • function_score
      • fuzzy object

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

      • geo_bounding_box
      • geo_distance
      • geo_grid object

        Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

      • geo_polygon
      • geo_shape
      • has_child
      • has_parent
      • ids
      • intervals object

        Returns documents based on the order and proximity of matching terms.

      • knn
      • match object

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

      • match_all
      • match_bool_prefix object

        Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

      • match_none
      • match_phrase object

        Analyzes the text and creates a phrase query out of the analyzed text.

      • match_phrase_prefix object

        Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

      • more_like_this
      • multi_match
      • nested
      • parent_id
      • percolate
      • pinned
      • prefix object

        Returns documents that contain a specific prefix in a provided field.

      • query_string
      • range object

        Returns documents that contain terms within a provided range.

      • rank_feature
      • regexp object

        Returns documents that contain terms matching a regular expression.

      • rule
      • script
      • script_score
      • semantic
      • shape
      • simple_query_string
      • span_containing
      • span_field_masking
      • span_first
      • span_multi
      • span_near
      • span_not
      • span_or
      • span_term object

        Matches spans containing a term.

      • span_within
      • sparse_vector
      • term object

        Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

      • terms
      • terms_set object

        Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

      • text_expansion object Deprecated Generally available; Added in 8.8.0

        Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

      • weighted_tokens object Deprecated Generally available; Added in 8.13.0

        Supports returning text_expansion query results by sending in precomputed tokens with the query.

      • wildcard object

        Returns documents that contain terms matching a wildcard pattern.

      • wrapper
      • type
    • similarity number

      The minimum similarity for a vector to be considered a match

    • inner_hits object
      Hide inner_hits attributes Show inner_hits attributes object
      • name string
      • size number

        The maximum number of hits to return per inner_hits.

      • from number

        Inner hit starting document offset.

      • collapse object
        Hide collapse attributes Show collapse attributes object
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • inner_hits object | array[object]

          The number of inner hits and their sort order

          One of:
          InnerHits object array-2 array[object]
        • max_concurrent_group_searches number

          The number of concurrent requests allowed to retrieve the inner_hits per group

        • collapse object
      • docvalue_fields array[object]
        Hide docvalue_fields attributes Show docvalue_fields attributes object
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • format string

          The format in which the values are returned.

        • include_unmapped boolean
      • explain boolean
      • highlight object
        Hide highlight attributes Show highlight attributes object
        • type
        • boundary_chars string

          A string that contains each boundary character.

        • boundary_max_scan number

          How far to scan for boundary characters.

        • boundary_scanner string

          Values are chars, sentence, or word.

        • boundary_scanner_locale string

          Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

        • force_source boolean Deprecated
        • fragmenter string

          Values are simple or span.

        • fragment_size number

          The size of the highlighted fragment in characters.

        • highlight_filter boolean
        • highlight_query object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • max_fragment_length number
        • max_analyzed_offset number

          If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

        • no_match_size number

          The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

        • number_of_fragments number

          The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

        • options object
        • order string

          Value is score.

        • phrase_limit number

          Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

        • post_tags array[string]

          Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • pre_tags array[string]

          Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • require_field_match boolean

          By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

        • tags_schema string

          Value is styled.

        • encoder string

          Values are default or html.

        • fields
      • ignore_unmapped boolean
      • script_fields object
        Hide script_fields attribute Show script_fields attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • script object Required
          • ignore_failure boolean
      • seq_no_primary_term boolean
      • fields array[string]

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • sort string | object | array[string | object]

        One of:
        Field string SortOptions object Sort array[string | object]

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • _source boolean | object

        Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

        One of:
        SourceConfig boolean SourceFilter object
      • stored_fields string | array[string]
      • track_scores boolean
      • version boolean
    • rescore_vector object
      Hide rescore_vector attribute Show rescore_vector attribute object
      • oversample number Required

        Applies the specified oversample factor to k on the approximate kNN search

  • min_score number

    Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.

  • post_filter object

    An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    External documentation
    Hide post_filter attributes Show post_filter attributes object
    • bool object
      Hide bool attributes Show bool attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string

      • filter object | array[object]

        The clause (query) must appear in matching documents. However, unlike must, the score of the query will be ignored.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string

      • must object | array[object]

        The clause (query) must appear in matching documents and will contribute to the score.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • must_not object | array[object]

        The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of 0 is returned for all documents.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • should object | array[object]

        The clause (query) should appear in the matching document.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • boosting object
      Hide boosting attributes Show boosting attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • negative_boost number Required

        Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

      • negative object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • positive object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • common object Deprecated
    • combined_fields object
      Hide combined_fields attributes Show combined_fields attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • fields array[string] Required

        List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.

      • query string Required

        Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.

      • auto_generate_synonyms_phrase_query boolean

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

      • operator string

        Values are or or and.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • zero_terms_query string

        Values are none or all.

    • constant_score object
      Hide constant_score attributes Show constant_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • filter object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • dis_max object
      Hide dis_max attributes Show dis_max attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • queries array[object] Required

        One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • tie_breaker number

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

    • distance_feature object

      One of:
      DistanceFeatureQueryBase object DistanceFeatureQueryBaseGeoLocationDistance object DistanceFeatureQueryBaseDateMathDuration object
    • exists object
      Hide exists attributes Show exists attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • function_score object
      Hide function_score attributes Show function_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • boost_mode string

        Values are multiply, replace, sum, avg, max, or min.

      • functions array[object]

        One or more functions that compute a new score for each document returned by the query.

        Hide functions attributes Show functions attributes object
        • filter object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • weight number
        • exp
        • gauss
        • linear
        • field_value_factor object
        • random_score object
        • script_score object
      • max_boost number

        Restricts the new score to not exceed the provided limit.

      • min_score number

        Excludes documents that do not meet the provided score threshold.

      • query object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are multiply, sum, avg, first, max, or min.

    • fuzzy object

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

      External documentation
    • geo_bounding_box object
      Hide geo_bounding_box attributes Show geo_bounding_box attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • type string

        Values are memory or indexed.

      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • geo_distance object
      Hide geo_distance attributes Show geo_distance attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • distance string Required
      • distance_type string

        Values are arc or plane.

      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • geo_grid object

      Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

    • geo_polygon object
      Hide geo_polygon attributes Show geo_polygon attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean
    • geo_shape object
      Hide geo_shape attributes Show geo_shape attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • has_child object
      Hide has_child attributes Show has_child attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped type and not return any documents instead of an error.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • max_children number

        Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

      • min_children number

        Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are none, avg, sum, max, or min.

      • type string Required
    • has_parent object
      Hide has_parent attributes Show has_parent attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the parent_type.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • parent_type string Required
      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score boolean

        Indicates whether the relevance score of a matching parent document is aggregated into its child documents.

    • ids object
      Hide ids attributes Show ids attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string

      • values string | array[string]

        One of:
        Id string Ids array[string]
    • intervals object

      Returns documents based on the order and proximity of matching terms.

      External documentation
    • knn object
      Hide knn attributes Show knn attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query_vector array[number]
      • query_vector_builder object
        Hide query_vector_builder attribute Show query_vector_builder attribute object
        • text_embedding object
          Hide text_embedding attributes Show text_embedding attributes object
          • model_id string Required
          • model_text string Required
      • num_candidates number

        The number of nearest neighbor candidates to consider per shard

      • k number

        The final number of nearest neighbors to return as top hits

      • filter object | array[object]

        Filters for the kNN search query

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • similarity number

        The minimum similarity for a vector to be considered a match

      • rescore_vector object
        Hide rescore_vector attribute Show rescore_vector attribute object
        • oversample number Required

          Applies the specified oversample factor to k on the approximate kNN search

    • match object

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

      External documentation
    • match_all object
      Hide match_all attributes Show match_all attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • match_bool_prefix object

      Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

      External documentation
    • match_none object
      Hide match_none attributes Show match_none attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • match_phrase object

      Analyzes the text and creates a phrase query out of the analyzed text.

      External documentation
    • match_phrase_prefix object

      Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

      External documentation
    • more_like_this object
      Hide more_like_this attributes Show more_like_this attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.

        External documentation
      • boost_terms number

        Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).

      • fail_on_unsupported_field boolean

        Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword).

      • fields array[string]

        A list of fields to fetch and analyze the text from. Defaults to the index.query.default_field index setting, which has a default value of *.

      • include boolean

        Specifies whether the input documents should also be included in the search results returned.

      • like string | object | array[string | object]

        Specifies free form text and/or a single or multiple documents for which you want to find similar documents.

        One of:
        Like string LikeDocument object array-2 array[string | object]

        Text that we want similar documents for or a lookup to a document's field for the text.

        Text that we want similar documents for or a lookup to a document's field for the text.

        One of:
        Like string LikeDocument object
      • max_doc_freq number

        The maximum document frequency above which the terms are ignored from the input document.

      • max_query_terms number

        The maximum number of query terms that can be selected.

      • max_word_length number

        The maximum word length above which the terms are ignored. Defaults to unbounded (0).

      • min_doc_freq number

        The minimum document frequency below which the terms are ignored from the input document.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • min_term_freq number

        The minimum term frequency below which the terms are ignored from the input document.

      • min_word_length number

        The minimum word length below which the terms are ignored.

      • routing string

      • stop_words string | array[string]

        Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.

        One of:
        StopWordLanguage string StopWords array[string]

        Values are _arabic_, _armenian_, _basque_, _bengali_, _brazilian_, _bulgarian_, _catalan_, _cjk_, _czech_, _danish_, _dutch_, _english_, _estonian_, _finnish_, _french_, _galician_, _german_, _greek_, _hindi_, _hungarian_, _indonesian_, _irish_, _italian_, _latvian_, _lithuanian_, _norwegian_, _persian_, _portuguese_, _romanian_, _russian_, _serbian_, _sorani_, _spanish_, _swedish_, _thai_, _turkish_, or _none_.

      • unlike string | object | array[string | object]

        Used in combination with like to exclude documents that match a set of terms.

        One of:
        Like string LikeDocument object array-2 array[string | object]

        Text that we want similar documents for or a lookup to a document's field for the text.

        Text that we want similar documents for or a lookup to a document's field for the text.

        One of:
        Like string LikeDocument object
      • version number
      • version_type string

        Values are internal, external, external_gte, or force.

    • multi_match object
      Hide multi_match attributes Show multi_match attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        Analyzer used to convert the text in the query value into tokens.

      • auto_generate_synonyms_phrase_query boolean

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

      • cutoff_frequency number Deprecated
      • fields string | array[string]

      • fuzziness string | number

        One of:
        Fuzziness string Fuzziness number
      • fuzzy_rewrite string
      • fuzzy_transpositions boolean

        If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.

      • lenient boolean

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

      • max_expansions number

        Maximum number of terms to which the query will expand.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • operator string

        Values are and, AND, or, or OR.

      • prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • query string Required

        Text, number, boolean value or date you wish to find in the provided field.

      • slop number

        Maximum number of positions allowed between matching tokens.

      • tie_breaker number

        Determines how scores for each per-term blended query and scores across groups are combined.

      • type string

        Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

      • zero_terms_query string

        Values are all or none.

    • nested object
      Hide nested attributes Show nested attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped path and not return any documents instead of an error.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • path string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are none, avg, sum, max, or min.

    • parent_id object
      Hide parent_id attributes Show parent_id attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • id string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped type and not return any documents instead of an error.

      • type string
    • percolate object
      Hide percolate attributes Show percolate attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • document object

        The source of the document being percolated.

      • documents array[object]

        An array of sources of the documents being percolated.

      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • id string
      • index string
      • name string

        The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

      • preference string

        Preference used to fetch document to percolate.

      • routing string
      • version number
    • pinned object
      Hide pinned attributes Show pinned attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • organic object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • ids array[string]

        Document IDs listed in the order they are to appear in results. Required if docs is not specified.

      • docs array[object]

        Documents listed in the order they are to appear in results. Required if ids is not specified.

        Hide docs attributes Show docs attributes object
        • _id string Required
        • _index string
    • prefix object

      Returns documents that contain a specific prefix in a provided field.

      External documentation
    • query_string object
      Hide query_string attributes Show query_string attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • allow_leading_wildcard boolean

        If true, the wildcard characters * and ? are allowed as the first character of the query string.

      • analyzer string

        Analyzer used to convert text in the query string into tokens.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms in the query string.

      • auto_generate_synonyms_phrase_query boolean

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

      • default_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • default_operator string

        Values are and, AND, or, or OR.

      • enable_position_increments boolean

        If true, enable position increments in queries constructed from a query_string search.

      • escape boolean
      • fields array[string]

        Array of fields to search. Supports wildcards (*).

      • fuzziness string | number

        One of:
        Fuzziness string Fuzziness number
      • fuzzy_max_expansions number

        Maximum number of terms to which the query expands for fuzzy matching.

      • fuzzy_prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • fuzzy_rewrite string
      • fuzzy_transpositions boolean

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

      • lenient boolean

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

      • max_determinized_states number

        Maximum number of automaton states required for the query.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • phrase_slop number

        Maximum number of positions allowed between matching tokens for phrases.

      • query string Required

        Query string you wish to parse and use for search.

      • quote_analyzer string

        Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.

      • rewrite string
      • tie_breaker number

        How to combine the queries generated from the individual search terms in the resulting dis_max query.

      • time_zone string
      • type string

        Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

    • range object

      Returns documents that contain terms within a provided range.

      External documentation
    • rank_feature object
      Hide rank_feature attributes Show rank_feature attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • saturation object
        Hide saturation attribute Show saturation attribute object
        • pivot number

          Configurable pivot value so that the result will be less than 0.5.

      • log object
        Hide log attribute Show log attribute object
        • scaling_factor number Required

          Configurable scaling factor.

      • linear object
      • sigmoid object
        Hide sigmoid attributes Show sigmoid attributes object
        • pivot number Required

          Configurable pivot value so that the result will be less than 0.5.

        • exponent number Required

          Configurable Exponent.

    • regexp object

      Returns documents that contain terms matching a regular expression.

      External documentation
    • rule object
      Hide rule attributes Show rule attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • organic object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • ruleset_ids string | array[string]

        One of:
        Id string array-2 array[string]
      • ruleset_id string
      • match_criteria object Required
    • script object
      Hide script attributes Show script attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • script object Required
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
    • script_score object
      Hide script_score attributes Show script_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • min_score number

        Documents with a score lower than this floating point number are excluded from the search results.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • script object Required
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
    • semantic object
      Hide semantic attributes Show semantic attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        The field to query, which must be a semantic_text field type

      • query string Required

        The query text

    • shape object
      Hide shape attributes Show shape attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        When set to true the query ignores an unmapped field and will not match any documents.

    • simple_query_string object
      Hide simple_query_string attributes Show simple_query_string attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        Analyzer used to convert text in the query string into tokens.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms in the query string.

      • auto_generate_synonyms_phrase_query boolean

        If true, the parser creates a match_phrase query for each multi-position token.

      • default_operator string

        Values are and, AND, or, or OR.

      • fields array[string]

        Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

      • flags string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        One of:
        SimpleQueryStringFlag string PipeSeparatedFlagsSimpleQueryStringFlag string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        Values are NONE, AND, NOT, OR, PREFIX, PHRASE, PRECEDENCE, ESCAPE, WHITESPACE, FUZZY, NEAR, SLOP, or ALL.

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

      • fuzzy_max_expansions number

        Maximum number of terms to which the query expands for fuzzy matching.

      • fuzzy_prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • fuzzy_transpositions boolean

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

      • lenient boolean

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

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • query string Required

        Query string in the simple query string syntax you wish to parse and use for search.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string.

    • span_containing object
      Hide span_containing attributes Show span_containing attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • big object Required
        Hide big attributes Show big attributes object
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • little object Required
        Hide little attributes Show little attributes object
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_field_masking object
      Hide span_field_masking attributes Show span_field_masking attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query object Required
        Hide query attributes Show query attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_first object
      Hide span_first attributes Show span_first attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • end number Required

        Controls the maximum end position permitted in a match.

      • match object Required
        Hide match attributes Show match attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_multi object
      Hide span_multi attributes Show span_multi attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • match object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • span_near object
      Hide span_near attributes Show span_near attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • clauses array[object] Required

        Array of one or more other span type queries.

        Hide clauses attributes Show clauses attributes object
        • span_containing object
        • span_field_masking object
        • span_first object
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
        • span_near
        • span_not object
        • span_or object
        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
      • in_order boolean

        Controls whether matches are required to be in-order.

      • slop number

        Controls the maximum number of intervening unmatched positions permitted.

    • span_not object
      Hide span_not attributes Show span_not attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • dist number

        The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

      • exclude object Required
        Hide exclude attributes Show exclude attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • include object Required
        Hide include attributes Show include attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • post number

        The number of tokens after the include span that can’t have overlap with the exclude span.

      • pre number

        The number of tokens before the include span that can’t have overlap with the exclude span.

    • span_or object
      Hide span_or attributes Show span_or attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • clauses array[object] Required

        Array of one or more other span type queries.

        Hide clauses attributes Show clauses attributes object
        • span_containing object
        • span_field_masking object
        • span_first object
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
        • span_near object
        • span_not object
        • span_or
        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
    • span_term object

      Matches spans containing a term.

      External documentation
    • span_within object
      Hide span_within attributes Show span_within attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • big object Required
        Hide big attributes Show big attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

      • little object Required
        Hide little attributes Show little attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

    • sparse_vector object
      Hide sparse_vector attributes Show sparse_vector attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query string

        The query text you want to use for search. If inference_id is specified, query must also be specified.

      • prune boolean Technical preview; Added in 8.15.0

        Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false

      • pruning_config object
        Hide pruning_config attributes Show pruning_config attributes object
        • tokens_freq_ratio_threshold number

          Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.

        • tokens_weight_threshold number

          Tokens whose weight is less than this threshold are considered nonsignificant and pruned.

        • only_score_pruned_tokens boolean

          Whether to only score pruned tokens, vs only scoring kept tokens.

      • query_vector object

        Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.

        Hide query_vector attribute Show query_vector attribute object
        • * number Additional properties
      • inference_id string
    • term object

      Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

      External documentation
    • terms object
      Hide terms attributes Show terms attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • terms_set object

      Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

      External documentation
    • text_expansion object Deprecated Generally available; Added in 8.8.0

      Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

      External documentation
    • weighted_tokens object Deprecated Generally available; Added in 8.13.0

      Supports returning text_expansion query results by sending in precomputed tokens with the query.

      External documentation
    • wildcard object

      Returns documents that contain terms matching a wildcard pattern.

      External documentation
    • wrapper object
      Hide wrapper attributes Show wrapper attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • query string Required

        A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings

    • type object
      Hide type attributes Show type attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • value string Required
  • profile boolean
  • query object

    An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    External documentation
    Hide query attributes Show query attributes object
    • bool object
      Hide bool attributes Show bool attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string

      • filter object | array[object]

        The clause (query) must appear in matching documents. However, unlike must, the score of the query will be ignored.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string

      • must object | array[object]

        The clause (query) must appear in matching documents and will contribute to the score.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • must_not object | array[object]

        The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of 0 is returned for all documents.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • should object | array[object]

        The clause (query) should appear in the matching document.

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • boosting object
      Hide boosting attributes Show boosting attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • negative_boost number Required

        Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

      • negative object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • positive object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • common object Deprecated
    • combined_fields object
      Hide combined_fields attributes Show combined_fields attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • fields array[string] Required

        List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.

      • query string Required

        Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.

      • auto_generate_synonyms_phrase_query boolean

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

      • operator string

        Values are or or and.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • zero_terms_query string

        Values are none or all.

    • constant_score object
      Hide constant_score attributes Show constant_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • filter object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • dis_max object
      Hide dis_max attributes Show dis_max attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • queries array[object] Required

        One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • tie_breaker number

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

    • distance_feature object

      One of:
      DistanceFeatureQueryBase object DistanceFeatureQueryBaseGeoLocationDistance object DistanceFeatureQueryBaseDateMathDuration object
    • exists object
      Hide exists attributes Show exists attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • function_score object
      Hide function_score attributes Show function_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • boost_mode string

        Values are multiply, replace, sum, avg, max, or min.

      • functions array[object]

        One or more functions that compute a new score for each document returned by the query.

        Hide functions attributes Show functions attributes object
        • filter object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • weight number
        • exp
        • gauss
        • linear
        • field_value_factor object
        • random_score object
        • script_score object
      • max_boost number

        Restricts the new score to not exceed the provided limit.

      • min_score number

        Excludes documents that do not meet the provided score threshold.

      • query object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are multiply, sum, avg, first, max, or min.

    • fuzzy object

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

      External documentation
    • geo_bounding_box object
      Hide geo_bounding_box attributes Show geo_bounding_box attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • type string

        Values are memory or indexed.

      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • geo_distance object
      Hide geo_distance attributes Show geo_distance attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • distance string Required
      • distance_type string

        Values are arc or plane.

      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • geo_grid object

      Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

    • geo_polygon object
      Hide geo_polygon attributes Show geo_polygon attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • validation_method string

        Values are coerce, ignore_malformed, or strict.

      • ignore_unmapped boolean
    • geo_shape object
      Hide geo_shape attributes Show geo_shape attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

    • has_child object
      Hide has_child attributes Show has_child attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped type and not return any documents instead of an error.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • max_children number

        Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

      • min_children number

        Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are none, avg, sum, max, or min.

      • type string Required
    • has_parent object
      Hide has_parent attributes Show has_parent attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the parent_type.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • parent_type string Required
      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score boolean

        Indicates whether the relevance score of a matching parent document is aggregated into its child documents.

    • ids object
      Hide ids attributes Show ids attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string

      • values string | array[string]

        One of:
        Id string Ids array[string]
    • intervals object

      Returns documents based on the order and proximity of matching terms.

      External documentation
    • knn object
      Hide knn attributes Show knn attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query_vector array[number]
      • query_vector_builder object
        Hide query_vector_builder attribute Show query_vector_builder attribute object
        • text_embedding object
          Hide text_embedding attributes Show text_embedding attributes object
          • model_id string Required
          • model_text string Required
      • num_candidates number

        The number of nearest neighbor candidates to consider per shard

      • k number

        The final number of nearest neighbors to return as top hits

      • filter object | array[object]

        Filters for the kNN search query

        One of:
        QueryContainer object array-2 array[object]

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • similarity number

        The minimum similarity for a vector to be considered a match

      • rescore_vector object
        Hide rescore_vector attribute Show rescore_vector attribute object
        • oversample number Required

          Applies the specified oversample factor to k on the approximate kNN search

    • match object

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

      External documentation
    • match_all object
      Hide match_all attributes Show match_all attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • match_bool_prefix object

      Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

      External documentation
    • match_none object
      Hide match_none attributes Show match_none attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • match_phrase object

      Analyzes the text and creates a phrase query out of the analyzed text.

      External documentation
    • match_phrase_prefix object

      Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

      External documentation
    • more_like_this object
      Hide more_like_this attributes Show more_like_this attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.

        External documentation
      • boost_terms number

        Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).

      • fail_on_unsupported_field boolean

        Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword).

      • fields array[string]

        A list of fields to fetch and analyze the text from. Defaults to the index.query.default_field index setting, which has a default value of *.

      • include boolean

        Specifies whether the input documents should also be included in the search results returned.

      • like string | object | array[string | object]

        Specifies free form text and/or a single or multiple documents for which you want to find similar documents.

        One of:
        Like string LikeDocument object array-2 array[string | object]

        Text that we want similar documents for or a lookup to a document's field for the text.

        Text that we want similar documents for or a lookup to a document's field for the text.

        One of:
        Like string LikeDocument object
      • max_doc_freq number

        The maximum document frequency above which the terms are ignored from the input document.

      • max_query_terms number

        The maximum number of query terms that can be selected.

      • max_word_length number

        The maximum word length above which the terms are ignored. Defaults to unbounded (0).

      • min_doc_freq number

        The minimum document frequency below which the terms are ignored from the input document.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • min_term_freq number

        The minimum term frequency below which the terms are ignored from the input document.

      • min_word_length number

        The minimum word length below which the terms are ignored.

      • routing string

      • stop_words string | array[string]

        Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.

        One of:
        StopWordLanguage string StopWords array[string]

        Values are _arabic_, _armenian_, _basque_, _bengali_, _brazilian_, _bulgarian_, _catalan_, _cjk_, _czech_, _danish_, _dutch_, _english_, _estonian_, _finnish_, _french_, _galician_, _german_, _greek_, _hindi_, _hungarian_, _indonesian_, _irish_, _italian_, _latvian_, _lithuanian_, _norwegian_, _persian_, _portuguese_, _romanian_, _russian_, _serbian_, _sorani_, _spanish_, _swedish_, _thai_, _turkish_, or _none_.

      • unlike string | object | array[string | object]

        Used in combination with like to exclude documents that match a set of terms.

        One of:
        Like string LikeDocument object array-2 array[string | object]

        Text that we want similar documents for or a lookup to a document's field for the text.

        Text that we want similar documents for or a lookup to a document's field for the text.

        One of:
        Like string LikeDocument object
      • version number
      • version_type string

        Values are internal, external, external_gte, or force.

    • multi_match object
      Hide multi_match attributes Show multi_match attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        Analyzer used to convert the text in the query value into tokens.

      • auto_generate_synonyms_phrase_query boolean

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

      • cutoff_frequency number Deprecated
      • fields string | array[string]

      • fuzziness string | number

        One of:
        Fuzziness string Fuzziness number
      • fuzzy_rewrite string
      • fuzzy_transpositions boolean

        If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.

      • lenient boolean

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

      • max_expansions number

        Maximum number of terms to which the query will expand.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • operator string

        Values are and, AND, or, or OR.

      • prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • query string Required

        Text, number, boolean value or date you wish to find in the provided field.

      • slop number

        Maximum number of positions allowed between matching tokens.

      • tie_breaker number

        Determines how scores for each per-term blended query and scores across groups are combined.

      • type string

        Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

      • zero_terms_query string

        Values are all or none.

    • nested object
      Hide nested attributes Show nested attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped path and not return any documents instead of an error.

      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object
        • name string
        • size number

          The maximum number of hits to return per inner_hits.

        • from number

          Inner hit starting document offset.

        • collapse object
          Hide collapse attributes Show collapse attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • inner_hits object | array[object]

            The number of inner hits and their sort order

            One of:
            InnerHits object array-2 array[object]
          • max_concurrent_group_searches number

            The number of concurrent requests allowed to retrieve the inner_hits per group

          • collapse object
        • docvalue_fields array[object]
          Hide docvalue_fields attributes Show docvalue_fields attributes object
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • format string

            The format in which the values are returned.

          • include_unmapped boolean
        • explain boolean
        • highlight object
          Hide highlight attributes Show highlight attributes object
          • type
          • boundary_chars string

            A string that contains each boundary character.

          • boundary_max_scan number

            How far to scan for boundary characters.

          • boundary_scanner string

            Values are chars, sentence, or word.

          • boundary_scanner_locale string

            Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

          • force_source boolean Deprecated
          • fragmenter string

            Values are simple or span.

          • fragment_size number

            The size of the highlighted fragment in characters.

          • highlight_filter boolean
          • highlight_query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • max_fragment_length number
          • max_analyzed_offset number

            If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

          • no_match_size number

            The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

          • number_of_fragments number

            The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

          • options object
          • order string

            Value is score.

          • phrase_limit number

            Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

          • post_tags array[string]

            Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • pre_tags array[string]

            Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

          • require_field_match boolean

            By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

          • tags_schema string

            Value is styled.

          • encoder string

            Values are default or html.

          • fields
        • ignore_unmapped boolean
        • script_fields object
          Hide script_fields attribute Show script_fields attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • script object Required
            • ignore_failure boolean
        • seq_no_primary_term boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • sort string | object | array[string | object]

          One of:
          Field string SortOptions object Sort array[string | object]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • _source boolean | object

          Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

          One of:
          SourceConfig boolean SourceFilter object
        • stored_fields string | array[string]
        • track_scores boolean
        • version boolean
      • path string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • score_mode string

        Values are none, avg, sum, max, or min.

    • parent_id object
      Hide parent_id attributes Show parent_id attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • id string
      • ignore_unmapped boolean

        Indicates whether to ignore an unmapped type and not return any documents instead of an error.

      • type string
    • percolate object
      Hide percolate attributes Show percolate attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • document object

        The source of the document being percolated.

      • documents array[object]

        An array of sources of the documents being percolated.

      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • id string
      • index string
      • name string

        The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

      • preference string

        Preference used to fetch document to percolate.

      • routing string
      • version number
    • pinned object
      Hide pinned attributes Show pinned attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • organic object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • ids array[string]

        Document IDs listed in the order they are to appear in results. Required if docs is not specified.

      • docs array[object]

        Documents listed in the order they are to appear in results. Required if ids is not specified.

        Hide docs attributes Show docs attributes object
        • _id string Required
        • _index string
    • prefix object

      Returns documents that contain a specific prefix in a provided field.

      External documentation
    • query_string object
      Hide query_string attributes Show query_string attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • allow_leading_wildcard boolean

        If true, the wildcard characters * and ? are allowed as the first character of the query string.

      • analyzer string

        Analyzer used to convert text in the query string into tokens.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms in the query string.

      • auto_generate_synonyms_phrase_query boolean

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

      • default_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • default_operator string

        Values are and, AND, or, or OR.

      • enable_position_increments boolean

        If true, enable position increments in queries constructed from a query_string search.

      • escape boolean
      • fields array[string]

        Array of fields to search. Supports wildcards (*).

      • fuzziness string | number

        One of:
        Fuzziness string Fuzziness number
      • fuzzy_max_expansions number

        Maximum number of terms to which the query expands for fuzzy matching.

      • fuzzy_prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • fuzzy_rewrite string
      • fuzzy_transpositions boolean

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

      • lenient boolean

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

      • max_determinized_states number

        Maximum number of automaton states required for the query.

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • phrase_slop number

        Maximum number of positions allowed between matching tokens for phrases.

      • query string Required

        Query string you wish to parse and use for search.

      • quote_analyzer string

        Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.

      • rewrite string
      • tie_breaker number

        How to combine the queries generated from the individual search terms in the resulting dis_max query.

      • time_zone string
      • type string

        Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

    • range object

      Returns documents that contain terms within a provided range.

      External documentation
    • rank_feature object
      Hide rank_feature attributes Show rank_feature attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • saturation object
        Hide saturation attribute Show saturation attribute object
        • pivot number

          Configurable pivot value so that the result will be less than 0.5.

      • log object
        Hide log attribute Show log attribute object
        • scaling_factor number Required

          Configurable scaling factor.

      • linear object
      • sigmoid object
        Hide sigmoid attributes Show sigmoid attributes object
        • pivot number Required

          Configurable pivot value so that the result will be less than 0.5.

        • exponent number Required

          Configurable Exponent.

    • regexp object

      Returns documents that contain terms matching a regular expression.

      External documentation
    • rule object
      Hide rule attributes Show rule attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • organic object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • ruleset_ids string | array[string]

        One of:
        Id string array-2 array[string]
      • ruleset_id string
      • match_criteria object Required
    • script object
      Hide script attributes Show script attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • script object Required
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
    • script_score object
      Hide script_score attributes Show script_score attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • min_score number

        Documents with a score lower than this floating point number are excluded from the search results.

      • query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      • script object Required
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
    • semantic object
      Hide semantic attributes Show semantic attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        The field to query, which must be a semantic_text field type

      • query string Required

        The query text

    • shape object
      Hide shape attributes Show shape attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • ignore_unmapped boolean

        When set to true the query ignores an unmapped field and will not match any documents.

    • simple_query_string object
      Hide simple_query_string attributes Show simple_query_string attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • analyzer string

        Analyzer used to convert text in the query string into tokens.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms in the query string.

      • auto_generate_synonyms_phrase_query boolean

        If true, the parser creates a match_phrase query for each multi-position token.

      • default_operator string

        Values are and, AND, or, or OR.

      • fields array[string]

        Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

      • flags string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        One of:
        SimpleQueryStringFlag string PipeSeparatedFlagsSimpleQueryStringFlag string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        Values are NONE, AND, NOT, OR, PREFIX, PHRASE, PRECEDENCE, ESCAPE, WHITESPACE, FUZZY, NEAR, SLOP, or ALL.

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

      • fuzzy_max_expansions number

        Maximum number of terms to which the query expands for fuzzy matching.

      • fuzzy_prefix_length number

        Number of beginning characters left unchanged for fuzzy matching.

      • fuzzy_transpositions boolean

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

      • lenient boolean

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

      • minimum_should_match number | string

        The minimum number of terms that should match as integer, percentage or range

        One of:
        MinimumShouldMatch number MinimumShouldMatch string
      • query string Required

        Query string in the simple query string syntax you wish to parse and use for search.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string.

    • span_containing object
      Hide span_containing attributes Show span_containing attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • big object Required
        Hide big attributes Show big attributes object
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • little object Required
        Hide little attributes Show little attributes object
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_field_masking object
      Hide span_field_masking attributes Show span_field_masking attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query object Required
        Hide query attributes Show query attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_first object
      Hide span_first attributes Show span_first attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • end number Required

        Controls the maximum end position permitted in a match.

      • match object Required
        Hide match attributes Show match attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
    • span_multi object
      Hide span_multi attributes Show span_multi attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • match object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

    • span_near object
      Hide span_near attributes Show span_near attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • clauses array[object] Required

        Array of one or more other span type queries.

        Hide clauses attributes Show clauses attributes object
        • span_containing object
        • span_field_masking object
        • span_first object
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
        • span_near
        • span_not object
        • span_or object
        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
      • in_order boolean

        Controls whether matches are required to be in-order.

      • slop number

        Controls the maximum number of intervening unmatched positions permitted.

    • span_not object
      Hide span_not attributes Show span_not attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • dist number

        The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

      • exclude object Required
        Hide exclude attributes Show exclude attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • include object Required
        Hide include attributes Show include attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
          Hide span_within attributes Show span_within attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
      • post number

        The number of tokens after the include span that can’t have overlap with the exclude span.

      • pre number

        The number of tokens before the include span that can’t have overlap with the exclude span.

    • span_or object
      Hide span_or attributes Show span_or attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • clauses array[object] Required

        Array of one or more other span type queries.

        Hide clauses attributes Show clauses attributes object
        • span_containing object
        • span_field_masking object
        • span_first object
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
        • span_near object
        • span_not object
        • span_or
        • span_term object

          The equivalent of the term query but for use with other span queries.

        • span_within object
    • span_term object

      Matches spans containing a term.

      External documentation
    • span_within object
      Hide span_within attributes Show span_within attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • big object Required
        Hide big attributes Show big attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

      • little object Required
        Hide little attributes Show little attributes object
        • span_containing object
          Hide span_containing attributes Show span_containing attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • big object Required
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object Required
        • span_first object
          Hide span_first attributes Show span_first attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • end number Required

            Controls the maximum end position permitted in a match.

          • match object Required
        • span_gap object

          Can only be used as a clause in a span_near query.

          Hide span_gap attribute Show span_gap attribute object
          • * number Additional properties
        • span_multi object
          Hide span_multi attributes Show span_multi attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • match object Required

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • span_near object
          Hide span_near attributes Show span_near attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

          • in_order boolean

            Controls whether matches are required to be in-order.

          • slop number

            Controls the maximum number of intervening unmatched positions permitted.

        • span_not object
          Hide span_not attributes Show span_not attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • dist number

            The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

          • exclude object Required
          • include object Required
          • post number

            The number of tokens after the include span that can’t have overlap with the exclude span.

          • pre number

            The number of tokens before the include span that can’t have overlap with the exclude span.

        • span_or object
          Hide span_or attributes Show span_or attributes object
          • boost number

            Floating point number used to decrease or increase the relevance scores of the query. 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.

          • _name string
          • clauses array[object] Required

            Array of one or more other span type queries.

        • span_term object

          The equivalent of the term query but for use with other span queries.

    • sparse_vector object
      Hide sparse_vector attributes Show sparse_vector attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • query string

        The query text you want to use for search. If inference_id is specified, query must also be specified.

      • prune boolean Technical preview; Added in 8.15.0

        Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false

      • pruning_config object
        Hide pruning_config attributes Show pruning_config attributes object
        • tokens_freq_ratio_threshold number

          Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.

        • tokens_weight_threshold number

          Tokens whose weight is less than this threshold are considered nonsignificant and pruned.

        • only_score_pruned_tokens boolean

          Whether to only score pruned tokens, vs only scoring kept tokens.

      • query_vector object

        Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.

        Hide query_vector attribute Show query_vector attribute object
        • * number Additional properties
      • inference_id string
    • term object

      Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

      External documentation
    • terms object
      Hide terms attributes Show terms attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
    • terms_set object

      Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

      External documentation
    • text_expansion object Deprecated Generally available; Added in 8.8.0

      Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

      External documentation
    • weighted_tokens object Deprecated Generally available; Added in 8.13.0

      Supports returning text_expansion query results by sending in precomputed tokens with the query.

      External documentation
    • wildcard object

      Returns documents that contain terms matching a wildcard pattern.

      External documentation
    • wrapper object
      Hide wrapper attributes Show wrapper attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • query string Required

        A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings

    • type object
      Hide type attributes Show type attributes object
      • boost number

        Floating point number used to decrease or increase the relevance scores of the query. 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.

      • _name string
      • value string Required

  • rescore object | array[object]

    One of:
    Rescore object array-2 array[object]
    Hide attributes Show attributes object
    • window_size number
    • query object
      Hide query attributes Show query attributes object
      • rescore_query object Required

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        External documentation
        Hide rescore_query attributes Show rescore_query attributes object
        • common object Deprecated
        • distance_feature
        • fuzzy object

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

        • geo_grid object

          Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

        • intervals object

          Returns documents based on the order and proximity of matching terms.

        • match object

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

        • match_bool_prefix object

          Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

        • match_phrase object

          Analyzes the text and creates a phrase query out of the analyzed text.

        • match_phrase_prefix object

          Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

        • prefix object

          Returns documents that contain a specific prefix in a provided field.

        • range object

          Returns documents that contain terms within a provided range.

        • regexp object

          Returns documents that contain terms matching a regular expression.

        • span_term object

          Matches spans containing a term.

        • term object

          Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

        • terms_set object

          Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

        • text_expansion object Deprecated Generally available; Added in 8.8.0

          Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

        • weighted_tokens object Deprecated Generally available; Added in 8.13.0

          Supports returning text_expansion query results by sending in precomputed tokens with the query.

        • wildcard object

          Returns documents that contain terms matching a wildcard pattern.

      • query_weight number

        Relative importance of the original query versus the rescore query.

      • rescore_query_weight number

        Relative importance of the rescore query versus the original query.

      • score_mode string

        Values are avg, max, min, multiply, or total.

    • learning_to_rank object
      Hide learning_to_rank attributes Show learning_to_rank attributes object
      • model_id string Required

        The unique identifier of the trained model uploaded to Elasticsearch

      • params object

        Named parameters to be passed to the query templates used for feature

        Hide params attribute Show params attribute object
        • * object Additional properties
  • script_fields object

    Retrieve a script evaluation (based on different fields) for each hit.

    Hide script_fields attribute Show script_fields attribute object
    • * object Additional properties
      Hide * attributes Show * attributes object
      • script object Required
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
      • ignore_failure boolean
  • search_after array[number | string | boolean | null]

    A field value.

  • size number

    The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

  • slice object
    Hide slice attributes Show slice attributes object
    • field string

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • id string Required
    • max number Required

  • sort string | object | array[string | object]

    One of:
    Field string SortOptions object Sort array[string | object]

    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    One of:
    Field string SortOptions object

    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

  • _source boolean | object

    Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

    One of:
    SourceConfig boolean SourceFilter object
  • fields array[object]

    Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

    Hide fields attributes Show fields attributes object
    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • format string

      The format in which the values are returned.

    • include_unmapped boolean
  • suggest object
    Hide suggest attribute Show suggest attribute object
    • text string

      Global suggest text, to avoid repetition when the same text is used in several suggesters

  • terminate_after number

    Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.

  • timeout string

    Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

  • track_scores boolean

    If true, calculate and return document scores, even if the scores are not used for sorting.

  • version boolean

    If true, returns document version as part of a hit.

  • seq_no_primary_term boolean

    If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.

  • stored_fields string | array[string]
  • pit object
    Hide pit attributes Show pit attributes object
    • id string Required
    • keep_alive string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • runtime_mappings object
    Hide runtime_mappings attribute Show runtime_mappings attribute object
    • * object Additional properties
      Hide * attributes Show * attributes object
      • fields object

        For type composite

        Hide fields attribute Show fields attribute object
        • * object Additional properties
          Hide * attribute Show * attribute object
          • type string Required

            Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

      • fetch_fields array[object]

        For type lookup

        Hide fetch_fields attributes Show fetch_fields attributes object
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • format string
      • format string

        A custom format for date type runtime fields.

      • input_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_index string
      • script object
        Hide script attributes Show script attributes object

        • source string | object

          One of:
          ScriptSource string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object
          • * object Additional properties

        • lang string

          Any of:
          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.

        • options object
          Hide options attribute Show options attribute object
          • * string Additional properties
      • type string Required

        Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

  • stats array[string]

    Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • id string
    • is_partial boolean Required

      When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, is_partial is always set to true.

    • is_running boolean Required

      Indicates whether the search is still running or has completed.


      If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false.

    • expiration_time string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:
      DateTime string EpochTimeUnitMillis number

      Time unit for milliseconds

    • expiration_time_in_millis number

      Time unit for milliseconds

    • start_time string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:
      DateTime string EpochTimeUnitMillis number

      Time unit for milliseconds

    • start_time_in_millis number

      Time unit for milliseconds

    • completion_time string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:
      DateTime string EpochTimeUnitMillis number

      Time unit for milliseconds

    • completion_time_in_millis number

      Time unit for milliseconds

    • response object Required
      Hide response attributes Show response attributes object
      • aggregations object

        Partial aggregations results, coming from the shards that have already completed running the query.

      • _clusters object
        Hide _clusters attributes Show _clusters attributes object
        • skipped number Required
        • successful number Required
        • total number Required
        • running number Required
        • partial number Required
        • failed number Required
        • details object
          Hide details attribute Show details attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • status string Required

              Values are running, successful, partial, skipped, or failed.

            • indices string Required
            • timed_out boolean Required
            • _shards object
            • failures array[object]
      • fields object
        Hide fields attribute Show fields attribute object
        • * object Additional properties
      • hits object Required
        Hide hits attributes Show hits attributes object

        • total object | number

          Total hit count information, present only if track_total_hits wasn't false in the search request.

          One of:
          TotalHits object number-2 number
        • hits array[object] Required
          Hide hits attributes Show hits attributes object
          • _index string Required
          • _id string
          • _score
          • _explanation object
          • fields object
          • highlight object
          • inner_hits object
          • matched_queries
          • _nested object
          • _ignored array[string]
          • ignored_field_values object
          • _shard string
          • _node string
          • _routing string
          • _source object
          • _rank number
          • _seq_no number
          • _primary_term number
          • _version number
          • sort array[number | string | boolean | null]

            A field value.

        • max_score number | string | null

          One of:
          number-1 number string-2 string | null
      • max_score number
      • num_reduce_phases number

        Indicates how many reductions of the results have been performed. If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.

      • profile object
        Hide profile attribute Show profile attribute object
        • shards array[object] Required
          Hide shards attributes Show shards attributes object
          • aggregations array[object] Required
          • cluster string Required
          • dfs object
          • fetch object
          • id string Required
          • index string Required
          • node_id string Required
          • searches array[object] Required
          • shard_id number Required
      • pit_id string
      • _scroll_id string
      • _shards object Required
        Hide _shards attributes Show _shards attributes object
        • failed number Required
        • successful number Required
        • total number Required
        • failures array[object]
          Hide failures attributes Show failures attributes object
          • index string
          • node string
          • reason object Required
          • shard number Required
          • status string
        • skipped number
      • suggest object
        Hide suggest attribute Show suggest attribute object
        • * array[object] Additional properties
      • terminated_early boolean
      • timed_out boolean Required
      • took number Required
POST /{index}/_async_search 
POST /my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001/_async_search?ccs_minimize_roundtrips=true
{
  "query": {
    "match": {
      "user.id": "kimchy"
    }
  },
  "_source": ["user.id", "message", "http.response.status_code"]
}
curl \
 --request POST 'http://api.example.com/{index}/_async_search' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"query\": {\n    \"match\": {\n      \"user.id\": \"kimchy\"\n    }\n  },\n  \"_source\": [\"user.id\", \"message\", \"http.response.status_code\"]\n}"'
Request examples
An example body for a `POST /my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001/_async_search?ccs_minimize_roundtrips=true` request. 
{
  "query": {
    "match": {
      "user.id": "kimchy"
    }
  },
  "_source": ["user.id", "message", "http.response.status_code"]
}
Perform a search request asynchronously with `POST /sales*/_async_search?size=0`. It accepts the same parameters and request body as the search API. 
{
  "sort": [
    { "date": { "order": "asc" } }
  ],
  "aggs": {
    "sale_date": {
      "date_histogram": {
        "field": "date",
        "calendar_interval": "1d"
      }
    }
  }
}
Response examples (200)
A successful response when performing search asynchronously. 
{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=",
  "is_partial" : true,
  "is_running" : true,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "response" : {
    "took" : 1122,
    "timed_out" : false,
    "num_reduce_phases" : 0,
    "_shards" : {
      "total" : 562,
      "successful" : 3,
      "skipped" : 0,
      "failed" : 0
    },
    "hits" : {
      "total" : {
        "value" : 157483,
        "relation" : "gte"
      },
      "max_score" : null,
      "hits" : [ ]
    }
  }
}

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation