Swagger Petstore - OpenAPI 3.0
POST/evals/{eval_id}

Update an evaluation

Updates one or more properties of an existing evaluation. Supply only the fields you want to change — name and metadata are optional. All other evaluation properties such as data source configuration and testing criteria cannot be modified after creation.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

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

Partial evaluation update. All fields are optional.

namestringoptional
Rename the evaluation.
metadataobjectoptional
Optional set of up to 16 key-value pairs for storing additional structured information. Keys are strings with a maximum length of 64 characters.

2 status codes
200Returns the updated evaluation object with all current properties including 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 rate limit is exceeded.
errorobjectrequired

Error handling

eval_id must identify an existing evaluation. A 429 is returned when the request rate limit is exceeded.