elasticsearch-js/docs/reference/api/AsyncSearchSubmitRequest.md

AsyncSearchSubmitRequest [interface-AsyncSearchSubmitRequest]

Name	Type	Description
_source_excludes	Fields	A list of fields to exclude from the returned _source field
_source_includes	Fields	A list of fields to extract and return from the _source field
_source	SearchSourceConfig	Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.
aggregations	Record<string, AggregationsAggregationContainer>
aggs	Record<string, AggregationsAggregationContainer>	aggregations
allow_no_indices	boolean	Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)
allow_partial_search_results	boolean	Indicate if an error should be returned if there is a partial search failure or timeout
analyze_wildcard	boolean	Specify whether wildcard and prefix queries should be analyzed (default: false)
analyzer	string	The analyzer to use for the query string
batched_reduce_size	long	Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).
body	string	({ [key: string]: any; } & { index?: never; wait_for_completion_timeout?: never; keep_alive?: never; keep_on_completion?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; request_cache?: never; routing?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; })
ccs_minimize_roundtrips	boolean	The default value is the only supported value.
collapse	SearchFieldCollapse
default_operator	QueryDslOperator	The default operator for query string query (AND or OR)
df	string	The field to use as default where no field prefix is given in the query string
docvalue_fields	(QueryDslFieldAndFormat	Field)[]
expand_wildcards	ExpandWildcards	Whether to expand wildcard expression to concrete indices that are open, closed or both.
explain	boolean	If true, returns detailed information about score computation as part of a hit.
ext	Record<string, any>	Configuration of search extensions defined by Elasticsearch plugins.
fields	(QueryDslFieldAndFormat	Field)[]
from	integer	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	SearchHighlight
ignore_throttled	boolean	Whether specified concrete, expanded or aliased indices should be ignored when throttled
ignore_unavailable	boolean	Whether specified concrete indices should be ignored when unavailable (missing or closed)
index	Indices	A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices
indices_boost	Partial<Record<IndexName, double>>[]	Boosts the _score of documents from specified indices.
keep_alive	Duration	Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.
keep_on_completion	boolean	If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout.
knn	KnnSearch	KnnSearch[]
lenient	boolean	Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
max_concurrent_shard_requests	integer	The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
min_score	double	Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.
pit	SearchPointInTimeReference	Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path.
post_filter	QueryDslQueryContainer
preference	string	Specify the node or shard the operation should be performed on (default: random)
profile	boolean
q	string	Query in the Lucene query string syntax
query	QueryDslQueryContainer	Defines the search definition using the Query DSL.
querystring	{ [key: string]: any; } & { index?: never; wait_for_completion_timeout?: never; keep_alive?: never; keep_on_completion?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; request_cache?: never; routing?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; }	All values in querystring will be added to the request querystring.
request_cache	boolean	Specify if request cache should be used for this request or not, defaults to true
rescore	SearchRescore	SearchRescore[]
rest_total_hits_as_int	boolean	Indicates whether hits.total should be rendered as an integer or an object in the rest search response
routing	Routing	A comma-separated list of specific routing values
runtime_mappings	MappingRuntimeFields	Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.
script_fields	Record<string, ScriptField>	Retrieve a script evaluation (based on different fields) for each hit.
search_after	SortResults
search_type	SearchType	Search operation type
seq_no_primary_term	boolean	If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.
size	integer	The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
slice	SlicedScroll
sort	Sort
stats	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.
stored_fields	Fields	List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.
suggest_field	Field	Specifies which field to use for suggestions.
suggest_mode	SuggestMode	Specify suggest mode
suggest_size	long	How many suggestions to return in response
suggest_text	string	The source text for which the suggestions should be returned.
suggest	SearchSuggester
terminate_after	long	Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.
timeout	string	Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
track_scores	boolean	If true, calculate and return document scores, even if the scores are not used for sorting.
track_total_hits	SearchTrackHits	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.
typed_keys	boolean	Specify whether aggregation and suggester names should be prefixed by their respective types in the response
version	boolean	If true, returns document version as part of a hit.
wait_for_completion_timeout	Duration	Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.