Class: OpenAI::Models::Beta::AgentCloseSubagentCallItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/agent_close_subagent_call_item.rb,
sig/openai/models/beta/agent_close_subagent_call_item.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

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:, recipient_agent_id:, sender_agent_id:, status:, turn_id:, type: :close_subagent_call) ⇒ Object

A request to close a subagent.

Parameters:

  • id (String) —

    The ID of the tool call item.

  • recipient_agent_id (String) —

    The ID of the agent to close.

  • sender_agent_id (String) —

    The ID of the agent requesting the close.

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

    The status of the tool call.

  • turn_id (String) —

    The ID of the turn that contains this item.

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

    The item type. Always close_subagent_call.




# File 'lib/openai/models/beta/agent_close_subagent_call_item.rb', line 43

Instance Attribute Details

#id ⇒ String

The ID of the tool call item.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#recipient_agent_id ⇒ String

The ID of the agent to close.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :recipient_agent_id, String

#sender_agent_id ⇒ String

The ID of the agent requesting the close.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :sender_agent_id, String

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

The status of the tool call.

Parameters:

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

Returns:



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

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

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :turn_id, String

#type ⇒ Symbol, :close_subagent_call

The item type. Always close_subagent_call.

Parameters:

  • value (:close_subagent_call)

Returns:

  • (Symbol, :close_subagent_call) 


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

required :type, const: :close_subagent_call

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


36
 
# File 'sig/openai/models/beta/agent_close_subagent_call_item.rbs', line 36

def to_hash: -> {