Class: OpenAI::Models::Conversations::Message

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Conversations::Message

Defined in:

lib/openai/models/conversations/message.rb

Defined Under Namespace

Modules: Content, Role, Status

Instance Attribute Summary

• #content ⇒ Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>

  The content of the message.

• #id ⇒ String

  The unique ID of the message.

• #role ⇒ Symbol, OpenAI::Models::Conversations::Message::Role

  The role of the message.

• #status ⇒ Symbol, OpenAI::Models::Conversations::Message::Status

  The status of item.

• #type ⇒ Symbol, :message

  The type of the message.

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile)

Instance Method Summary

• #initialize(text:, type: :reasoning_text) ⇒ Object constructor

  Reasoning text from the model.

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(text:, type: :reasoning_text) ⇒ Object

Reasoning text from the model.

Parameters:

• text (String) —

  The reasoning text from the model.

• type (Symbol, :reasoning_text) (defaults to: :reasoning_text) —

  The type of the reasoning text. Always ‘reasoning_text`.

# File 'lib/openai/models/conversations/message.rb', line 39

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>

The content of the message

Returns:

• (Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>)

# File 'lib/openai/models/conversations/message.rb', line 17

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

#id ⇒ String

The unique ID of the message.

Returns:

• (String)

# File 'lib/openai/models/conversations/message.rb', line 11

required :id, String

#role ⇒ Symbol, OpenAI::Models::Conversations::Message::Role

The role of the message. One of ‘unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`.

Returns:

• (Symbol, OpenAI::Models::Conversations::Message::Role)

# File 'lib/openai/models/conversations/message.rb', line 24

required :role, enum: -> { OpenAI::Conversations::Message::Role }

#status ⇒ Symbol, OpenAI::Models::Conversations::Message::Status

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

Returns:

• (Symbol, OpenAI::Models::Conversations::Message::Status)

# File 'lib/openai/models/conversations/message.rb', line 31

required :status, enum: -> { OpenAI::Conversations::Message::Status }

#type ⇒ Symbol, :message

The type of the message. Always set to ‘message`.

Returns:

• (Symbol, :message)

# File 'lib/openai/models/conversations/message.rb', line 37

required :type, const: :message

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/conversations/message.rb', line 129

.variants ⇒ Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile)

Returns:

• (Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile))

# File 'lib/openai/models/conversations/message.rb', line 109