Update documents | Elasticsearch API documentation (8x-unreleased)

Update documents Generally available; Added in 2.4.0

POST /{index}/_update_by_query

Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:

read
index or write

You can specify the query criteria in the request URI or the request body using the same syntax as the search API.

When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. When the versions match, the document is updated and the version number is incremented. If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. You can opt to count version conflicts instead of halting and returning by setting conflicts to proceed. Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than max_docs until it has successfully updated max_docs documents or it has gone through every document in the source query.

NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.

While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. A bulk update request is performed for each batch of matching documents. Any query or update failures cause the update by query request to fail and the failures are shown in the response. Any update requests that completed successfully still stick, they are not rolled back.

Throttling update requests

To control the rate at which update by query issues batches of update operations, you can set requests_per_second to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set requests_per_second to -1 to turn off throttling.

Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the requests_per_second and the time spent writing. By default the batch size is 1000, so if requests_per_second is set to 500:

target_time = 1000 / 500 per second = 2 seconds
wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds

Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth".

Slicing

Update by query supports sliced scroll to parallelize the update process. This can improve efficiency and provide a convenient way to break the request down into smaller parts.

Setting slices to auto chooses a reasonable number for most data streams and indices. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.

Adding slices to _update_by_query just automates the manual process of creating sub-requests, which means it has some quirks:

You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices.
Fetching the status of the task for the request with slices only contains the status of completed slices.
These sub-requests are individually addressable for things like cancellation and rethrottling.
Rethrottling the request with slices will rethrottle the unfinished sub-request proportionally.
Canceling the request with slices will cancel each sub-request.
Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.
Parameters like requests_per_second and max_docs on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using max_docs with slices might not result in exactly max_docs documents being updated.
Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.

If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:

Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.
Update performance scales linearly across available resources with the number of slices.

Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.

Update the document source

Update by query supports scripts to update the document source. As with the update API, you can set ctx.op to change the operation that is performed.

Set ctx.op = "noop" if your script decides that it doesn't have to make any changes. The update by query operation skips updating the document and increments the noop counter.

Set ctx.op = "delete" if your script decides that the document should be deleted. The update by query operation deletes the document and increments the deleted counter.

Update by query supports only index, noop, and delete. Setting ctx.op to anything else is an error. Setting any other field in ctx is an error. This API enables you to only modify the source of matching documents; you cannot move them. ##Required authorization

Index privileges: read,write

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*). To search all data streams or indices, omit this parameter or use * or _all.

Query parameters

allow_no_indices boolean

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
analyzer string

The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.
analyze_wildcard boolean

If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.
conflicts string

The preferred behavior when update by query hits version conflicts: abort or proceed.

Values are abort or proceed.
default_operator string

The default operator for query string query: AND or OR. This parameter can be used only when the q query string parameter is specified.

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. This parameter can be used only when the q query string parameter is specified.
expand_wildcards string | array[string]

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

Skips the specified number of documents.
ignore_unavailable boolean

If false, the request returns an error if it targets a missing or closed index.
lenient boolean

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.
max_docs number

The maximum number of documents to process. It defaults to all documents. When set to a value less then or equal to scroll_size then a scroll will not be used to retrieve the results for the operation.
pipeline string

The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
preference string

The node or shard the operation should be performed on. It is random by default.
q string

A query in the Lucene query string syntax.
refresh boolean

If true, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's refresh parameter, which causes just the shard that received the request to be refreshed.
request_cache boolean

If true, the request cache is used for this request. It defaults to the index-level setting.
requests_per_second number

The throttle for this request in sub-requests per second.
routing string

A custom value used to route operations to a specific shard.
scroll string

The period to retain the search context for scrolling.

Values are -1 or 0.
scroll_size number

The size of the scroll request that powers the operation.
search_timeout string

An explicit timeout for each search request. By default, there is no timeout.

Values are -1 or 0.
search_type string

The type of the search operation. Available options include query_then_fetch and dfs_query_then_fetch.

Values are query_then_fetch or dfs_query_then_fetch.
slices number | string

The number of slices this task should be divided into.

Value is auto.
sort array[string]

A comma-separated list of : pairs.
stats array[string]

The specific tag of the request for logging and statistical purposes.
terminate_after number

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

IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
timeout string

The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

Values are -1 or 0.
version boolean

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

Should the document increment the version number (internal) on hit or not (reindex)
wait_for_active_shards number | string

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The timeout parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API.

Values are all or index-setting.
wait_for_completion boolean

If true, the request blocks until the operation is complete. If false, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at .tasks/task/${taskId}.

application/json

Body

max_docs number

The maximum number of documents to update.
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
 
 Hide attributes Show attributes
 
 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
 
 origin object Required
 
 Date or point of origin used to calculate distances. If the field value is a date or date_nanos field, the origin value must be a date. Date Math, such as now-1h, is supported. If the field value is a geo_point field, the origin value must be a geopoint.
 
 pivot object Required
 
 Distance from the origin at which relevance scores receive half of the boost value. If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 Hide attributes Show attributes
 
 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
 
 origin object | array[number] | string Required
 
 A latitude/longitude as a 2 dimensional point. It can be represented in various ways:
 
 as a {lat, long} object
 
 as a geo hash value
 
 as a [lon, lat] array
 
 as a string in "<lat>, <lon>" or WKT point formats
 
 One of:
 LatLonGeoLocation object GeoHashLocation object GeoLocation array[number] GeoLocation string
 
 pivot string Required
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 Hide attributes Show attributes
 
 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
 
 origin string Required
 
 pivot string Required
 
 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.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- 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  and  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  and  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  and  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  and  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]
 
 Hide attributes Show attributes
 
 doc object
 
 A document not present in the index.
 
 fields array[string]
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 _id string
 
 _index string
 
 per_field_analyzer object
 
 Overrides the default analyzer.
 
 routing string
 
 version number
 
 version_type string
 
 Values are internal, external, external_gte, or force.
 
 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]
 
 Hide attributes Show attributes
 
 doc object
 
 A document not present in the index.
 
 fields array[string]
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 _id string
 
 _index string
 
 per_field_analyzer object
 
 Overrides the default analyzer.
 
 routing string
 
 version number
 
 version_type string
 
 Values are internal, external, external_gte, or force.
 
 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  and  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  and  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
 
 Hide attributes Show attributes
 
 aggregations object
 
 Defines the aggregations that are run as part of the search request.
 
 collapse object
 
 explain boolean
 
 If true, the request returns detailed information about score computation as part of a hit.
 
 ext object
 
 Configuration of search extensions defined by Elasticsearch plugins.
 
 from number
 
 The starting document offset, which must be non-negative. 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
 
 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]
 
 Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
 
 docvalue_fields array[object]
 
 An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
 
 knn
 
 rank object
 
 min_score number
 
 The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
 
 post_filter object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 profile boolean
 
 Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
 
 query object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 rescore
 
 retriever object
 
 script_fields object
 
 Retrieve a script evaluation (based on different fields) for each hit.
 
 search_after array[number | string | boolean | null]
 
 A field value.
 
 size number
 
 The number of hits to return, which must not be negative. 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 property.
 
 slice object
 
 sort
 
 _source
 
 fields array[object]
 
 An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
 
 suggest object
 
 terminate_after number
 
 The 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.
 
 IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
 
 If set to 0 (default), the query does not terminate early.
 
 timeout string
 
 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, the request returns the document version as part of a hit.
 
 seq_no_primary_term boolean
 
 If true, the request returns sequence number and primary term of the last modification of each hit.
 
 stored_fields string | array[string]
 
 pit object
 
 runtime_mappings object
 
 stats array[string]
 
 The 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.
 
 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
 
 Hide attributes Show attributes
 
 aggregations object
 
 Defines the aggregations that are run as part of the search request.
 
 collapse object
 
 explain boolean
 
 If true, the request returns detailed information about score computation as part of a hit.
 
 ext object
 
 Configuration of search extensions defined by Elasticsearch plugins.
 
 from number
 
 The starting document offset, which must be non-negative. 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
 
 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]
 
 Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
 
 docvalue_fields array[object]
 
 An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
 
 knn
 
 rank object
 
 min_score number
 
 The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
 
 post_filter object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 profile boolean
 
 Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
 
 query object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 rescore
 
 retriever object
 
 script_fields object
 
 Retrieve a script evaluation (based on different fields) for each hit.
 
 search_after array[number | string | boolean | null]
 
 A field value.
 
 size number
 
 The number of hits to return, which must not be negative. 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 property.
 
 slice object
 
 sort
 
 _source
 
 fields array[object]
 
 An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
 
 suggest object
 
 terminate_after number
 
 The 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.
 
 IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
 
 If set to 0 (default), the query does not terminate early.
 
 timeout string
 
 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, the request returns the document version as part of a hit.
 
 seq_no_primary_term boolean
 
 If true, the request returns sequence number and primary term of the last modification of each hit.
 
 stored_fields string | array[string]
 
 pit object
 
 runtime_mappings object
 
 stats array[string]
 
 The 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.
 
 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
script object
Hide script attributes Show script attributes object
- source string | object
 
 One of:
 ScriptSource string SearchRequestBody object
 
 Hide attributes Show attributes
 
 aggregations object
 
 Defines the aggregations that are run as part of the search request.
 
 External documentation
 
 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]
 
 explain boolean
 
 highlight
 
 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_concurrent_group_searches number
 
 The number of concurrent requests allowed to retrieve the inner_hits per group
 
 collapse object
 
 explain boolean
 
 If true, the request 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
 
 The starting document offset, which must be non-negative. 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
 
 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.
 
 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  and  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  and  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]
 
 Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
 
 External documentation
 
 Hide indices_boost attribute Show indices_boost attribute object
 
 * number Additional properties
 
 docvalue_fields array[object]
 
 An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
 
 External documentation
 
 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]
 
 The approximate kNN search to run.
 
 One of:
 KnnSearch object array-2 array[object]
 
 Hide attributes Show attributes
 
 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
 
 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.
 
 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
 
 docvalue_fields array[object]
 
 explain boolean
 
 highlight
 
 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
 
 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
 
 External documentation
 
 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
 
 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
 
 similarity number
 
 The minimum similarity for a vector to be considered a match
 
 inner_hits object
 
 rescore_vector object
 
 rank object
 
 Hide rank attribute Show rank attribute object
 
 rrf object
 
 Hide rrf attributes Show rrf attributes object
 
 rank_constant number
 
 How much influence documents in individual result sets per query have over the final ranked result set
 
 rank_window_size number
 
 Size of the individual result sets per query
 
 min_score number
 
 The minimum _score for matching documents. Documents with a lower _score are not included in search results or 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
 
 minimum_should_match
 
 must
 
 must_not
 
 should
 
 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
 
 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.
 
 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
 
 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
 
 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
 
 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
 
 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
 
 similarity number
 
 The minimum similarity for a vector to be considered a match
 
 rescore_vector object
 
 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.
 
 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
 
 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
 
 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
 
 unlike
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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.
 
 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
 
 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
 
 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
 
 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 *.
 
 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
 
 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
 
 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_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
 
 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
 
 little object Required
 
 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
 
 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
 
 Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
 
 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
 
 minimum_should_match
 
 must
 
 must_not
 
 should
 
 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
 
 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.
 
 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
 
 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
 
 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
 
 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
 
 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
 
 similarity number
 
 The minimum similarity for a vector to be considered a match
 
 rescore_vector object
 
 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.
 
 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
 
 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
 
 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
 
 unlike
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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
 
 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.
 
 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
 
 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
 
 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
 
 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 *.
 
 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
 
 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
 
 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_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
 
 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
 
 little object Required
 
 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
 
 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]
 
 Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases.
 
 One of:
 Rescore object array-2 array[object]
 
 retriever object
 
 Hide retriever attributes Show retriever attributes object
 
 standard object
 
 Hide standard attributes Show standard attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 query object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 search_after array[number | string | boolean | null]
 
 A field value.
 
 terminate_after number
 
 Maximum number of documents to collect for each shard.
 
 sort
 
 collapse object
 
 knn object
 
 Hide knn attributes Show knn attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 field string Required
 
 The name of the vector field to search against.
 
 query_vector array[number]
 
 query_vector_builder object
 
 k number Required
 
 Number of nearest neighbors to return as top hits.
 
 num_candidates number Required
 
 Number of nearest neighbor candidates to consider per shard.
 
 similarity number
 
 The minimum similarity required for a document to be considered a match.
 
 rescore_vector object
 
 rrf object
 
 Hide rrf attributes Show rrf attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 retrievers array[object] Required
 
 A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
 
 rank_constant number
 
 This value determines how much influence documents in individual result sets per query have over the final ranked result set.
 
 rank_window_size number
 
 This value determines the size of the individual result sets per query.
 
 text_similarity_reranker object
 
 Hide text_similarity_reranker attributes Show text_similarity_reranker attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 retriever object Required
 
 rank_window_size number
 
 This value determines how many documents we will consider from the nested retriever.
 
 inference_id string
 
 Unique identifier of the inference endpoint created using the inference API.
 
 inference_text string
 
 The text snippet used as the basis for similarity comparison
 
 field string
 
 The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text
 
 rule object
 
 Hide rule attributes Show rule attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 ruleset_ids
 
 match_criteria object Required
 
 The match criteria that will determine if a rule in the provided rulesets should be applied.
 
 retriever object Required
 
 rank_window_size number
 
 This value determines the size of the individual result set.
 
 rescorer object
 
 Hide rescorer attributes Show rescorer attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 retriever object Required
 
 rescore
 
 linear object
 
 Hide linear attributes Show linear attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 retrievers array[object]
 
 Inner retrievers.
 
 rank_window_size number Required
 
 pinned object
 
 Hide pinned attributes Show pinned attributes object
 
 filter
 
 min_score number
 
 Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
 
 _name string
 
 Retriever name.
 
 retriever object Required
 
 ids array[string]
 
 docs array[object]
 
 rank_window_size number Required
 
 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
 
 ignore_failure boolean
 
 search_after array[number | string | boolean | null]
 
 A field value.
 
 size number
 
 The number of hits to return, which must not be negative. 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 property.
 
 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]
 
 An array of wildcard (*) field 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
 
 The 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.
 
 IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
 
 If set to 0 (default), the query does not terminate early.
 
 timeout string
 
 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, the request returns the document version as part of a hit.
 
 seq_no_primary_term boolean
 
 If true, the request returns sequence number and primary term of the last modification of each hit.
 
 External documentation
 
 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
 
 fetch_fields array[object]
 
 For type lookup
 
 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
 
 type string Required
 
 Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
 
 stats array[string]
 
 The 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.
