# Evaluate data frame analytics

**POST /_ml/data_frame/_evaluate**

The API packages together commonly used evaluation metrics for various types
of machine learning features. This has been designed for use on indexes
created by data frame analytics. Evaluation requires both a ground truth
field and an analytics result field to be present.

## Required authorization

* Cluster privileges: `monitor_ml`



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


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


## Parameters



### Body: application/json (object)

- **evaluation** (object)
  Defines the type of evaluation you want to perform.
- **index** (string)
  Defines the `index` in which the evaluation will be performed.
- **query** (object)
  A query clause that retrieves a subset of data from the source index.


## Responses
### 200


#### Body: application/json (object)
- **classification** (object)
  Evaluation results for a classification analysis.
  It outputs a prediction that identifies to which of the classes each document belongs.
- **outlier_detection** (object)
  Evaluation results for an outlier detection analysis.
  It outputs the probability that each document is an outlier.
- **regression** (object)
  Evaluation results for a regression analysis which outputs a prediction of values.


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