Class: OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel

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

Defined Under Namespace

Modules: Input

Instance Attribute 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, meta_info, 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(input:, labels:, model:, name:, passing_labels:, type: :label_model) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel for more details.

A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.

Parameters:




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

Instance Attribute Details

#input ⇒ Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::SimpleInputMessage, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem>

A list of chat messages forming the prompt or context. May include variable references to the ‘item` namespace, ie OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel.{item{item.name}.

Returns:



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

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

#labels ⇒ Array<String>

The labels to classify to each item in the evaluation.

Returns:

  • (Array<String>) 


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

required :labels, OpenAI::Internal::Type::ArrayOf[String]

#model ⇒ String

The model to use for the evaluation. Must support structured outputs.

Returns:

  • (String) 


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

required :model, String

#name ⇒ String

The name of the grader.

Returns:

  • (String) 


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

required :name, String

#passing_labels ⇒ Array<String>

The labels that indicate a passing result. Must be a subset of labels.

Returns:

  • (Array<String>) 


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

required :passing_labels, OpenAI::Internal::Type::ArrayOf[String]

#type ⇒ Symbol, :label_model

The object type, which is always ‘label_model`.

Returns:

  • (Symbol, :label_model) 


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

required :type, const: :label_model