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

    • 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 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
      • 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 Required
    • 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
          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
        • ignore_failure boolean
    • seq_no_primary_term boolean
    • fields string | array[string]

    • 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.

      Hide attributes Show attributes

      • _score object
      • _doc object
      • _geo_distance object
      • _script object

      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

      Hide attributes Show attributes

      • excludes string | array[string]
      • includes string | array[string]
    • stored_fields string | array[string]
    • track_scores boolean
    • version boolean

    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 object Required
    • 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 string | array[string]

    • 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

      Hide attributes Show attributes

      • excludes string | array[string]
      • includes string | array[string]
    • 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
  • 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 Required
• 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
• 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
• profile boolean
• query object

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

  External documentation

• rescore object | array[object]

  One of:

  Rescore object array-2 array[object]

  Hide attributes Show attributes

  • 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
    • 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

  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
    • 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 ScriptSource 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.

  Hide attributes Show attributes

  • _score object
    Hide _score attribute Show _score attribute object

    • order string

      Values are asc or desc.

  • _doc object
    Hide _doc attribute Show _doc attribute object

    • order string

      Values are asc or desc.

  • _geo_distance object
    Hide _geo_distance attributes Show _geo_distance attributes object

    • mode string

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

    • distance_type string

      Values are arc or plane.

    • ignore_unmapped boolean
    • order string

      Values are asc or desc.

    • unit string

      Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

    • nested object
      Hide nested attributes Show nested attributes object

      • filter object

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

        External documentation
      • max_children number
      • nested object
      • path string Required

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

  • _script object
    Hide _script attributes Show _script attributes object

    • order string

      Values are asc or desc.

    • script object Required
      Hide script attributes Show script attributes object

      • source string | object

        One of:

        ScriptSource string ScriptSource 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

      Values are string, number, or version.

    • mode string

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

    • nested object
      Hide nested attributes Show nested attributes object

      • filter object

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

        External documentation
      • max_children number
      • nested object
      • path string Required

        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.

  Hide attributes Show attributes

  • _score object
    Hide _score attribute Show _score attribute object

    • order string

      Values are asc or desc.

  • _doc object
    Hide _doc attribute Show _doc attribute object

    • order string

      Values are asc or desc.

  • _geo_distance object
    Hide _geo_distance attributes Show _geo_distance attributes object

    • mode string

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

    • distance_type string

      Values are arc or plane.

    • ignore_unmapped boolean
    • order string

      Values are asc or desc.

    • unit string

      Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

    • nested object
      Hide nested attributes Show nested attributes object

      • filter object

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

      • max_children number
      • nested object
      • path string Required

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

  • _script object
    Hide _script attributes Show _script attributes object

    • order string

      Values are asc or desc.

    • 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
    • type string

      Values are string, number, or version.

    • mode string

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

    • nested object
      Hide nested attributes Show nested attributes object

      • filter object

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

      • max_children number
      • nested object
      • path string Required

        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

  Hide attributes Show attributes

  • excludes string | array[string]
  • includes string | array[string]
• 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 ScriptSource 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.