[Docs] Add option to reference stored templates for `_rank_eval` requests

The option to use templates already defined in the cluster is not explicitly stated in the docs.
This PR adds and example to the `rank_eval` documentation.
This commit is contained in:
Simon 2020-12-10 15:08:43 +01:00 committed by Christoph Büscher
parent 95dbc6d448
commit 9bf6d055eb
1 changed files with 22 additions and 0 deletions

View File

@ -202,6 +202,28 @@ GET /my-index-000001/_rank_eval
<3> a reference to a previously defined template
<4> the parameters to use to fill the template
It is also possible to use <<pre-registered-templates,templates already stored>> in the cluster state by referencing their id in the templates section.
[source,js]
--------------------------------
GET /my_index/_rank_eval
{
[...]
"templates": [
{
"id": "match_one_field_query", <1>
"template": { <2>
"id": "match_one_field_query"
}
}
],
"requests": [...]
}
--------------------------------
// NOTCONSOLE
<1> the template id used for requests
<2> the template id stored in the cluster state
===== Available evaluation metrics