Update Status

PATCH

Update the status of an evaluation run.

Can only be used to update the status of an evaluation run that uses external or human evaluators. The evaluation must currently have status ‘running’ if switching to completed, or it must have status ‘completed’ if switching back to ‘running’.

Path parameters

idstringRequired

String ID of evaluation run. Starts with ev_.

Request

This endpoint expects an object.
statusenumRequired
Allowed values: pendingrunningcompletedcancelled

The new status of the evaluation.

Response

Successful Response

idstring

Unique ID for the evaluation. Starts with ev_.

statusenum
Allowed values: pendingrunningcompletedcancelled

Status of an evaluation.

configobject
created_atdatetime
updated_atdatetime
evaluatorslist of objects
datasetobject
dataset_version_idstring
dataset_snapshotobjectOptional
evaluator_aggregateslist of objectsOptional

Errors