Sample - OpenAI API
POST/evals/{eval_id}

Update an evaluation

Updates selected properties of an existing evaluation. Supply name to rename it or metadata to replace its attached metadata without changing the evaluation's data source configuration or testing criteria.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 2 body fields
eval_idstringrequired
The unique identifier of the evaluation to update.

Properties to update on an evaluation; omitted properties remain unchanged.

namestringoptional
Rename the evaluation.
metadataobjectoptional
Metadata to attach to the evaluation. Use at most 16 entries, with keys of no more than 64 characters and string values, or set it to null.

2 status codes
200Returns the updated evaluation object with its identifier, name, data source configuration, testing criteria, creation timestamp, and metadata.
objectstringrequired
The object type.
Allowed:evalDefault:eval
idstringrequired
Unique identifier for the evaluation.
namestringrequired
The name of the evaluation.
data_source_configobjectrequired
Configuration of data sources used in runs of the evaluation.
testing_criteriaarray<LabelModelGrader>required
A list of testing criteria.
created_atintegerrequired
The Unix timestamp (in seconds) for when the eval was created.
metadataobjectrequired
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.
429Returned when the request is rejected because the rate limit has been exceeded.
errorobjectrequired

Error handling

eval_id must identify the evaluation to update. metadata may contain up to 16 key-value pairs with keys limited to 64 characters and string values, or be set to null. A 429 is returned when the request is rejected because the rate limit has been exceeded.