Class: OpenAI::Models::Beta::BetaEasyInputMessage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_easy_input_message.rb,
sig/openai/models/beta/beta_easy_input_message.rbs

Defined Under Namespace

Modules: Content, Phase, Role, Type

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, 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:, role:, phase: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaEasyInputMessage for more details.

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Parameters:




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

Instance Attribute Details

#content ⇒ String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

Parameters:

  • value (OpenAI::Models::Beta::BetaEasyInputMessage::content)

Returns:



12
 
# File 'lib/openai/models/beta/beta_easy_input_message.rb', line 12

required :content, union: -> { OpenAI::Beta::BetaEasyInputMessage::Content }

#phase ⇒ Symbol, ...

Labels an assistant message as intermediate commentary (commentary) or the final answer (final_answer). For models like gpt-5.3-codex and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

Parameters:

  • value (OpenAI::Models::Beta::BetaEasyInputMessage::phase, nil)

Returns:



28
 
# File 'lib/openai/models/beta/beta_easy_input_message.rb', line 28

optional :phase, enum: -> { OpenAI::Beta::BetaEasyInputMessage::Phase }, nil?: true

#role ⇒ Symbol, OpenAI::Models::Beta::BetaEasyInputMessage::Role

The role of the message input. One of user, assistant, system, or developer.

Parameters:

  • value (OpenAI::Models::Beta::BetaEasyInputMessage::role)

Returns:



19
 
# File 'lib/openai/models/beta/beta_easy_input_message.rb', line 19

required :role, enum: -> { OpenAI::Beta::BetaEasyInputMessage::Role }

#type ⇒ Symbol, ...

The type of the message input. Always message.

Returns:



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

optional :type, enum: -> { OpenAI::Beta::BetaEasyInputMessage::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/beta_easy_input_message.rb', line 84

.variants ⇒ Array(String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>)

Returns:




# File 'lib/openai/models/beta/beta_easy_input_message.rb', line 68

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/beta/beta_easy_input_message.rbs', line 34

def to_hash: -> {