# Evaluate ranked search results


**POST /{index}/_rank_eval**

**All methods and paths for this operation:**

<div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_rank_eval</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_rank_eval</span>
                      </div>
                    <div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/{index}/_rank_eval</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/{index}/_rank_eval</span>
                      </div>
                    

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

## Required authorization

* Index privileges: `read`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **index** (string | array[string])
  A  comma-separated list of data streams, indices, and index aliases used to limit the request.
  Wildcard (`*`) expressions are supported.
  To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.

### Query parameters
- **allow_no_indices** (boolean)
  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`.
- **expand_wildcards** (string | array[string])
  Whether to expand wildcard expression to concrete indices that are open, closed or both.

  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.

- **ignore_unavailable** (boolean)
  If `true`, missing or closed indices are not included in the response.
- **search_type** (string)
  Search operation type

### Body: application/json (object)

- **requests** (array[object])
  A set of typical search requests, together with their provided ratings.
- **metric** (object)
  Definition of the evaluation metric to calculate.


## Responses
### 200


#### Body: application/json (object)
- **metric_score** (number)
  The overall evaluation quality calculated by the defined metric
- **details** (object)
  The details section contains one entry for every query in the original requests section, keyed by the search request id
- **failures** (object)



[Powered by Bump.sh](https://bump.sh)