Class: OpenAI::Models::Responses::EasyInputMessage

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

Defined Under Namespace

Modules: Content, Phase, Role, Type

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

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

Parameters:

  • content —

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

  • role —

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

  • phase (defaults to: nil) —

    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.

  • type (defaults to: nil) —

    The type of the message input. Always message.




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

Instance Attribute Details

#content ⇒ OpenAI::Models::Responses::EasyInputMessage::content

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

Returns:

  • (OpenAI::Models::Responses::EasyInputMessage::content) 


12
 
# File 'lib/openai/models/responses/easy_input_message.rb', line 12

required :content, union: -> { OpenAI::Responses::EasyInputMessage::Content }

#phase ⇒ OpenAI::Models::Responses::EasyInputMessage::phase?

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.

Returns:

  • (OpenAI::Models::Responses::EasyInputMessage::phase, nil) 


28
 
# File 'lib/openai/models/responses/easy_input_message.rb', line 28

optional :phase, enum: -> { OpenAI::Responses::EasyInputMessage::Phase }, nil?: true

#role ⇒ OpenAI::Models::Responses::EasyInputMessage::role

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

Returns:

  • (OpenAI::Models::Responses::EasyInputMessage::role) 


19
 
# File 'lib/openai/models/responses/easy_input_message.rb', line 19

required :role, enum: -> { OpenAI::Responses::EasyInputMessage::Role }

#type ⇒ OpenAI::Models::Responses::EasyInputMessage::type_?

The type of the message input. Always message.

Returns:

  • (OpenAI::Models::Responses::EasyInputMessage::type_, nil) 


34
 
# File 'lib/openai/models/responses/easy_input_message.rb', line 34

optional :type, enum: -> { OpenAI::Responses::EasyInputMessage::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/easy_input_message.rb', line 90

.variants ⇒ Array(String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>)

Returns:




# File 'lib/openai/models/responses/easy_input_message.rb', line 74

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/openai/models/responses/easy_input_message.rbs', line 55

def to_hash: -> {