[[reference-search_template]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.searchTemplate

Run a search with a search template.

{ref}/search-template.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SearchTemplateRequest, options?): Promise<SearchTemplateResponse>
----

[discrete]
===== `SearchTemplateRequest`

[source,ts]
----
interface SearchTemplateRequest extends <<shared-type-request-base, RequestBase>> {
  index?: <<shared-type-indices, Indices>>
  allow_no_indices?: boolean
  ccs_minimize_roundtrips?: boolean
  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
  ignore_throttled?: boolean
  ignore_unavailable?: boolean
  preference?: string
  routing?: <<shared-type-routing, Routing>>
  scroll?: <<shared-type-duration, Duration>>
  search_type?: <<shared-type-search-type, SearchType>>
  rest_total_hits_as_int?: boolean
  typed_keys?: boolean
  explain?: boolean
  id?: <<shared-type-id, Id>>
  params?: Record<string, any>
  profile?: boolean
  source?: string
}
----

[discrete]
===== `SearchTemplateResponse`

[source,ts]
----
interface SearchTemplateResponse<TDocument = unknown> {
  took: <<shared-type-long, long>>
  timed_out: boolean
  _shards: <<shared-type-shard-statistics, ShardStatistics>>
  hits: SearchHitsMetadata<TDocument>
  aggregations?: Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>
  _clusters?: <<shared-type-cluster-statistics, ClusterStatistics>>
  fields?: Record<string, any>
  max_score?: <<shared-type-double, double>>
  num_reduce_phases?: <<shared-type-long, long>>
  profile?: SearchProfile
  pit_id?: <<shared-type-id, Id>>
  _scroll_id?: <<shared-type-scroll-id, ScrollId>>
  suggest?: Record<<<shared-type-suggestion-name, SuggestionName>>, SearchSuggest<TDocument>[]>
  terminated_early?: boolean
}
----