Body Required

• aggregations object
• collapse object
  External documentation
• explain boolean

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

  Default value is false.

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

  Default value is 0.

• highlight object
  Hide highlight attributes Show highlight attributes object

  • type string

    Supported values include:

    • plain: The plain highlighter uses the standard Lucene highlighter
    • fvh: The fvh highlighter uses the Lucene Fast Vector highlighter.
    • unified: The unified highlighter uses the Lucene Unified Highlighter.

    Any of:

    string-1 string string-2 string

    Supported values include:

    • plain: The plain highlighter uses the standard Lucene highlighter
    • fvh: The fvh highlighter uses the Lucene Fast Vector highlighter.
    • unified: The unified highlighter uses the Lucene Unified Highlighter.

    Values are plain, fvh, or unified.

    Supported values include:

    • plain: The plain highlighter uses the standard Lucene highlighter
    • fvh: The fvh highlighter uses the Lucene Fast Vector highlighter.
    • unified: The unified highlighter uses the Lucene Unified Highlighter.
  • boundary_chars string

    A string that contains each boundary character.

    Default value is .,!? \t\n.

  • boundary_max_scan number

    How far to scan for boundary characters.

    Default value is 20.

  • boundary_scanner string

    Specifies how to break the highlighted fragments: chars, sentence, or word. Only valid for the unified and fvh highlighters. Defaults to sentence for the unified highlighter. Defaults to chars for the fvh highlighter.

    Supported values include:

    • chars: Use the characters specified by boundary_chars as highlighting boundaries. The boundary_max_scan setting controls how far to scan for boundary characters. Only valid for the fvh highlighter.
    • sentence: Break highlighted fragments at the next sentence boundary, as determined by Java’s BreakIterator. You can specify the locale to use with boundary_scanner_locale. When used with the unified highlighter, the sentence scanner splits sentences bigger than fragment_size at the first word boundary next to fragment_size. You can set fragment_size to 0 to never split any sentence.
    • word: Break highlighted fragments at the next word boundary, as determined by Java’s BreakIterator. You can specify the locale to use with boundary_scanner_locale.

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

    Default value is Locale.ROOT.

  • force_source boolean Deprecated
  • fragmenter string

    Specifies how text should be broken up in highlight snippets: simple or span. Only valid for the plain highlighter.

    Values are simple or span.

  • fragment_size number

    The size of the highlighted fragment in characters.

    Default value is 100.

  • highlight_filter boolean
  • highlight_query object

    Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.

    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.

    Default value is 0.

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

    Default value is 5.

  • options object
    Hide options attribute Show options attribute object

    • * object Additional properties
  • order string

    Sorts highlighted fragments by score when set to score. By default, fragments will be output in the order they appear in the field (order: none). Setting this option to score will output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores.

    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.

    Default value is 256.

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

    Default value is true.

  • tags_schema string

    Set to styled to use the built-in tag schema.

    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.

  A reference to a field with formatting instructions on how to return the value

  Hide docvalue_fields attributes Show docvalue_fields attributes object

  • field string Required

    A wildcard pattern. The request returns values for field names matching this pattern.

  • 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

  Defines the search definition using the Query DSL.

  External documentation

• rescore object | array[object]

  One of:

  object-2 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

      The query to use for rescoring. This query is only run on the Top-K results returned by the query and post_filter phases.

    • query_weight number

      Relative importance of the original query versus the rescore query.

      Default value is 1.

    • rescore_query_weight number

      Relative importance of the rescore query versus the original query.

      Default value is 1.

    • score_mode string

      Determines how scores are combined.

      Supported values include:

      • avg: Average the original score and the rescore query score.
      • max: Take the max of original score and the rescore query score.
      • min: Take the min of the original score and the rescore query score.
      • multiply: Multiply the original score by the rescore query score. Useful for function query rescores.
      • total: Add the original score and the rescore query score.

      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

    • query_weight number

      Relative importance of the original query versus the rescore query.

      Default value is 1.

    • rescore_query_weight number

      Relative importance of the rescore query versus the original query.

      Default value is 1.

  • 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

• 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

        The script source.

      • id string

        The id for a stored script.

      • 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

        Specifies the language the script is written in.

        Supported values include:

        • painless: Painless scripting language, purpose-built for Elasticsearch.
        • expression: Lucene’s expressions language, compiles a JavaScript expression to bytecode.
        • mustache: Mustache templated, used for templates.
        • java: Expert Java API

        Any of:

        string-1 string string-2 string

        Specifies the language the script is written in.

        Supported values include:

        • painless: Painless scripting language, purpose-built for Elasticsearch.
        • expression: Lucene’s expressions language, compiles a JavaScript expression to bytecode.
        • mustache: Mustache templated, used for templates.
        • java: Expert Java API

        Values are painless, expression, mustache, or java.

        Specifies the language the script is written in.

        Supported values include:

        • painless: Painless scripting language, purpose-built for Elasticsearch.
        • expression: Lucene’s expressions language, compiles a JavaScript expression to bytecode.
        • mustache: Mustache templated, used for templates.
        • java: Expert Java API
      • options object
        Hide options attribute Show options attribute object

        • * string Additional properties
    • ignore_failure boolean
• search_after array[number | string | boolean | null | object]

  A field value.

  A field value.

  One of:

  number-1 number number-2 number string-3 string boolean-4 boolean string-5 string | null object-6 object
• 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.

  Default value is 10.

• 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 array-2 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
    Hide _geo_distance attribute Show _geo_distance attribute object

    • ignore_unmapped boolean
  • _script object

• _source boolean | object

  Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

  One of:

  boolean-1 boolean SourceFilter object

  Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

  Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

  Hide attributes Show attributes

  • exclude_vectors boolean

    If true, vector fields are excluded from the returned source.

    This option takes precedence over includes: any vector field will remain excluded even if it matches an includes rule.

  • excludes string | array[string]

    A list of fields to exclude from the returned source.

  • includes string | array[string]

    A list of fields to include in the returned source.

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

  A reference to a field with formatting instructions on how to return the value

  Hide fields attributes Show fields attributes object

  • field string Required

    A wildcard pattern. The request returns values for field names matching this pattern.

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

  Default value is 0.

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

  Default value is false.

• version boolean

  If true, returns document version as part of a hit.

  Default value is false.

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

  List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

• pit object

  Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path.

  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.

    External documentation
• runtime_mappings object

  Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.

  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

      For type lookup

    • target_field string

      For type lookup

    • target_index string

      For type lookup

    • script object

      Painless script executed at query time.

      Hide script attributes Show script attributes object

      • source string

        The script source.

      • id string

        The id for a stored script.

      • 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
      • options object
        Hide options attribute Show options attribute object

        • * string Additional properties
    • type string Required

      Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup.

      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.