All Implemented Interfaces:
```
public final class WebSearchTool

                    
```
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`WebSearchTool.Builder`	A builder for WebSearchTool.
`public final class`	`WebSearchTool.Type`	The type of the web search tool. One of: `web_search_preview` `web_search_preview_2025_03_11`
`public final class`	`WebSearchTool.SearchContextSize`	High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.
`public final class`	`WebSearchTool.UserLocation`

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 WebSearchTool.Type`	`type()`	The type of the web search tool.
`final Optional<WebSearchTool.SearchContextSize>`	`searchContextSize()`	High level guidance for the amount of context window space to use for the search.
`final Optional<WebSearchTool.UserLocation>`	`userLocation()`
`final JsonField<WebSearchTool.Type>`	`_type()`	The type of the web search tool.
`final JsonField<WebSearchTool.SearchContextSize>`	`_searchContextSize()`	High level guidance for the amount of context window space to use for the search.
`final JsonField<WebSearchTool.UserLocation>`	`_userLocation()`
`final Map<String, JsonValue>`	`_additionalProperties()`
`final WebSearchTool`	`validate()`
`final WebSearchTool.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static WebSearchTool.Builder`	`builder()`	Returns a mutable builder for constructing an instance of WebSearchTool.

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

- Constructor Detail
- Method Detail
  - type
```
 final WebSearchTool.Type type()
```
    The type of the web search tool. One of:
    web_search_preview
    web_search_preview_2025_03_11
  - searchContextSize
```
 final Optional<WebSearchTool.SearchContextSize> searchContextSize()
```
    High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
  - userLocation
```
 final Optional<WebSearchTool.UserLocation> userLocation()
```
  - _type
```
 final JsonField<WebSearchTool.Type> _type()
```
    The type of the web search tool. One of:
    web_search_preview
    web_search_preview_2025_03_11
  - _searchContextSize
```
 final JsonField<WebSearchTool.SearchContextSize> _searchContextSize()
```
    High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
  - _userLocation
```
 final JsonField<WebSearchTool.UserLocation> _userLocation()
```
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final WebSearchTool validate()
```
  - toBuilder
```
 final WebSearchTool.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static WebSearchTool.Builder builder()
```
    Returns a mutable builder for constructing an instance of WebSearchTool.
    The following fields are required:
    .type()

Class WebSearchTool

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

type

searchContextSize

userLocation

_type

_searchContextSize

_userLocation

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder