Allows to execute several search operations in one request
Path parameters
-
Comma-separated list of data streams, indices, and index aliases to search.
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.
-
ccs_minimize_roundtrips boolean
If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.
-
expand_wildcards string | array[string]
Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-
ignore_throttled boolean
If true, concrete, expanded or aliased indices are ignored when frozen.
-
ignore_unavailable boolean
If true, missing or closed indices are not included in the response.
-
include_named_queries_score boolean
Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.
-
max_concurrent_searches number
Maximum number of concurrent searches the multi search API can execute.
-
Maximum number of concurrent shard requests that each sub-search request executes per node.
-
pre_filter_shard_size number
Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.
-
rest_total_hits_as_int boolean
If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.
-
routing string
Custom routing value used to route search operations to a specific shard.
-
search_type string
Indicates whether global term and document frequencies should be used when scoring returned documents.
Values are
query_then_fetchordfs_query_then_fetch. -
typed_keys boolean
Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.
Body object Required
-
allow_no_indices boolean
-
expand_wildcards string | array[string]
-
ignore_unavailable boolean
-
index string | array[string]
-
preference string
-
request_cache boolean
-
routing string
-
search_type string
Values are
query_then_fetchordfs_query_then_fetch. -
ccs_minimize_roundtrips boolean
-
allow_partial_search_results boolean
-
ignore_throttled boolean
-
aggregations object
-
collapse object
Hide collapse attributes Show collapse attributes object
-
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: 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 object
-
ignore_unmapped boolean
-
script_fields object
-
seq_no_primary_term boolean
-
fields string | array[string]
-
sort array[string | object]
_source boolean | object
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
Hide attributes Show attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
The number of concurrent requests allowed to retrieve the inner_hits per group
-
collapse object
-
-
query object
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.minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
must object | array[object]
The clause (query) must appear in matching documents and will contribute to the score.
must_not object | array[object]
The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of
0is returned for all documents.should object | array[object]
The clause (query) should appear in the matching document.
-
-
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
-
Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the
negativequery.
-
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
Text to search for in the provided
fields. Thecombined_fieldsquery analyzes the provided text before performing a search. -
If true, match phrase queries are automatically created for multi-term synonyms.
-
operator string
Values are
ororand. minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
-
zero_terms_query string
Values are
noneorall.
-
-
constant_score object
Hide constant_score attributes Show constant_score attributes object
-
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
-
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.
-
-
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
-
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, ormin. -
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
-
score_mode string
Values are
multiply,sum,avg,first,max, ormin.
-
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
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
memoryorindexed. -
validation_method string
Values are
coerce,ignore_malformed, orstrict. -
ignore_unmapped boolean
Set to
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto 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_type string
Values are
arcorplane. -
validation_method string
Values are
coerce,ignore_malformed, orstrict. -
ignore_unmapped boolean
Set to
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto throw an exception if the field is not mapped.
-
-
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, orstrict. -
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
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto 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
typeand not return any documents instead of an error. -
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
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.
-
score_mode string
Values are
none,avg,sum,max, ormin.
-
-
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_typeand not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain theparent_type. -
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
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]
-
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
query_vector array[number]
-
query_vector_builder object
Hide query_vector_builder attribute Show query_vector_builder attribute object
-
text_embedding object
-
-
num_candidates number
The number of nearest neighbor candidates to consider per shard
-
k number
The final number of nearest neighbors to return as top hits
filter object | array[object]
Filters for the kNN search query
-
similarity number
The minimum similarity for a vector to be considered a match
-
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
Hide match_all attributes Show match_all attributes object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
Hide match_none attributes Show match_none attributes object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this 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 (
textorkeyword). -
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
include boolean
Specifies whether the input documents should also be included in the search results returned.
-
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
-
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.
-
unlike array[string | object]
-
version number
-
version_type string
Values are
internal,external,external_gte, orforce.
-
-
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.
-
If
true, match phrase queries are automatically created for multi-term synonyms. -
fields string | array[string]
fuzziness string | number
-
fuzzy_rewrite string
-
fuzzy_transpositions boolean
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). 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
-
operator string
Values are
and,AND,or, orOR. -
prefix_length number
Number of beginning characters left unchanged for fuzzy matching.
-
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, orbool_prefix. -
zero_terms_query string
Values are
allornone.
-
-
nested object
Hide nested attributes Show nested attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
ignore_unmapped boolean
Indicates whether to ignore an unmapped path and not return any documents instead of an error.
-
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
score_mode string
Values are
none,avg,sum,max, ormin.
-
-
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
typeand 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.
-
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_slotfield when multiplepercolatequeries 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
-
ids array[string]
Document IDs listed in the order they are to appear in results. Required if
docsis not specified. -
docs array[object]
Documents listed in the order they are to appear in results. Required if
idsis not specified.
-
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
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. -
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, orOR. -
enable_position_increments boolean
If
true, enable position increments in queries constructed from aquery_stringsearch. -
escape boolean
-
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
fuzziness string | 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,abtoba). -
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
-
phrase_slop number
Maximum number of positions allowed between matching tokens for phrases.
-
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
analyzerparameter. -
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_maxquery. -
time_zone string
-
type string
Values are
best_fields,most_fields,cross_fields,phrase,phrase_prefix, orbool_prefix.
-
-
range object
Returns documents that contain terms within a provided range.
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
saturation object
-
log object
-
linear object
-
sigmoid object
-
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
Hide rule attributes Show rule attributes object
-
script object
Hide script attributes Show script attributes object
-
script_score object
Hide script_score attributes Show script_score attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
min_score number
Documents with a score lower than this floating point number are excluded from the search results.
-
-
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
-
The field to query, which must be a semantic_text field type
-
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
truethe 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. -
If
true, the parser creates a match_phrase query for each multi-position token. -
default_operator string
Values are
and,AND,or, orOR. -
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
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,abtoba). -
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
-
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
-
Hide big attributes Show big attributes object
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
Hide query attributes Show query attributes object
-
-
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
-
Controls the maximum end position permitted in a match.
-
Hide match attributes Show match attributes object
-
-
span_multi object
Hide span_multi attributes Show span_multi attributes object
-
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
-
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
preandpost. -
Hide exclude attributes Show exclude attributes object
-
Hide include attributes Show include attributes object
-
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
-
Array of one or more other span type queries.
-
-
span_term object
Matches spans containing a term.
-
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
-
Hide big attributes Show big attributes object
-
Hide little attributes Show little attributes object
-
-
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
-
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
Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false
-
pruning_config object
-
query_vector object
Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.
-
inference_id string
-
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
Hide terms attributes Show terms attributes object
-
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.
-
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.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper 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
-
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
-
-
explain boolean
If true, returns detailed information about score computation as part of a hit.
-
ext object
Configuration of search extensions defined by Elasticsearch plugins.
Hide ext attributes Show ext attributes object
-
key object
-
stored_fields string | array[string]
-
docvalue_fields array[object]
Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
Hide docvalue_fields attributes Show docvalue_fields attributes object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
format string
Format in which the values are returned.
-
include_unmapped boolean
-
knn object | array[object]
Defines the approximate kNN search to run.
One of: Hide attributes Show attributes
-
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
-
-
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: Hide attributes Show attributes
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
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
boolquery from the terms. Each term except the last is used in atermquery. 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.
-
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.
-
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.
-
similarity number
The minimum similarity for a vector to be considered a match
-
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
Hide collapse attributes Show collapse attributes object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
The number of concurrent requests allowed to retrieve the inner_hits per group
-
collapse object
-
-
docvalue_fields array[object]
-
explain boolean
-
highlight object
-
ignore_unmapped boolean
-
script_fields object
-
seq_no_primary_term boolean
-
fields string | array[string]
-
sort array[string | object]
_source boolean | object
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
Hide attributes Show attributes object
-
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
-
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
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
-
from number
Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
-
highlight object
Hide highlight attributes Show highlight attributes object
-
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, orword. -
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". -
fragmenter string
Values are
simpleorspan. -
fragment_size number
The size of the highlighted fragment in characters.
-
highlight_filter boolean
-
highlight_query object
Hide highlight_query attributes Show highlight_query attributes object
-
bool object
-
boosting object
-
combined_fields object
-
constant_score object
-
dis_max object
-
exists object
-
function_score object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
geo_bounding_box object
-
geo_distance object
-
geo_polygon object
-
geo_shape object
-
has_child object
-
has_parent object
-
ids object
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
knn object
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this object
-
multi_match object
-
nested object
-
parent_id object
-
percolate object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
query_string object
-
range object
Returns documents that contain terms within a provided range.
-
rank_feature object
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
-
script object
-
script_score object
-
semantic object
-
shape object
-
simple_query_string object
-
span_containing object
-
span_field_masking object
-
span_first object
-
span_multi object
-
span_near object
-
span_not object
-
span_or object
-
span_term object
Matches spans containing a term.
-
span_within object
-
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 object
-
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.
-
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.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper object
-
type object
-
-
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_offsetquery setting does not override theindex.highlight.max_analyzed_offsetsetting, 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. Ifnumber_of_fragmentsis0,fragment_sizeis ignored. -
options object
Hide options attributes Show options attributes object
-
key object
-
order string
Value is
score. -
phrase_limit number
Controls the number of matching phrases in a document that are considered. Prevents the
fvhhighlighter from analyzing too many phrases and consuming too much memory. When usingmatched_fields,phrase_limitphrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by thefvhhighlighter. -
post_tags array[string]
Use in conjunction with
pre_tagsto define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in<em>and</em>tags. -
pre_tags array[string]
Use in conjunction with
post_tagsto define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in<em>and</em>tags. -
require_field_match boolean
By default, only fields that contains a query match are highlighted. Set to
falseto highlight all fields. -
tags_schema string
Value is
styled. -
encoder string
Values are
defaultorhtml.
-
indices_boost array[object]
Boosts the _score of documents from specified indices.
Hide indices_boost attributes Show indices_boost attributes object
-
key number
-
min_score number
Minimum _score for matching documents. Documents with a lower _score are not included in the search results.
-
post_filter object
Hide post_filter attributes Show post_filter attributes object
-
bool object
Hide bool attributes Show bool attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
filter object | array[object]
The clause (query) must appear in matching documents. However, unlike
must, the score of the query will be ignored.minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
must object | array[object]
The clause (query) must appear in matching documents and will contribute to the score.
must_not object | array[object]
The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of
0is returned for all documents.should object | array[object]
The clause (query) should appear in the matching document.
-
-
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
-
Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the
negativequery.
-
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
Text to search for in the provided
fields. Thecombined_fieldsquery analyzes the provided text before performing a search. -
If true, match phrase queries are automatically created for multi-term synonyms.
-
operator string
Values are
ororand. minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
-
zero_terms_query string
Values are
noneorall.
-
-
constant_score object
Hide constant_score attributes Show constant_score attributes object
-
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
-
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.
-
-
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
-
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, ormin. -
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
-
score_mode string
Values are
multiply,sum,avg,first,max, ormin.
-
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
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
memoryorindexed. -
validation_method string
Values are
coerce,ignore_malformed, orstrict. -
ignore_unmapped boolean
Set to
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto 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_type string
Values are
arcorplane. -
validation_method string
Values are
coerce,ignore_malformed, orstrict. -
ignore_unmapped boolean
Set to
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto throw an exception if the field is not mapped.
-
-
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, orstrict. -
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
trueto ignore an unmapped field and not match any documents for this query. Set tofalseto 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
typeand not return any documents instead of an error. -
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
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.
-
score_mode string
Values are
none,avg,sum,max, ormin.
-
-
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_typeand not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain theparent_type. -
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
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]
-
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
query_vector array[number]
-
query_vector_builder object
Hide query_vector_builder attribute Show query_vector_builder attribute object
-
text_embedding object
-
-
num_candidates number
The number of nearest neighbor candidates to consider per shard
-
k number
The final number of nearest neighbors to return as top hits
filter object | array[object]
Filters for the kNN search query
-
similarity number
The minimum similarity for a vector to be considered a match
-
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
Hide match_all attributes Show match_all attributes object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
Hide match_none attributes Show match_none attributes object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this 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 (
textorkeyword). -
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
include boolean
Specifies whether the input documents should also be included in the search results returned.
-
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
-
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.
-
unlike array[string | object]
-
version number
-
version_type string
Values are
internal,external,external_gte, orforce.
-
-
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.
-
If
true, match phrase queries are automatically created for multi-term synonyms. -
fields string | array[string]
fuzziness string | number
-
fuzzy_rewrite string
-
fuzzy_transpositions boolean
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). 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
-
operator string
Values are
and,AND,or, orOR. -
prefix_length number
Number of beginning characters left unchanged for fuzzy matching.
-
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, orbool_prefix. -
zero_terms_query string
Values are
allornone.
-
-
nested object
Hide nested attributes Show nested attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
ignore_unmapped boolean
Indicates whether to ignore an unmapped path and not return any documents instead of an error.
-
inner_hits object
Hide inner_hits attributes Show inner_hits attributes object
-
name string
-
size number
The maximum number of hits to return per
inner_hits. -
from number
Inner hit starting document offset.
-
collapse object
-
docvalue_fields array[object]
-
explain boolean
-
ignore_unmapped boolean
-
seq_no_primary_term boolean
-
fields string | array[string]
-
stored_fields string | array[string]
-
track_scores boolean
-
version boolean
-
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
score_mode string
Values are
none,avg,sum,max, ormin.
-
-
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
typeand 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.
-
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_slotfield when multiplepercolatequeries 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
-
ids array[string]
Document IDs listed in the order they are to appear in results. Required if
docsis not specified. -
docs array[object]
Documents listed in the order they are to appear in results. Required if
idsis not specified.
-
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
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. -
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, orOR. -
enable_position_increments boolean
If
true, enable position increments in queries constructed from aquery_stringsearch. -
escape boolean
-
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
fuzziness string | 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,abtoba). -
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
-
phrase_slop number
Maximum number of positions allowed between matching tokens for phrases.
-
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
analyzerparameter. -
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_maxquery. -
time_zone string
-
type string
Values are
best_fields,most_fields,cross_fields,phrase,phrase_prefix, orbool_prefix.
-
-
range object
Returns documents that contain terms within a provided range.
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
saturation object
-
log object
-
linear object
-
sigmoid object
-
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
Hide rule attributes Show rule attributes object
-
script object
Hide script attributes Show script attributes object
-
script_score object
Hide script_score attributes Show script_score attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
min_score number
Documents with a score lower than this floating point number are excluded from the search results.
-
-
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
-
The field to query, which must be a semantic_text field type
-
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
truethe 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. -
If
true, the parser creates a match_phrase query for each multi-position token. -
default_operator string
Values are
and,AND,or, orOR. -
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
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,abtoba). -
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
-
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
-
Hide big attributes Show big attributes object
-
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
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
Hide query attributes Show query attributes object
-
-
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
-
Controls the maximum end position permitted in a match.
-
Hide match attributes Show match attributes object
-
-
span_multi object
Hide span_multi attributes Show span_multi attributes object
-
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
-
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
preandpost. -
Hide exclude attributes Show exclude attributes object
-
Hide include attributes Show include attributes object
-
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
-
Array of one or more other span type queries.
-
-
span_term object
Matches spans containing a term.
-
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
-
Hide big attributes Show big attributes object
-
Hide little attributes Show little attributes object
-
-
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
-
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
Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false
-
pruning_config object
-
query_vector object
Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.
-
inference_id string
-
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
Hide terms attributes Show terms attributes object
-
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.
-
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.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper 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
-
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
-
-
profile boolean
rescore object | array[object]
One of: Hide attributes Show attributes
-
window_size number
-
query object
Hide query attributes Show query attributes object
-
query_weight number
Relative importance of the original query versus the rescore query.
-
rescore_query_weight number
Relative importance of the rescore query versus the original query.
-
score_mode string
Values are
avg,max,min,multiply, ortotal.
-
learning_to_rank object
Hide attributes Show attributes object
-
window_size number
-
query object
-
learning_to_rank object
-
-
script_fields object
Hide script_fields attributes Show script_fields attributes object
-
Hide script attributes Show script attributes object
-
source string
The script source.
-
id string
-
params object
Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
Hide params attributes Show params attributes object
-
key object
-
options object
Hide options attributes Show options attributes object
-
key string
-
-
ignore_failure boolean
-
search_after array[number | string | boolean | null | object]
-
size number
The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
sort string | object | array[string | object]
One of: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes
-
_score object
Hide _score attribute Show _score attribute object
-
order string
Values are
ascordesc.
-
-
_doc object
Hide _doc attribute Show _doc attribute object
-
order string
Values are
ascordesc.
-
-
_geo_distance object
Hide _geo_distance attributes Show _geo_distance attributes object
-
mode string
Values are
min,max,sum,avg, ormedian. -
distance_type string
Values are
arcorplane. -
ignore_unmapped boolean
-
order string
Values are
ascordesc. -
unit string
Values are
in,ft,yd,mi,nmi,km,m,cm, ormm. -
nested object
-
-
_script object
One of: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes
-
_score object
-
_doc object
-
_geo_distance object
-
_script object
-
-
fields array[object]
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
Hide fields attributes Show fields attributes object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
format string
Format in which the values are returned.
-
include_unmapped boolean
-
-
terminate_after number
Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.
-
stats array[string]
Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
-
timeout string
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
-
track_scores boolean
If true, calculate and return document scores, even if the scores are not used for sorting.
-
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.
-
version boolean
If true, returns document version as part of a hit.
-
runtime_mappings object
Hide runtime_mappings attributes Show runtime_mappings attributes object
-
fields object
Hide fields attributes Show fields attributes object
-
Values are
boolean,composite,date,double,geo_point,ip,keyword,long, orlookup.
-
fetch_fields array[object]
For type
lookup -
format string
A custom format for
datetype runtime fields. -
input_field string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
target_field string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
target_index string
-
script object
Hide script attributes Show script attributes object
-
source string
The script source.
-
id string
-
params object
Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
Hide params attributes Show params attributes object
-
key object
-
options object
Hide options attributes Show options attributes object
-
key string
-
-
Values are
boolean,composite,date,double,geo_point,ip,keyword,long, orlookup.
-
seq_no_primary_term boolean
If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.
-
pit object
Hide pit attributes Show pit attributes object
-
keep_alive string
A duration. Units can be
nanos,micros,ms(milliseconds),s(seconds),m(minutes),h(hours) andd(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
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
-
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
One of: Hide attributes Show attributes
-
Hide _shards attributes Show _shards attributes object
-
aggregations object
-
_clusters object
-
fields object
Hide fields attributes Show fields attributes object
-
key object
-
max_score number
-
num_reduce_phases number
-
profile object
Hide profile attribute Show profile attribute object
-
pit_id string
-
_scroll_id string
-
suggest object
Hide suggest attributes Show suggest attributes object
-
key array
-
terminated_early boolean
-
status number
Hide attributes Show attributes
-
Hide error attributes Show error attributes object
-
The type of error
-
reason string
A human-readable explanation of the error, in english
-
stack_trace string
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_by object
-
root_cause array[object]
-
suppressed array[object]
-
curl \
-X POST http://api.example.com/{index}/_msearch \
-H "Content-Type: application/json" \
-d '[{"allow_no_indices":true,"expand_wildcards":"string","ignore_unavailable":true,"index":"string","preference":"string","request_cache":true,"routing":"string","search_type":"query_then_fetch","ccs_minimize_roundtrips":true,"allow_partial_search_results":true,"ignore_throttled":true}]'