Class: OpenAI::Models::Beta::AgentSessionAssistantMessage

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::AgentSessionAssistantMessage

Defined in:

lib/openai/models/beta/agent_session_assistant_message.rb,
sig/openai/models/beta/agent_session_assistant_message.rbs

Defined Under Namespace

Modules: Phase

Instance Attribute Summary

• #content ⇒ Array<OpenAI::Models::Beta::OutputText>

  The content of the message.

• #id ⇒ String

  The ID of the message.

• #phase ⇒ Symbol, ...

  The phase of an assistant message.

• #role ⇒ Symbol, :assistant

  The role of the message author.

• #status ⇒ Symbol, OpenAI::Models::Beta::AgentOutputItemStatus

  The status of the message.

• #turn_id ⇒ String

  The ID of the turn that contains this item.

• #type ⇒ Symbol, :message

  The item type.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(id:, content:, phase:, status:, turn_id:, role: :assistant, type: :message) ⇒ Object constructor

  An assistant message produced by the agent.

• #to_hash ⇒ {

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

An assistant message produced by the agent.

Parameters:

• id (String) —

  The ID of the message.

• content (Array<OpenAI::Models::Beta::OutputText>) —

  The content of the message.

• phase (Symbol, OpenAI::Models::Beta::AgentSessionAssistantMessage::Phase, nil) —

  The phase of an assistant message.

• status (Symbol, OpenAI::Models::Beta::AgentOutputItemStatus) —

  The status of the message.

• turn_id (String) —

  The ID of the turn that contains this item.

• role (Symbol, :assistant) (defaults to: :assistant) —

  The role of the message author. Always assistant.

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

  The item type. Always message.

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 49

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Beta::OutputText>

The content of the message.

Parameters:

• value (::Array[OpenAI::Beta::OutputText])

Returns:

• (Array<OpenAI::Models::Beta::OutputText>)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 17

required :content, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::OutputText] }

#id ⇒ String

The ID of the message.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 11

required :id, String

#phase ⇒ Symbol, ...

The phase of an assistant message.

Parameters:

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

Returns:

• (Symbol, OpenAI::Models::Beta::AgentSessionAssistantMessage::Phase, nil)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 23

required :phase, enum: -> { OpenAI::Beta::AgentSessionAssistantMessage::Phase }, nil?: true

#role ⇒ Symbol, :assistant

The role of the message author. Always assistant.

Parameters:

• value (:assistant)

Returns:

• (Symbol, :assistant)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 29

required :role, const: :assistant

#status ⇒ Symbol, OpenAI::Models::Beta::AgentOutputItemStatus

The status of the message.

Parameters:

• value (OpenAI::Models::Beta::agent_output_item_status)

Returns:

• (Symbol, OpenAI::Models::Beta::AgentOutputItemStatus)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 35

required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 41

required :turn_id, String

#type ⇒ Symbol, :message

The item type. Always message.

Parameters:

• value (:message)

Returns:

• (Symbol, :message)

# File 'lib/openai/models/beta/agent_session_assistant_message.rb', line 47

required :type, const: :message

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/agent_session_assistant_message.rbs', line 40

def to_hash: -> {