Interface RunCreateResponse

A schema representing an evaluation run.

interface RunCreateResponse {
    created_at: number;
    data_source: CreateEvalCompletionsRunDataSource | CreateEvalJSONLRunDataSource;
    error: EvalAPIError;
    eval_id: string;
    id: string;
    metadata: null | Metadata;
    model: string;
    name: string;
    object: "eval.run";
    per_model_usage: OpenAIClient.Evals.Runs.RunCreateResponse.PerModelUsage[];
    per_testing_criteria_results: OpenAIClient.Evals.Runs.RunCreateResponse.PerTestingCriteriaResult[];
    report_url: string;
    result_counts: OpenAIClient.Evals.Runs.RunCreateResponse.ResultCounts;
    status: string;
}

Properties

created_at data_source error eval_id id metadata model name object per_model_usage per_testing_criteria_results report_url result_counts status

Properties

created_at

created_at: number

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

data_source

data_source: CreateEvalCompletionsRunDataSource | CreateEvalJSONLRunDataSource

Information about the run's data source.

error

error: EvalAPIError

An object representing an error response from the Eval API.

eval_id

eval_id: string

The identifier of the associated evaluation.

id

id: string

Unique identifier for the evaluation run.

metadata

metadata: null | Metadata

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.

model

model: string

The model that is evaluated, if applicable.

name

name: string

The name of the evaluation run.

object

object: "eval.run"

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

per_model_usage

per_model_usage: OpenAIClient.Evals.Runs.RunCreateResponse.PerModelUsage[]

Usage statistics for each model during the evaluation run.

per_testing_criteria_results

per_testing_criteria_results: OpenAIClient.Evals.Runs.RunCreateResponse.PerTestingCriteriaResult[]

Results per testing criteria applied during the evaluation run.

report_url

report_url: string

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

result_counts

result_counts: OpenAIClient.Evals.Runs.RunCreateResponse.ResultCounts

Counters summarizing the outcomes of the evaluation run.

status

status: string

The status of the evaluation run.

Settings

Member Visibility

On This Page

Properties