Class: OpenAI::Models::EvalListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/eval_list_response.rb

Overview

See Also:

Defined Under Namespace

Modules: DataSourceConfig, TestingCriterion

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(schema: , metadata: nil, type: :logs) ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::EvalListResponse::DataSourceConfig::Logs for more details.

A LogsDataSourceConfig which specifies the metadata property of your logs query. This is usually metadata like usecase=chatbot or prompt-version=v2, etc. The schema returned by this data source config is used to defined what variables are available in your evals. item and sample are both defined when using this data source config.

Parameters:

  • schema (Hash{Symbol=>Object}) (defaults to: ) —

    The json schema for the run data source items.

  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Set of 16 key-value pairs that can be attached to an object. This can be

  • type (Symbol, :logs) (defaults to: :logs) —

    The type of data source. Always logs.




# File 'lib/openai/models/eval_list_response.rb', line 55

Instance Attribute Details

#created_at ⇒ Integer

The Unix timestamp (in seconds) for when the eval was created.

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/eval_list_response.rb', line 17

required :created_at, Integer

#data_source_config ⇒ OpenAI::Models::EvalCustomDataSourceConfig, ...

Configuration of data sources used in runs of the evaluation.

Returns:



23
 
# File 'lib/openai/models/eval_list_response.rb', line 23

required :data_source_config, union: -> { OpenAI::Models::EvalListResponse::DataSourceConfig }

#id ⇒ String

Unique identifier for the evaluation.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/eval_list_response.rb', line 11

required :id, String

#metadata ⇒ Hash{Symbol=>String}?

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.

Returns:

  • (Hash{Symbol=>String}, nil) 


34
 
# File 'lib/openai/models/eval_list_response.rb', line 34

required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#name ⇒ String

The name of the evaluation.

Returns:

  • (String) 


40
 
# File 'lib/openai/models/eval_list_response.rb', line 40

required :name, String

#object ⇒ Symbol, :eval

The object type.

Returns:

  • (Symbol, :eval) 


46
 
# File 'lib/openai/models/eval_list_response.rb', line 46

required :object, const: :eval

#testing_criteria ⇒ Array<OpenAI::Models::Graders::LabelModelGrader, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderTextSimilarity, OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderPython, OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderScoreModel>

A list of testing criteria.

Returns:



52
53
 
# File 'lib/openai/models/eval_list_response.rb', line 52

required :testing_criteria,
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Models::EvalListResponse::TestingCriterion] }

Class Method Details

.variants ⇒ Array(OpenAI::Models::EvalCustomDataSourceConfig, OpenAI::Models::EvalListResponse::DataSourceConfig::Logs, OpenAI::Models::EvalStoredCompletionsDataSourceConfig)

Returns:




# File 'lib/openai/models/eval_list_response.rb', line 145