Files
elasticsearch-js/docs/reference-render_search_template.asciidoc
2024-12-05 14:46:52 -06:00

77 lines
4.0 KiB
Plaintext

[[reference-render_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.renderSearchTemplate]]
=== client.renderSearchTemplate
Render a search template. Render a search template as a search request body.
{ref}/render-search-template-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(RenderSearchTemplateRequest, options?): Promise<RenderSearchTemplateResponse>
----
[discrete]
==== RenderSearchTemplateRequest
[pass]
++++
<pre>
++++
interface RenderSearchTemplateRequest extends <<RequestBase>> {
id?: <<Id>>
file?: string
params?: Record<string, any>
source?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== RenderSearchTemplateResponse
[pass]
++++
<pre>
++++
interface RenderSearchTemplateResponse {
template_output: Record<string, any>
}
[pass]
++++
</pre>
++++