All methods and paths for this operation:
readA comma-separated list of data streams, indices, and aliases to search.
It supports wildcards (*).
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.
If true, network round-trips are minimized for cross-cluster search requests.
The type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as open,hidden.
Supported values include:
all: Match any data stream or index, including hidden ones.open: Match open, non-hidden indices. Also matches any non-hidden data stream.closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.none: Wildcard expressions are not accepted.Values are all, open, closed, hidden, or none.
If true, the response includes additional details about score computation as part of a hit.
If true, specified concrete, expanded, or aliased indices are not included in the response when throttled.
If false, the request returns an error if it targets a missing or closed index.
The node or shard the operation should be performed on. It is random by default.
If true, the query execution is profiled.
A custom value used to route operations to a specific shard.
Specifies how long a consistent view of the index should be maintained for scrolled search.
Values are -1 or 0.
The type of the search operation.
Supported values include:
query_then_fetch: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.dfs_query_then_fetch: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.Values are query_then_fetch or dfs_query_then_fetch.
If true, hits.total is rendered as an integer in the response.
If false, it is rendered as an object.
If true, the response prefixes aggregation and suggester names with their respective types.
If true, returns detailed information about score calculation as part of each hit.
If you specify both this and the explain query parameter, the API uses only the query parameter.
Default value is false.
Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.
If true, the query execution is profiled.
Default value is false.
Defines the aggregations that are run as part of the search request.
If true, the request returns detailed information about score computation as part of a hit.
Default value is false.
Configuration of search extensions defined by Elasticsearch plugins.
The starting document offset, which must be non-negative.
By default, you cannot page through more than 10,000 hits using the from and size parameters.
To page through more hits, use the search_after parameter.
Default value is 0.
A string that contains each boundary character.
Default value is .,!? \t\n.
How far to scan for boundary characters.
Default value is 20.
Values are chars, sentence, or word.
Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".
Default value is Locale.ROOT.
Values are simple or span.
The size of the highlighted fragment in characters.
Default value is 100.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.
The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.
Default value is 0.
The maximum number of fragments to return.
If the number of fragments is set to 0, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If number_of_fragments is 0, fragment_size is ignored.
Default value is 5.
Value is score.
Controls the number of matching phrases in a document that are considered.
Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory.
When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the fvh highlighter.
Default value is 256.
Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in <em> and </em> tags.
Use in conjunction with post_tags to define the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in <em> and </em> tags.
By default, only fields that contains a query match are highlighted.
Set to false to highlight all fields.
Default value is true.
Value is styled.
Values are default or html.
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.
Boost the _score of documents from specified indices.
The boost value is the factor by which scores are multiplied.
A boost value greater than 1.0 increases the score.
A boost value between 0 and 1.0 decreases the score.
An array of wildcard (*) field patterns.
The request returns doc values for field names matching these patterns in the hits.fields property of the response.
A reference to a field with formatting instructions on how to return the value
The approximate kNN search to run.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
The final number of nearest neighbors to return as top hits
The number of nearest neighbor candidates to consider per shard
Boost value to apply to kNN scores
Filters for the kNN search query
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
The minimum similarity for a vector to be considered a match
The maximum number of hits to return per inner_hits.
Default value is 3.
Inner hit starting document offset.
Default value is 0.
A reference to a field with formatting instructions on how to return the value
A reference to a field with formatting instructions on how to return the value
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Default value is false.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
The final number of nearest neighbors to return as top hits
The number of nearest neighbor candidates to consider per shard
Boost value to apply to kNN scores
The minimum similarity for a vector to be considered a match
The maximum number of hits to return per inner_hits.
Default value is 3.
Inner hit starting document offset.
Default value is 0.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Default value is false.
The minimum _score for matching documents.
Documents with a lower _score are not included in search results or results collected by aggregations.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
Set to true to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution.
Default value is false.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
Relative importance of the original query versus the rescore query.
Default value is 1.
Relative importance of the rescore query versus the original query.
Default value is 1.
Values are avg, max, min, multiply, or total.
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
A field value.
Maximum number of documents to collect for each shard.
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
The name of the vector field to search against.
Number of nearest neighbors to return as top hits.
Number of nearest neighbor candidates to consider per shard.
The minimum similarity required for a document to be considered a match.
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
This value determines how much influence documents in individual result sets per query have over the final ranked result set.
This value determines the size of the individual result sets per query.
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
This value determines how many documents we will consider from the nested retriever.
Unique identifier of the inference endpoint created using the inference API.
The text snippet used as the basis for similarity comparison
The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
The match criteria that will determine if a rule in the provided rulesets should be applied.
This value determines the size of the individual result set.
Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
Retriever name.
Inner retrievers.
Retrieve a script evaluation (based on different fields) for each hit.
A field value.
The number of hits to return, which must not be negative.
By default, you cannot page through more than 10,000 hits using the from and size parameters.
To page through more hits, use the search_after property.
Default value is 10.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
An array of wildcard (*) field patterns.
The request returns values for field names matching these patterns in the hits.fields property of the response.
A reference to a field with formatting instructions on how to return the value
The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
If set to 0 (default), the query does not terminate early.
Default value is 0.
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.
If true, calculate and return document scores, even if the scores are not used for sorting.
Default value is false.
If true, the request returns the document version as part of a hit.
Default value is false.
If true, the request returns sequence number and primary term of the last modification of each hit.
For type composite
For type lookup
A custom format for date type runtime fields.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
The type of error
The server stack trace. Present only if the error_trace=true parameter was sent with the request.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Values are running, successful, partial, skipped, or failed.
Time unit for milliseconds
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and
d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
Time unit for nanoseconds
GET my-index/_search/template
{
"id": "my-search-template",
"params": {
"query_string": "hello world",
"from": 0,
"size": 10
}
}resp = client.search_template(
index="my-index",
id="my-search-template",
params={
"query_string": "hello world",
"from": 0,
"size": 10
},
)const response = await client.searchTemplate({
index: "my-index",
id: "my-search-template",
params: {
query_string: "hello world",
from: 0,
size: 10,
},
});response = client.search_template(
index: "my-index",
body: {
"id": "my-search-template",
"params": {
"query_string": "hello world",
"from": 0,
"size": 10
}
}
)$resp = $client->searchTemplate([
"index" => "my-index",
"body" => [
"id" => "my-search-template",
"params" => [
"query_string" => "hello world",
"from" => 0,
"size" => 10,
],
],
]);curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"id":"my-search-template","params":{"query_string":"hello world","from":0,"size":10}}' "$ELASTICSEARCH_URL/my-index/_search/template"client.searchTemplate(s -> s
.id("my-search-template")
.index("my-index")
.params(Map.of("size", JsonData.fromJson("10"),"from", JsonData.fromJson("0"),"query_string", JsonData.fromJson("\"hello world\"")))
);
{
"id": "my-search-template",
"params": {
"query_string": "hello world",
"from": 0,
"size": 10
}
}