All Implemented Interfaces:
```
public final class Tool

                    
```
A tool that can be used to generate a response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`Tool.Visitor`	An interface that defines how to map each variant of Tool to a value of type T.
`public final class`	`Tool.Mcp`	Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
`public final class`	`Tool.CodeInterpreter`	A tool that runs Python code to help generate a response to a prompt.
`public final class`	`Tool.ImageGeneration`	A tool that generates images using the GPT image models.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<FunctionTool>`	`function()`	Defines a function in your own code the model can choose to call.
`final Optional<FileSearchTool>`	`fileSearch()`	A tool that searches for relevant content from uploaded files.
`final Optional<ComputerTool>`	`computer()`	A tool that controls a virtual computer.
`final Optional<ComputerUsePreviewTool>`	`computerUsePreview()`	A tool that controls a virtual computer.
`final Optional<WebSearchTool>`	`webSearch()`	Search the Internet for sources related to the prompt.
`final Optional<Tool.Mcp>`	`mcp()`	Give the model access to additional tools via remote Model Context Protocol (MCP) servers.
`final Optional<Tool.CodeInterpreter>`	`codeInterpreter()`	A tool that runs Python code to help generate a response to a prompt.
`final Optional<Tool.ImageGeneration>`	`imageGeneration()`	A tool that generates images using the GPT image models.
`final Optional<JsonValue>`	`localShell()`	A tool that allows the model to execute shell commands in a local environment.
`final Optional<FunctionShellTool>`	`shell()`	A tool that allows the model to execute shell commands.
`final Optional<CustomTool>`	`custom()`	A custom tool that processes input using a specified format.
`final Optional<NamespaceTool>`	`namespace()`	Groups function/custom tools under a shared namespace.
`final Optional<ToolSearchTool>`	`search()`	Hosted or BYOT tool search configuration for deferred tools.
`final Optional<WebSearchPreviewTool>`	`webSearchPreview()`	This tool searches the web for relevant results to use in a response.
`final Optional<ApplyPatchTool>`	`applyPatch()`	Allows the assistant to create, delete, or update files using unified diffs.
`final Boolean`	`isFunction()`
`final Boolean`	`isFileSearch()`
`final Boolean`	`isComputer()`
`final Boolean`	`isComputerUsePreview()`
`final Boolean`	`isWebSearch()`
`final Boolean`	`isMcp()`
`final Boolean`	`isCodeInterpreter()`
`final Boolean`	`isImageGeneration()`
`final Boolean`	`isLocalShell()`
`final Boolean`	`isShell()`
`final Boolean`	`isCustom()`
`final Boolean`	`isNamespace()`
`final Boolean`	`isSearch()`
`final Boolean`	`isWebSearchPreview()`
`final Boolean`	`isApplyPatch()`
`final FunctionTool`	`asFunction()`	Defines a function in your own code the model can choose to call.
`final FileSearchTool`	`asFileSearch()`	A tool that searches for relevant content from uploaded files.
`final ComputerTool`	`asComputer()`	A tool that controls a virtual computer.
`final ComputerUsePreviewTool`	`asComputerUsePreview()`	A tool that controls a virtual computer.
`final WebSearchTool`	`asWebSearch()`	Search the Internet for sources related to the prompt.
`final Tool.Mcp`	`asMcp()`	Give the model access to additional tools via remote Model Context Protocol (MCP) servers.
`final Tool.CodeInterpreter`	`asCodeInterpreter()`	A tool that runs Python code to help generate a response to a prompt.
`final Tool.ImageGeneration`	`asImageGeneration()`	A tool that generates images using the GPT image models.
`final JsonValue`	`asLocalShell()`	A tool that allows the model to execute shell commands in a local environment.
`final FunctionShellTool`	`asShell()`	A tool that allows the model to execute shell commands.
`final CustomTool`	`asCustom()`	A custom tool that processes input using a specified format.
`final NamespaceTool`	`asNamespace()`	Groups function/custom tools under a shared namespace.
`final ToolSearchTool`	`asSearch()`	Hosted or BYOT tool search configuration for deferred tools.
`final WebSearchPreviewTool`	`asWebSearchPreview()`	This tool searches the web for relevant results to use in a response.
`final ApplyPatchTool`	`asApplyPatch()`	Allows the assistant to create, delete, or update files using unified diffs.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(Tool.Visitor<T> visitor)`	Maps this instance's current variant to a value of type T using the given visitor.
`final Tool`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Tool`	`ofFunction(FunctionTool function)`	Defines a function in your own code the model can choose to call.
`final static Tool`	`ofFileSearch(FileSearchTool fileSearch)`	A tool that searches for relevant content from uploaded files.
`final static Tool`	`ofComputer(ComputerTool computer)`	A tool that controls a virtual computer.
`final static Tool`	`ofComputerUsePreview(ComputerUsePreviewTool computerUsePreview)`	A tool that controls a virtual computer.
`final static Tool`	`ofWebSearch(WebSearchTool webSearch)`	Search the Internet for sources related to the prompt.
`final static Tool`	`ofMcp(Tool.Mcp mcp)`	Give the model access to additional tools via remote Model Context Protocol (MCP) servers.
`final static Tool`	`ofCodeInterpreter(Tool.CodeInterpreter codeInterpreter)`	A tool that runs Python code to help generate a response to a prompt.
`final static Tool`	`ofImageGeneration(Tool.ImageGeneration imageGeneration)`	A tool that generates images using the GPT image models.
`final static Tool`	`ofLocalShell()`	A tool that allows the model to execute shell commands in a local environment.
`final static Tool`	`ofShell(FunctionShellTool shell)`	A tool that allows the model to execute shell commands.
`final static Tool`	`ofCustom(CustomTool custom)`	A custom tool that processes input using a specified format.
`final static Tool`	`ofNamespace(NamespaceTool namespace)`	Groups function/custom tools under a shared namespace.
`final static Tool`	`ofSearch(ToolSearchTool search)`	Hosted or BYOT tool search configuration for deferred tools.
`final static Tool`	`ofWebSearchPreview(WebSearchPreviewTool webSearchPreview)`	This tool searches the web for relevant results to use in a response.
`final static Tool`	`ofApplyPatch(ApplyPatchTool applyPatch)`	Allows the assistant to create, delete, or update files using unified diffs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - function
```
 final Optional<FunctionTool> function()
