All Implemented Interfaces:
```
public final class ChatCompletionCreateParams.WebSearchOptions

                    
```
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`	`ChatCompletionCreateParams.WebSearchOptions.Builder`	A builder for WebSearchOptions.
`public final class`	`ChatCompletionCreateParams.WebSearchOptions.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`	`ChatCompletionCreateParams.WebSearchOptions.UserLocation`	Approximate location parameters for the search.

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<ChatCompletionCreateParams.WebSearchOptions.SearchContextSize>`	`searchContextSize()`	High level guidance for the amount of context window space to use for the search.
`final Optional<ChatCompletionCreateParams.WebSearchOptions.UserLocation>`	`userLocation()`	Approximate location parameters for the search.
`final JsonField<ChatCompletionCreateParams.WebSearchOptions.SearchContextSize>`	`_searchContextSize()`	Returns the raw JSON value of searchContextSize.
`final JsonField<ChatCompletionCreateParams.WebSearchOptions.UserLocation>`	`_userLocation()`	Returns the raw JSON value of userLocation.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ChatCompletionCreateParams.WebSearchOptions.Builder`	`toBuilder()`
`final ChatCompletionCreateParams.WebSearchOptions`	`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 ChatCompletionCreateParams.WebSearchOptions.Builder`	`builder()`	Returns a mutable builder for constructing an instance of WebSearchOptions.

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

- Constructor Detail
- Method Detail
  - searchContextSize
```
 final Optional<ChatCompletionCreateParams.WebSearchOptions.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<ChatCompletionCreateParams.WebSearchOptions.UserLocation> userLocation()
```
    Approximate location parameters for the search.
  - _searchContextSize
```
 final JsonField<ChatCompletionCreateParams.WebSearchOptions.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<ChatCompletionCreateParams.WebSearchOptions.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 ChatCompletionCreateParams.WebSearchOptions.Builder toBuilder()
```
  - validate
```
 final ChatCompletionCreateParams.WebSearchOptions 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()
```
  - builder
```
 final static ChatCompletionCreateParams.WebSearchOptions.Builder builder()
```
    Returns a mutable builder for constructing an instance of WebSearchOptions.

Class ChatCompletionCreateParams.WebSearchOptions

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

searchContextSize

userLocation

_searchContextSize

_userLocation

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder