Class: OpenAI::Models::Beta::ResponseCreateParams::MultiAgent

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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

#initializeObject



552
# File 'sig/openai/models/beta/response_create_params.rbs', line 552

def initialize: (

Instance Attribute Details

#enabledBoolean

Whether to enable server-hosted multi-agent execution for this response.

Parameters:

Returns:



903
# File 'lib/openai/models/beta/response_create_params.rb', line 903

required :enabled, OpenAI::Internal::Type::Boolean

#max_concurrent_subagentsInteger?

max_concurrent_subagents sets the maximum number of subagents that can be active simultaneously across the entire agent tree. It includes all descendants—children, grandchildren, and deeper subagents—but excludes the root agent. The API does not impose a fixed upper bound on this setting. The default is 3, which is recommended for most workloads. Multi-agent runs also have no fixed limit on tree depth or the total number of subagents created during a run.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


914
# File 'lib/openai/models/beta/response_create_params.rb', line 914

optional :max_concurrent_subagents, Integer

Instance Method Details

#to_hash{ enabled: bool, max_concurrent_subagents: Integer }

Returns:

  • ({ enabled: bool, max_concurrent_subagents: Integer })


557
# File 'sig/openai/models/beta/response_create_params.rbs', line 557

def to_hash: -> { enabled: bool, max_concurrent_subagents: Integer }