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.

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<FileSearchTool>`	`fileSearch()`	A tool that searches for relevant content from uploaded files.
`final Optional<FunctionTool>`	`function()`	Defines a function in your own code the model can choose to call.
`final Optional<WebSearchTool>`	`webSearch()`	This tool searches the web for relevant results to use in a response.
`final Optional<ComputerTool>`	`computerUsePreview()`	A tool that controls a virtual computer.
`final Boolean`	`isFileSearch()`
`final Boolean`	`isFunction()`
`final Boolean`	`isWebSearch()`
`final Boolean`	`isComputerUsePreview()`
`final FileSearchTool`	`asFileSearch()`	A tool that searches for relevant content from uploaded files.
`final FunctionTool`	`asFunction()`	Defines a function in your own code the model can choose to call.
`final WebSearchTool`	`asWebSearch()`	This tool searches the web for relevant results to use in a response.
`final ComputerTool`	`asComputerUsePreview()`	A tool that controls a virtual computer.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(Tool.Visitor<T> visitor)`
`final Tool`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Tool`	`ofFileSearch(FileSearchTool fileSearch)`	A tool that searches for relevant content from uploaded files.
`final static Tool`	`ofFunction(FunctionTool function)`	Defines a function in your own code the model can choose to call.
`final static Tool`	`ofWebSearch(WebSearchTool webSearch)`	This tool searches the web for relevant results to use in a response.
`final static Tool`	`ofComputerUsePreview(ComputerTool computerUsePreview)`	A tool that controls a virtual computer.

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

- Constructor Detail
- Method Detail
  - fileSearch
```
 final Optional<FileSearchTool> fileSearch()
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - function
```
 final Optional<FunctionTool> function()
```
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - webSearch
```
 final Optional<WebSearchTool> webSearch()
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - computerUsePreview
```
 final Optional<ComputerTool> computerUsePreview()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - isFileSearch
```
 final Boolean isFileSearch()
```
  - isFunction
```
 final Boolean isFunction()
```
  - isWebSearch
```
 final Boolean isWebSearch()
```
  - isComputerUsePreview
```
 final Boolean isComputerUsePreview()
```
  - asFileSearch
```
 final FileSearchTool asFileSearch()
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - asFunction
```
 final FunctionTool asFunction()
```
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - asWebSearch
```
 final WebSearchTool asWebSearch()
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - asComputerUsePreview
```
 final ComputerTool asComputerUsePreview()
```
    A tool that controls a virtual computer. Learn more about the computer tool.
  - _json
```
 final Optional<JsonValue> _json()
```
  - accept
```
 final <T extends Any> T accept(Tool.Visitor<T> visitor)
```
  - validate
```
 final Tool validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - ofFileSearch
```
 final static Tool ofFileSearch(FileSearchTool fileSearch)
```
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - 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.
  - ofWebSearch
```
 final static Tool ofWebSearch(WebSearchTool webSearch)
```
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - ofComputerUsePreview
```
 final static Tool ofComputerUsePreview(ComputerTool computerUsePreview)
```
    A tool that controls a virtual computer. Learn more about the computer tool.

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

fileSearch

function

webSearch

computerUsePreview

isFileSearch

isFunction

isWebSearch

isComputerUsePreview

asFileSearch

asFunction

asWebSearch

asComputerUsePreview

_json

accept

validate

isValid

equals

hashCode

toString

ofFileSearch

ofFunction

ofWebSearch

ofComputerUsePreview