Module: OpenAI::Models::Beta::AgentToolParam

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/beta/agent_tool_param.rb,
sig/openai/models/beta/agent_tool_param.rbs

Overview

A tool available to the agent.

Defined Under Namespace

Classes: Function, Mcp, ProgrammaticToolCalling, ToolSearch, WebSearch

Class Method Summary collapse

Instance Method Summary collapse

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

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agent_tool_param.rb', line 218

.variants ⇒ Array(OpenAI::Models::Beta::AgentToolParam::Function, OpenAI::Models::Beta::AgentToolParam::ToolSearch, OpenAI::Models::Beta::AgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentToolParam::Mcp, OpenAI::Models::Beta::AgentToolParam::WebSearch)

Returns:




# File 'lib/openai/models/beta/agent_tool_param.rb', line 354

Instance Method Details

#initialize(enabled: nil, type: :programmatic_tool_calling) ⇒ Object

Enables calling tools from model-generated code.

Parameters:

  • enabled (Boolean) (defaults to: nil) —

    Whether tools can be called from model-generated code. Defaults to true.

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

    The type of the object. Always programmatic_tool_calling.




# File 'lib/openai/models/beta/agent_tool_param.rb', line 59

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

Returns:

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


247
 
# File 'sig/openai/models/beta/agent_tool_param.rbs', line 247

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