Module: OpenAI::Models::Beta::BetaCustomTool::AllowedCaller

Extended by:

Internal::Type::Enum

Defined in:

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

Constant Summary

DIRECT =

Returns:

• (:direct)

:direct

PROGRAMMATIC =

Returns:

• (:programmatic)

:programmatic

Instance Method Summary

• #initialize(name:, allowed_callers: nil, defer_loading: nil, description: nil, format_: nil, type: :custom) ⇒ Object

  A custom tool that processes input using a specified format.

• #self?.values ⇒ ::Array[OpenAI::Models::Beta::BetaCustomTool::allowed_caller]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

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, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(name:, allowed_callers: nil, defer_loading: nil, description: nil, format_: nil, type: :custom) ⇒ Object

A custom tool that processes input using a specified format. Learn more about custom tools

Parameters:

• name (String) —

  The name of the custom tool, used to identify it in tool calls.

• allowed_callers (Array<Symbol, OpenAI::Models::Beta::BetaCustomTool::AllowedCaller>, nil) (defaults to: nil) —

  The tool invocation context(s).

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

  Whether this tool should be deferred and discovered via tool search.

• description (String) (defaults to: nil) —

  Optional description of the custom tool, used to provide more context.

• format_ (OpenAI::Models::Beta::BetaCustomTool::Format::Text, OpenAI::Models::Beta::BetaCustomTool::Format::Grammar) (defaults to: nil) —

  The input format for the custom tool. Default is unconstrained text.

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

  The type of the custom tool. Always custom.

# File 'lib/openai/models/beta/beta_custom_tool.rb', line 61

module AllowedCaller
  extend OpenAI::Internal::Type::Enum

  DIRECT = :direct
  PROGRAMMATIC = :programmatic

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[OpenAI::Models::Beta::BetaCustomTool::allowed_caller]

Returns:

• (::Array[OpenAI::Models::Beta::BetaCustomTool::allowed_caller])

# File 'sig/openai/models/beta/beta_custom_tool.rbs', line 63

def self?.values: -> ::Array[OpenAI::Models::Beta::BetaCustomTool::allowed_caller]