Class: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/evals/runs/output_item_retrieve_response.rb,
sig/openai/models/evals/runs/output_item_retrieve_response.rbs

Overview

See Also:

  • OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse#sample

Defined Under Namespace

Classes: Input, Output, Usage

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, #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(content: nil, role: nil) ⇒ Object

Parameters:

  • content (String) (defaults to: nil) —

    The content of the message.

  • role (String) (defaults to: nil) —

    The role of the message (e.g. "system", "assistant", "user").




# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 252

Instance Attribute Details

#error ⇒ OpenAI::Models::Evals::EvalAPIError

An object representing an error response from the Eval API.

Parameters:

  • value (OpenAI::Evals::EvalAPIError)

Returns:



146
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 146

required :error, -> { OpenAI::Evals::EvalAPIError }

#finish_reason ⇒ String

The reason why the sample generation was finished.

Parameters:

  • value (String)

Returns:

  • (String) 


152
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 152

required :finish_reason, String

#input ⇒ Array<OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Input>

An array of input messages.

Parameters:

Returns:



158
159
160
161
162
163
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 158

required(
  :input,
  -> {
    OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Input]
  }
)

#max_completion_tokens ⇒ Integer

The maximum number of tokens allowed for completion.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


169
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 169

required :max_completion_tokens, Integer

#model ⇒ String

The model used for generating the sample.

Parameters:

  • value (String)

Returns:

  • (String) 


175
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 175

required :model, String

#output ⇒ Array<OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Output>

An array of output messages.

Parameters:

Returns:



181
182
183
184
185
186
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 181

required(
  :output,
  -> {
    OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Output]
  }
)

#seed ⇒ Integer

The seed used for generating the sample.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


192
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 192

required :seed, Integer

#temperature ⇒ Float

The sampling temperature used.

Parameters:

  • value (Float)

Returns:

  • (Float) 


198
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 198

required :temperature, Float

#top_p ⇒ Float

The top_p value used for sampling.

Parameters:

  • value (Float)

Returns:

  • (Float) 


204
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 204

required :top_p, Float

#usage ⇒ OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Usage

Token usage details for the sample.

Parameters:

Returns:



210
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 210

required :usage, -> { OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Usage }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


153
 
# File 'sig/openai/models/evals/runs/output_item_retrieve_response.rbs', line 153

def to_hash: -> {