- 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
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
conflicts string

Values are abort or proceed.

Responses

200 application/json
Hide response attributes Show response attributes object
- batches number
  
  The number of scroll responses pulled back by the update by query.
- failures array[object]
  
  Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes the entire process to end, but all failures in the current batch are collected into the array. You can use the conflicts option to prevent reindex from ending when version conflicts occur.
  
  Hide failures attributes Show failures attributes object
  
  cause object Required
  
  Hide cause attributes Show cause attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  id string Required
  
  index string Required
  
  status number Required
- noops number
  
  The number of documents that were ignored because the script used for the update by query returned a noop value for ctx.op.
- deleted number
  
  The number of documents that were successfully deleted.
- requests_per_second number
  
  The number of requests per second effectively run during the update by query.
- retries object
  
  Hide retries attributes Show retries attributes object
  
  bulk number Required
  
  The number of bulk actions retried.
  
  search number Required
  
  The number of search actions retried.
- task string | number
  
  One of:
  TaskId string TaskId number
- timed_out boolean
  
  If true, some requests timed out during the update by query.
- took number
  
  Time unit for milliseconds
- total number
  
  The number of documents that were successfully processed.
- updated number
  
  The number of documents that were successfully updated.
- version_conflicts number
  
  The number of version conflicts that the update by query hit.
- throttled 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.
- throttled_millis number
  
  Time unit for milliseconds
- throttled_until 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.
- throttled_until_millis number
  
  Time unit for milliseconds

POST /{index}/_update_by_query

POST my-data-stream/_update_by_query?pipeline=my-pipeline

curl \
 --request POST 'http://api.example.com/{index}/_update_by_query' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"query\": { \n    \"term\": {\n      \"user.id\": \"kimchy\"\n    }\n  }\n}"'

Request examples

Run `POST my-index-000001/_update_by_query?conflicts=proceed` to update documents that match a query.

{
  "query": { 
    "term": {
      "user.id": "kimchy"
    }
  }
}

Run `POST my-index-000001/_update_by_query` with a script to update the document source. It increments the `count` field for all documents with a `user.id` of `kimchy` in `my-index-000001`.

{
  "script": {
    "source": "ctx._source.count++",
    "lang": "painless"
  },
  "query": {
    "term": {
      "user.id": "kimchy"
    }
  }
}

Run `POST my-index-000001/_update_by_query` to slice an update by query manually. Provide a slice ID and total number of slices to each request.

{
  "slice": {
    "id": 0,
    "max": 2
  },
  "script": {
    "source": "ctx._source['extra'] = 'test'"
  }
}

Run `POST my-index-000001/_update_by_query?refresh&slices=5` to use automatic slicing. It automatically parallelizes using sliced scroll to slice on `_id`.

{
  "script": {
    "source": "ctx._source['extra'] = 'test'"
  }
}

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation

Update documents Generally available; Added in 2.4.0

Path parameters

Query parameters

Body

filter object | array[object]

minimum_should_match number | string

must object | array[object]

must_not object | array[object]

should object | array[object]

minimum_should_match number | string

distance_feature object

inner_hits object | array[object]

sort string | object | array[string | object]

_source boolean | object

inner_hits object | array[object]

sort string | object | array[string | object]

_source boolean | object

values string | array[string]

filter object | array[object]

like string | object | array[string | object]

minimum_should_match number | string

stop_words string | array[string]

unlike string | object | array[string | object]

fuzziness string | number

minimum_should_match number | string

inner_hits object | array[object]

sort string | object | array[string | object]

_source boolean | object

fuzziness string | number

minimum_should_match number | string

ruleset_ids string | array[string]

source string | object

lang string

source string | object

lang string

flags string

minimum_should_match number | string

source string | object

lang string

Responses

reason string | null

task string | number

Documentation preview