Class: OpenAI::Models::Beta::AgentSessionMessage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/helpers/agents/message.rb,
lib/openai/models/beta/agent_session_message.rb,
sig/openai/helpers/agents.rbs,
sig/openai/models/beta/agent_session_message.rbs

Defined Under Namespace

Modules: Phase, Role

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

A user or assistant message recorded in a session.

Parameters:




# File 'lib/openai/models/beta/agent_session_message.rb', line 50

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Beta::AgentSessionMessageContent::InputText, OpenAI::Models::Beta::AgentSessionMessageContent::InputImage, OpenAI::Models::Beta::AgentSessionMessageContent::OutputText>

The content of the message. User messages contain input text or images; assistant messages contain output text.

Parameters:

  • value (::Array[OpenAI::Models::Beta::agent_session_message_content])

Returns:



18
 
# File 'lib/openai/models/beta/agent_session_message.rb', line 18

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

#id ⇒ String?

The ID of this item, or null for legacy user messages whose ID was not recorded.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :id, String, nil?: true

#phase ⇒ Symbol, ...

The phase of an assistant message.

Parameters:

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

Returns:



24
 
# File 'lib/openai/models/beta/agent_session_message.rb', line 24

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

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

The role of the message author.

Parameters:

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

Returns:



30
 
# File 'lib/openai/models/beta/agent_session_message.rb', line 30

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

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

The status of the message. User messages are always completed.

Parameters:

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

Returns:



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

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

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

  • value (String)

Returns:

  • (String) 


42
 
# File 'lib/openai/models/beta/agent_session_message.rb', line 42

required :turn_id, String

#type ⇒ Symbol, :message

The item type. Always message.

Parameters:

  • value (:message)

Returns:

  • (Symbol, :message) 


48
 
# File 'lib/openai/models/beta/agent_session_message.rb', line 48

required :type, const: :message

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agent_session_message.rb', line 87

Instance Method Details

#output_text ⇒ String

Concatenate output-text blocks in message order, without fetching or filtering by phase. Reading this method does not change serialization.

Returns:

  • (String) 


10
11
12
13
14
15
16
 
# File 'lib/openai/helpers/agents/message.rb', line 10

def output_text
  content
    .filter_map do |part|
      (part[:text] || part["text"]) if (part[:type] || part["type"]).to_s == "output_text"
    end
    .join
end

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {