Package com.openai.models.responses
Class WebSearchTool.Builder
-
- All Implemented Interfaces:
public final class WebSearchTool.Builder
A builder for WebSearchTool.
-
-
Method Summary
-
-
Method Detail
-
type
final WebSearchTool.Builder type(WebSearchTool.Type type)
The type of the web search tool. One of:
web_search_preview
web_search_preview_2025_03_11
-
type
final WebSearchTool.Builder type(JsonField<WebSearchTool.Type> type)
The type of the web search tool. One of:
web_search_preview
web_search_preview_2025_03_11
-
searchContextSize
final WebSearchTool.Builder searchContextSize(WebSearchTool.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.
-
searchContextSize
final WebSearchTool.Builder searchContextSize(JsonField<WebSearchTool.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 WebSearchTool.Builder userLocation(WebSearchTool.UserLocation userLocation)
-
userLocation
final WebSearchTool.Builder userLocation(Optional<WebSearchTool.UserLocation> userLocation)
-
userLocation
final WebSearchTool.Builder userLocation(JsonField<WebSearchTool.UserLocation> userLocation)
-
additionalProperties
final WebSearchTool.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final WebSearchTool.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final WebSearchTool.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final WebSearchTool.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final WebSearchTool.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final WebSearchTool build()
-
-
-
-