```
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - fileSearch
```
 final Optional<FileSearchTool> fileSearch()
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - computer
```
 final Optional<ComputerTool> computer()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - computerUsePreview
```
 final Optional<ComputerUsePreviewTool> computerUsePreview()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - webSearch
```
 final Optional<WebSearchTool> webSearch()
```
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - mcp
```
 final Optional<Tool.Mcp> mcp()
```
    Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
  - codeInterpreter
```
 final Optional<Tool.CodeInterpreter> codeInterpreter()
```
    A tool that runs Python code to help generate a response to a prompt.
  - imageGeneration
```
 final Optional<Tool.ImageGeneration> imageGeneration()
```
    A tool that generates images using the GPT image models.
  - localShell
```
 final Optional<JsonValue> localShell()
```
    A tool that allows the model to execute shell commands in a local environment.
  - shell
```
 final Optional<FunctionShellTool> shell()
```
    A tool that allows the model to execute shell commands.
  - custom
```
 final Optional<CustomTool> custom()
```
    A custom tool that processes input using a specified format. Learn more about custom tools
  - namespace
```
 final Optional<NamespaceTool> namespace()
```
    Groups function/custom tools under a shared namespace.
  - search
```
 final Optional<ToolSearchTool> search()
```
    Hosted or BYOT tool search configuration for deferred tools.
  - webSearchPreview
```
 final Optional<WebSearchPreviewTool> webSearchPreview()
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - applyPatch
```
 final Optional<ApplyPatchTool> applyPatch()
```
    Allows the assistant to create, delete, or update files using unified diffs.
  - isFunction
```
 final Boolean isFunction()
```
  - isFileSearch
```
 final Boolean isFileSearch()
```
  - isComputer
```
 final Boolean isComputer()
```
  - isComputerUsePreview
```
 final Boolean isComputerUsePreview()
```
  - isWebSearch
```
 final Boolean isWebSearch()
```
  - isMcp
```
 final Boolean isMcp()
```
  - isCodeInterpreter
```
 final Boolean isCodeInterpreter()
```
  - isImageGeneration
```
 final Boolean isImageGeneration()
```
  - isLocalShell
```
 final Boolean isLocalShell()
```
  - isShell
```
 final Boolean isShell()
```
  - isCustom
```
 final Boolean isCustom()
```
  - isNamespace
```
 final Boolean isNamespace()
```
  - isSearch
```
 final Boolean isSearch()
```
  - isWebSearchPreview
```
 final Boolean isWebSearchPreview()
```
  - isApplyPatch
```
 final Boolean isApplyPatch()
```
  - asFunction
```
 final FunctionTool asFunction()
```
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - asFileSearch
```
 final FileSearchTool asFileSearch()
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - asComputer
```
 final ComputerTool asComputer()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - asComputerUsePreview
```
 final ComputerUsePreviewTool asComputerUsePreview()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - asWebSearch
