Skip to main content
POST
/
evals
/
{eval_id}
Error
A valid request URL is required to generate request examples
{
  "object": "eval",
  "id": "<string>",
  "name": "<string>",
  "data_source_config": {},
  "testing_criteria": null,
  "created_at": 123,
  "metadata": {}
}

Authorizations

​
api-key
string
header
required

Headers

​
aoai-evals
enum<string>
required

Enables access to AOAI Evals, a preview feature. This feature requires the 'aoai-evals' header to be set to 'preview'.

Available options:
preview

Path Parameters

​
eval_id
string
required

Query Parameters

​
api-version
enum<string>
default:v1

The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.

Available options:
v1,
preview

Body

application/json
​
name
string
​
metadata
object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Response

The request has succeeded.

An Eval object with a data source config and testing criteria. An Eval represents a task to be done for your LLM integration. Like:

  • Improve the quality of my chatbot
  • See how well my chatbot handles customer support
  • Check if o4-mini is better at my usecase than gpt-4o
​
object
enum<string>
default:eval
required

The object type.

Available options:
eval
​
id
string
required

Unique identifier for the evaluation.

​
name
string
required

The name of the evaluation.

​
data_source_config
object
required

Configuration of data sources used in runs of the evaluation.

​
testing_criteria
object[] | null
required

A list of testing criteria.

​
created_at
integer<unixtime>
required

The Unix timestamp (in seconds) for when the eval was created.

​
metadata
object
required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.