Sign in

v3

latestSwagger 2.02026-07-132961114.8 KB
Evals

Create evaluation run

post/openai/evals/{eval_id}/runs

Path parameters

eval_idstring required

The ID of the evaluation to create a run for.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

namestring

The name of the run.

metadataOpenAIMetadata

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.

{"stackTrail":"components:schemas:CreateEvalRunRequest:properties:data_source","oasType":"schema","type":"unknown","description":"Details about the run's data source."}
propertiesobject

Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Response

The request has succeeded.

object'eval.run' required

The type of the object. Always "eval.run".

idstring required

Unique identifier for the evaluation run.

eval_idstring required

The identifier of the associated evaluation.

statusstring required

The status of the evaluation run.

modelstring required

The model that is evaluated, if applicable.

namestring required

The name of the evaluation run.

created_atinteger required

Unix timestamp (in seconds) when the evaluation run was created.

report_urlstring required

The URL to the rendered evaluation run report on the UI dashboard.

{"stackTrail":"components:schemas:EvalRun:properties:data_source","oasType":"schema","type":"unknown","description":"Information about the run's data source."}
metadataOpenAIMetadata required

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.

modified_atinteger
created_bystring

the name of the person who created the run.

propertiesobject

Set of immutable 16 key-value pairs that can be attached to an object for storing additional information. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.