```
 final WebSearchTool asWebSearch()
```
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - asMcp
```
 final Tool.Mcp asMcp()
```
    Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
  - asCodeInterpreter
```
 final Tool.CodeInterpreter asCodeInterpreter()
```
    A tool that runs Python code to help generate a response to a prompt.
  - asImageGeneration
```
 final Tool.ImageGeneration asImageGeneration()
```
    A tool that generates images using the GPT image models.
  - asLocalShell
```
 final JsonValue asLocalShell()
```
    A tool that allows the model to execute shell commands in a local environment.
  - asShell
```
 final FunctionShellTool asShell()
```
    A tool that allows the model to execute shell commands.
  - asCustom
```
 final CustomTool asCustom()
```
    A custom tool that processes input using a specified format. Learn more about custom tools
  - asNamespace
```
 final NamespaceTool asNamespace()
```
    Groups function/custom tools under a shared namespace.
  - asSearch
```
 final ToolSearchTool asSearch()
```
    Hosted or BYOT tool search configuration for deferred tools.
  - asWebSearchPreview
```
 final WebSearchPreviewTool asWebSearchPreview()
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - asApplyPatch
```
 final ApplyPatchTool asApplyPatch()
```
    Allows the assistant to create, delete, or update files using unified diffs.
  - _json
```
 final Optional<JsonValue> _json()
```
  - accept
```
 final <T extends Any> T accept(Tool.Visitor<T> visitor)
```
    Maps this instance's current variant to a value of type T using the given visitor.
    Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
    import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = tool.accept(new Tool.Visitor<Optional<String>>() { @Override public Optional<String> visitFunction(FunctionTool function) { return Optional.of(function.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
  - validate
```
 final Tool validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - ofFunction
```
 final static Tool ofFunction(FunctionTool function)
```
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - ofFileSearch
```
 final static Tool ofFileSearch(FileSearchTool fileSearch)
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - ofComputer
```
 final static Tool ofComputer(ComputerTool computer)
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - ofComputerUsePreview
```
 final static Tool ofComputerUsePreview(ComputerUsePreviewTool computerUsePreview)
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - ofWebSearch
```
 final static Tool ofWebSearch(WebSearchTool webSearch)
```
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - ofMcp
```
 final static Tool ofMcp(Tool.Mcp mcp)
```
    Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
  - ofCodeInterpreter
```
 final static Tool ofCodeInterpreter(Tool.CodeInterpreter codeInterpreter)
```
    A tool that runs Python code to help generate a response to a prompt.
  - ofImageGeneration
```
 final static Tool ofImageGeneration(Tool.ImageGeneration imageGeneration)
```
    A tool that generates images using the GPT image models.
  - ofLocalShell
```
 final static Tool ofLocalShell()
```
    A tool that allows the model to execute shell commands in a local environment.
  - ofShell
```
 final static Tool ofShell(FunctionShellTool shell)
```
    A tool that allows the model to execute shell commands.
  - ofCustom
```
 final static Tool ofCustom(CustomTool custom)
```
    A custom tool that processes input using a specified format. Learn more about custom tools
  - ofNamespace
```
 final static Tool ofNamespace(NamespaceTool namespace)
```
    Groups function/custom tools under a shared namespace.
  - ofSearch
```
 final static Tool ofSearch(ToolSearchTool search)
```
    Hosted or BYOT tool search configuration for deferred tools.
  - ofWebSearchPreview
```
 final static Tool ofWebSearchPreview(WebSearchPreviewTool webSearchPreview)
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - ofApplyPatch
```
 final static Tool ofApplyPatch(ApplyPatchTool applyPatch)
```
    Allows the assistant to create, delete, or update files using unified diffs.

Class Tool

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

function

fileSearch

computer

computerUsePreview

webSearch

mcp

codeInterpreter

imageGeneration

localShell

shell

custom

namespace

search

webSearchPreview

applyPatch

isFunction

isFileSearch

isComputer

isComputerUsePreview

isWebSearch

isMcp

isCodeInterpreter

isImageGeneration

isLocalShell

isShell

isCustom

isNamespace

isSearch

isWebSearchPreview

isApplyPatch

asFunction

asFileSearch

asComputer

asComputerUsePreview

asWebSearch

asMcp

asCodeInterpreter

asImageGeneration

asLocalShell

asShell

asCustom

asNamespace

asSearch

asWebSearchPreview

asApplyPatch

_json

accept

validate

isValid

equals

hashCode

toString

ofFunction

ofFileSearch

ofComputer

ofComputerUsePreview

ofWebSearch

ofMcp

ofCodeInterpreter

ofImageGeneration

ofLocalShell

ofShell

ofCustom

ofNamespace

ofSearch

ofWebSearchPreview

ofApplyPatch