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:

  • error —

    An object representing an error response from the Eval API.

  • finish_reason —

    The reason why the sample generation was finished.

  • input —

    An array of input messages.

  • max_completion_tokens —

    The maximum number of tokens allowed for completion.

  • model —

    The model used for generating the sample.

  • output —

    An array of output messages.

  • seed —

    The seed used for generating the sample.

  • temperature —

    The sampling temperature used.

  • top_p —

    The top_p value used for sampling.

  • usage —

    Token usage details for the sample.




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

Instance Attribute Details

#error ⇒ OpenAI::Evals::EvalAPIError

An object representing an error response from the Eval API.

Returns:

  • (OpenAI::Evals::EvalAPIError) 


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

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

#finish_reason ⇒ String

The reason why the sample generation was finished.

Returns:

  • (String) 


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

required :finish_reason, String

#input ⇒ ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Input]

An array of input messages.

Returns:



172
173
174
175
176
177
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 172

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.

Returns:

  • (Integer) 


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

required :max_completion_tokens, Integer

#model ⇒ String

The model used for generating the sample.

Returns:

  • (String) 


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

required :model, String

#output ⇒ ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Output]

An array of output messages.

Returns:



195
196
197
198
199
200
 
# File 'lib/openai/models/evals/runs/output_item_retrieve_response.rb', line 195

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

#seed ⇒ Integer

The seed used for generating the sample.

Returns:

  • (Integer) 


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

required :seed, Integer

#temperature ⇒ Float

The sampling temperature used.

Returns:

  • (Float) 


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

required :temperature, Float

#top_p ⇒ Float

The top_p value used for sampling.

Returns:

  • (Float) 


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

required :top_p, Float

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

Token usage details for the sample.

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {