Evaluations

Update Evaluation Run

Update an Evaluation Run.

Specify control=true to use this Run as the control Run for the Evaluation. You can cancel a running/pending Run, or mark a Run that uses external or human Evaluators as completed.

patch/evaluations/{id}/runs/{run_id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/evaluations/{id}/runs/{run_id}
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

Unique identifier for Evaluation.

run_idstring required

Unique identifier for Run.

Request body

controlboolean

If True, this Run will be used as the control in the Evaluation. Stats for other Runs will be compared to this Run. This will replace any existing control Run.

status'pending' | 'running' | 'completed' | 'cancelled'

Status of an evaluation.

Response

Successful Response

idstring required

Unique identifier for the Run.

orchestratedboolean required

Whether the Run is orchestrated by Humanloop.

added_atstring date-time required

When the Run was added to the Evaluation.

created_atstring date-time required

When the Run was created.

created_byunknown
status'pending' | 'running' | 'completed' | 'cancelled' required

Status of an evaluation.

controlboolean required

Stats for other Runs will be displayed in comparison to the control Run.

Changes

No recorded changes to this operation across all 1 revision of this API.