Class: OpenAI::Models::EvalCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/eval_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: DataSourceConfig, TestingCriterion

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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, 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(metadata: nil, type: :stored_completions) ⇒ Object

Deprecated in favor of LogsDataSourceConfig.

Parameters:

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

    Metadata filters for the stored completions data source.

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

    The type of data source. Always ‘stored_completions`.




# File 'lib/openai/models/eval_create_params.rb', line 44

Instance Attribute Details

#data_source_config ⇒ OpenAI::Models::EvalCreateParams::DataSourceConfig::Custom, ...

The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.

Returns:



15
 
# File 'lib/openai/models/eval_create_params.rb', line 15

required :data_source_config, union: -> { OpenAI::EvalCreateParams::DataSourceConfig }

#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) 


36
 
# File 'lib/openai/models/eval_create_params.rb', line 36

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

#name ⇒ String?

The name of the evaluation.

Returns:

  • (String, nil) 


42
 
# File 'lib/openai/models/eval_create_params.rb', line 42

optional :name, String

#testing_criteria ⇒ Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalCreateParams::TestingCriterion::TextSimilarity, OpenAI::Models::EvalCreateParams::TestingCriterion::Python, OpenAI::Models::EvalCreateParams::TestingCriterion::ScoreModel>

A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like ‘OpenAI::Models::EvalCreateParams.{item{item.variable_name}`. To reference the model’s output, use the ‘sample` namespace (ie, `OpenAI::Models::EvalCreateParams.{sample{sample.output_text}`).

Returns:



24
25
 
# File 'lib/openai/models/eval_create_params.rb', line 24

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