Sign in

v3

latestOpenAPI 3.1.02026-08-07115219269.8 KB
evals

Update Evaluation

Update an existing evaluation

put/api/v1/evaluations/{evaluation_id}

Path parameters

evaluation_idstring required

Request body

namestring nullable

Name of the evaluation

descriptionstring nullable

Description of the evaluation

tagsstring[] nullable

Tags for categorization

metadataobject nullable

Additional metadata

metricsobject nullable

High-level metrics summary

model_namestring nullable

Model name

datasetstring nullable

Dataset name

frameworkstring nullable

Framework used

task_typestring nullable

Type of task

inference_modelstring nullable

Prime Inference model ID

is_publicboolean nullable

Whether the evaluation is publicly shareable by link; setting true without show_on_leaderboard keeps it off leaderboards by default

show_on_leaderboardboolean nullable

Whether this public evaluation appears on environment leaderboards

Response

Successful Response

evaluation_idstring required
namestring required
status'PENDING' | 'RUNNING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'TIMEOUT' | 'CANCELLED' required

Evaluation status enum

updated_atstring date-time required