Class: OpenAI::Models::Responses::ResponseOutputMessage

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

Defined Under Namespace

Modules: Content, Status

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, 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(id: , content: , status: , role: :assistant, type: :message) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseOutputMessage for more details.

An output message from the model.

Parameters:




# File 'lib/openai/models/responses/response_output_message.rb', line 41

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal>

The content of the output message.

Returns:



17
18
19
20
 
# File 'lib/openai/models/responses/response_output_message.rb', line 17

required :content,
-> {
  OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputMessage::Content]
}

#id ⇒ String

The unique ID of the output message.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_output_message.rb', line 11

required :id, String

#role ⇒ Symbol, :assistant

The role of the output message. Always ‘assistant`.

Returns:

  • (Symbol, :assistant) 


26
 
# File 'lib/openai/models/responses/response_output_message.rb', line 26

required :role, const: :assistant

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Status

The status of the message input. One of ‘in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API.

Returns:



33
 
# File 'lib/openai/models/responses/response_output_message.rb', line 33

required :status, enum: -> { OpenAI::Responses::ResponseOutputMessage::Status }

#type ⇒ Symbol, :message

The type of the output message. Always ‘message`.

Returns:

  • (Symbol, :message) 


39
 
# File 'lib/openai/models/responses/response_output_message.rb', line 39

required :type, const: :message

Class Method Details

.variants ⇒ Array(OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal)

Returns:




# File 'lib/openai/models/responses/response_output_message.rb', line 69