All Implemented Interfaces:
```
public final class WebSearchPreviewTool

                    
```
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`	`WebSearchPreviewTool.Builder`	A builder for WebSearchPreviewTool.
`public final class`	`WebSearchPreviewTool.Type`	The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.
`public final class`	`WebSearchPreviewTool.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`	`WebSearchPreviewTool.UserLocation`	The user's location.

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

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

- Constructor Detail
- Method Detail
  - type
```
 final WebSearchPreviewTool.Type type()
```
    The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
  - searchContextSize
```
 final Optional<WebSearchPreviewTool.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<WebSearchPreviewTool.UserLocation> userLocation()
```
    The user's location.
  - _type
```
 final JsonField<WebSearchPreviewTool.Type> _type()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _searchContextSize
```
 final JsonField<WebSearchPreviewTool.SearchContextSize> _searchContextSize()
```
    Returns the raw JSON value of searchContextSize.
    Unlike searchContextSize, this method doesn't throw if the JSON field has an unexpected type.
  - _userLocation
```
 final JsonField<WebSearchPreviewTool.UserLocation> _userLocation()
```
    Returns the raw JSON value of userLocation.
    Unlike userLocation, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final WebSearchPreviewTool.Builder toBuilder()
```
  - validate
```
 final WebSearchPreviewTool validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static WebSearchPreviewTool.Builder builder()
```
    Returns a mutable builder for constructing an instance of WebSearchPreviewTool.
    The following fields are required:
    .type()

Class WebSearchPreviewTool

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

toBuilder

validate

isValid

equals

hashCode

toString

builder