Module: OpenAI::Models::Responses::Tool

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/responses/tool.rb

Overview

A tool that can be used to generate a response.

Defined Under Namespace

Classes: CodeInterpreter, ImageGeneration, LocalShell, Mcp

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool)

Instance Method Summary

• #initialize(file_ids: nil, type: :auto) ⇒ Object

  Some parameter documentations has been truncated, see CodeInterpreter::Container::CodeInterpreterToolAuto for more details.

Methods included from Internal::Type::Union

==, ===, coerce, 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, #dump, dump, #inspect, inspect, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/responses/tool.rb', line 208

.variants ⇒ Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool)

Returns:

• (Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool))

# File 'lib/openai/models/responses/tool.rb', line 212

Instance Method Details

#initialize(file_ids: nil, type: :auto) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto for more details.

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

Parameters:

• file_ids (Array<String>) (defaults to: nil) —

  An optional list of uploaded files to make available to your code.

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

  Always ‘auto`.

# File 'lib/openai/models/responses/tool.rb', line 268