Module: OpenAI::Models::Beta::AgentSessionItem

Extended by:

Internal::Type::Union

Defined in:

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

Overview

An item associated with a session turn.

Defined Under Namespace

Classes: AgentMessage, FunctionCallOutput

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem)

Instance Method Summary

• #initialize(id:, call_id:, error:, output:, status:, turn_id:, type: :function_call_output) ⇒ Object

  The result supplied for a function call.

• #self?.variants ⇒ ::Array[OpenAI::Models::Beta::agent_session_item]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem)

Returns:

• (Array(OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem))

# File 'lib/openai/models/beta/agent_session_item.rb', line 181

Instance Method Details

#initialize(id:, call_id:, error:, output:, status:, turn_id:, type: :function_call_output) ⇒ Object

The result supplied for a function call.

Parameters:

• id (String) —

  The ID of the function call output item.

• call_id (String) —

  The ID of the function call that produced this output.

• error (String, nil) —

  The error message, if the call failed.

• output (String, Array<OpenAI::Models::Beta::InputContent::InputText, OpenAI::Models::Beta::InputContent::InputImage>, nil) —

  The text or model-input content supplied as a function result.

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

  The status of the function call.

• turn_id (String) —

  The ID of the turn that contains this item.

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

  The item type. Always function_call_output.

# File 'lib/openai/models/beta/agent_session_item.rb', line 97

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::agent_session_item]

Returns:

• (::Array[OpenAI::Models::Beta::agent_session_item])

# File 'sig/openai/models/beta/agent_session_item.rbs', line 112

def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_session_item]