Class: OpenAI::Models::Responses::ResponseItem::AdditionalTools

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseItem::AdditionalTools

Defined in:

lib/openai/models/responses/response_item.rb

Defined Under Namespace

Modules: Role

Instance Attribute Summary

• #id ⇒ String

  The unique ID of the additional tools item.

• #role ⇒ Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role

  The role that provided the additional tools.

• #tools ⇒ Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>

  The additional tool definitions made available at this item.

• #type ⇒ Symbol, :additional_tools

  The type of the item.

Instance Method Summary

• #initialize(id:, role:, tools:, type: :additional_tools) ⇒ Object constructor

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:, type: :additional_tools) ⇒ Object

Parameters:

• id (String) —

  The unique ID of the additional tools item.

• role (Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role) —

  The role that provided the additional tools.

• tools (Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>) —

  The additional tool definitions made available at this item.

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

  The type of the item. Always ‘additional_tools`.

# File 'lib/openai/models/responses/response_item.rb', line 119

Instance Attribute Details

#id ⇒ String

The unique ID of the additional tools item.

Returns:

• (String)

# File 'lib/openai/models/responses/response_item.rb', line 99

required :id, String

#role ⇒ Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role

The role that provided the additional tools.

Returns:

• (Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role)

# File 'lib/openai/models/responses/response_item.rb', line 105

required :role, enum: -> { OpenAI::Responses::ResponseItem::AdditionalTools::Role }

#tools ⇒ Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>

The additional tool definitions made available at this item.

Returns:

• (Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>)

# File 'lib/openai/models/responses/response_item.rb', line 111

required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }

#type ⇒ Symbol, :additional_tools

The type of the item. Always ‘additional_tools`.

Returns:

• (Symbol, :additional_tools)

# File 'lib/openai/models/responses/response_item.rb', line 117

required :type, const: :additional_tools