Skip to main content
POST
/
evaluations
/
runs:run
{
  "id": "<string>",
  "data": {
    "type": "<string>"
  },
  "displayName": "<string>",
  "description": "<string>",
  "status": "<string>",
  "tags": {},
  "properties": {},
  "evaluators": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
api-version
string
required

The API version to use for this operation.

Minimum length: 1

Body

application/json

Evaluation to be run

Evaluation Definition

​
data
object
required
​
evaluators
object
required

Evaluators to be used for the evaluation.

​
displayName
string

Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.

​
description
string

Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.

​
tags
object

Evaluation's tags. Unlike properties, tags are fully mutable.

​
properties
object

Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

Response

The request has succeeded and a new resource has been created as a result.

Evaluation Definition

​
id
string
required

Identifier of the evaluation.

​
data
object
required
​
evaluators
object
required

Evaluators to be used for the evaluation.

​
displayName
string

Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.

​
description
string

Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.

​
status
string

Status of the evaluation. It is set by service and is read-only.

​
tags
object

Evaluation's tags. Unlike properties, tags are fully mutable.

​
properties
object

Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.