Class ChatCompletionCreateParams.WebSearchOptions
-
- 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
, orhigh
.medium
is the default.public final class
ChatCompletionCreateParams.WebSearchOptions.UserLocation
Approximate location parameters for the search.
-
Method Summary
-
-
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
, orhigh
.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()
-
builder
final static ChatCompletionCreateParams.WebSearchOptions.Builder builder()
Returns a mutable builder for constructing an instance of WebSearchOptions.
-
-
-
-