Class: OpenAI::Models::Beta::BetaResponseItem::AdditionalTools

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_item.rb

Defined Under Namespace

Modules: Role Classes: Agent

Instance Attribute Summary collapse

Class Method 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

#initialize(id:, role:, tools:, agent: nil, type: :additional_tools) ⇒ Object

Parameters:




# File 'lib/openai/models/beta/beta_response_item.rb', line 575

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Agent?

The agent that produced this item.

Returns:



573
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 573

optional :agent, -> { OpenAI::Beta::BetaResponseItem::AdditionalTools::Agent }

#id ⇒ String

The unique ID of the additional tools item.

Returns:

  • (String) 


549
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 549

required :id, String

#role ⇒ Symbol, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::Role

The role that provided the additional tools.

Returns:



555
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 555

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

#tools ⇒ Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>

The additional tool definitions made available at this item.

Returns:



561
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 561

required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaTool] }

#type ⇒ Symbol, :additional_tools

The type of the item. Always additional_tools.

Returns:

  • (Symbol, :additional_tools) 


567
 
# File 'lib/openai/models/beta/beta_response_item.rb', line 567

required :type, const: :additional_tools

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/beta_response_item.rb', line 601