[[reference-rank_eval]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.rankEval

Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries.

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

[discrete]
==== Function signature

[source,ts]
----
(RankEvalRequest, options?): Promise<RankEvalResponse>
----

[discrete]
===== `RankEvalRequest`

[source,ts]
----
interface RankEvalRequest extends <<shared-type-request-base, RequestBase>> {
  index?: <<shared-type-indices, Indices>>
  allow_no_indices?: boolean
  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
  ignore_unavailable?: boolean
  search_type?: string
  requests: RankEvalRankEvalRequestItem[]
  metric?: RankEvalRankEvalMetric
}
----

[discrete]
===== `RankEvalResponse`

[source,ts]
----
interface RankEvalResponse {
  metric_score: <<shared-type-double, double>>
  details: Record<<<shared-type-id, Id>>, RankEvalRankEvalMetricDetail>
  failures: Record<string, any>
}
----