class

OpenAI::EvalRun

Inherits JSON::Serializable < Reference < Object

A schema representing an evaluation run.

Constructors

new(pull : JSON::PullParser)

new(object : EvalRunObject = EvalRunObject::EvalRun, id : String = "", eval_id : String = "", status : String = "", model : String = "", name : String = "", created_at : Int64 = 0, report_url : String = "", result_counts : EvalRunResultCounts = EvalRunResultCounts.new, per_model_usage : Array(EvalRunPerModelUsageItem) = [] of EvalRunPerModelUsageItem, per_testing_criteria_results : Array(EvalRunPerTestingCriteriaResultsItem) = [] of EvalRunPerTestingCriteriaResultsItem, data_source : EvalRunDataSource = CreateEvalJsonlRunDataSource.new, metadata : Metadata = nil, error : EvalApiError = EvalApiError.new)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

created_at

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

created_at=(created_at : Int64)

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

data_source

Information about the run's data source.

data_source=(data_source : EvalRunDataSource)

Information about the run's data source.

error

error=(error : EvalApiError)

eval_id

The identifier of the associated evaluation.

eval_id=(eval_id : String)

The identifier of the associated evaluation.

id

Unique identifier for the evaluation run.

id=(id : String)

Unique identifier for the evaluation run.

metadata

metadata=(metadata : Metadata)

model

The model that is evaluated, if applicable.

model=(model : String)

The model that is evaluated, if applicable.

name

The name of the evaluation run.

name=(name : String)

The name of the evaluation run.

object

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

object=(object : EvalRunObject)

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

per_model_usage

Usage statistics for each model during the evaluation run.

per_model_usage=(per_model_usage : Array(EvalRunPerModelUsageItem))

Usage statistics for each model during the evaluation run.

per_testing_criteria_results

Results per testing criteria applied during the evaluation run.

per_testing_criteria_results=(per_testing_criteria_results : Array(EvalRunPerTestingCriteriaResultsItem))

Results per testing criteria applied during the evaluation run.

report_url

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

report_url=(report_url : String)

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

result_counts

Counters summarizing the outcomes of the evaluation run.

result_counts=(result_counts : EvalRunResultCounts)

Counters summarizing the outcomes of the evaluation run.

status

The status of the evaluation run.

status=(status : String)

The status of the evaluation run.