Class BetaWebSearchTool20260209.Builder
-
- All Implemented Interfaces:
public final class BetaWebSearchTool20260209.BuilderA builder for BetaWebSearchTool20260209.
-
-
Method Summary
-
-
Method Detail
-
name
final BetaWebSearchTool20260209.Builder name(JsonValue name)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("web_search")This method is primarily for setting the field to an undocumented or not yet supported value.
-
type
final BetaWebSearchTool20260209.Builder type(JsonValue type)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("web_search_20260209")This method is primarily for setting the field to an undocumented or not yet supported value.
-
allowedCallers
final BetaWebSearchTool20260209.Builder allowedCallers(List<BetaWebSearchTool20260209.AllowedCaller> allowedCallers)
-
allowedCallers
final BetaWebSearchTool20260209.Builder allowedCallers(JsonField<List<BetaWebSearchTool20260209.AllowedCaller>> allowedCallers)
Sets Builder.allowedCallers to an arbitrary JSON value.
You should usually call Builder.allowedCallers with a well-typed
List<AllowedCaller>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addAllowedCaller
final BetaWebSearchTool20260209.Builder addAllowedCaller(BetaWebSearchTool20260209.AllowedCaller allowedCaller)
Adds a single AllowedCaller to allowedCallers.
-
allowedDomains
final BetaWebSearchTool20260209.Builder allowedDomains(List<String> allowedDomains)
If provided, only these domains will be included in results. Cannot be used alongside
blocked_domains.
-
allowedDomains
final BetaWebSearchTool20260209.Builder allowedDomains(Optional<List<String>> allowedDomains)
Alias for calling Builder.allowedDomains with
allowedDomains.orElse(null).
-
allowedDomains
final BetaWebSearchTool20260209.Builder allowedDomains(JsonField<List<String>> allowedDomains)
Sets Builder.allowedDomains to an arbitrary JSON value.
You should usually call Builder.allowedDomains with a well-typed
List<String>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addAllowedDomain
final BetaWebSearchTool20260209.Builder addAllowedDomain(String allowedDomain)
Adds a single String to allowedDomains.
-
blockedDomains
final BetaWebSearchTool20260209.Builder blockedDomains(List<String> blockedDomains)
If provided, these domains will never appear in results. Cannot be used alongside
allowed_domains.
-
blockedDomains
final BetaWebSearchTool20260209.Builder blockedDomains(Optional<List<String>> blockedDomains)
Alias for calling Builder.blockedDomains with
blockedDomains.orElse(null).
-
blockedDomains
final BetaWebSearchTool20260209.Builder blockedDomains(JsonField<List<String>> blockedDomains)
Sets Builder.blockedDomains to an arbitrary JSON value.
You should usually call Builder.blockedDomains with a well-typed
List<String>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addBlockedDomain
final BetaWebSearchTool20260209.Builder addBlockedDomain(String blockedDomain)
Adds a single String to blockedDomains.
-
cacheControl
final BetaWebSearchTool20260209.Builder cacheControl(BetaCacheControlEphemeral cacheControl)
Create a cache control breakpoint at this content block.
-
cacheControl
final BetaWebSearchTool20260209.Builder cacheControl(Optional<BetaCacheControlEphemeral> cacheControl)
Alias for calling Builder.cacheControl with
cacheControl.orElse(null).
-
cacheControl
final BetaWebSearchTool20260209.Builder cacheControl(JsonField<BetaCacheControlEphemeral> cacheControl)
Sets Builder.cacheControl to an arbitrary JSON value.
You should usually call Builder.cacheControl with a well-typed BetaCacheControlEphemeral value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
deferLoading
final BetaWebSearchTool20260209.Builder deferLoading(Boolean deferLoading)
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
-
deferLoading
final BetaWebSearchTool20260209.Builder deferLoading(JsonField<Boolean> deferLoading)
Sets Builder.deferLoading to an arbitrary JSON value.
You should usually call Builder.deferLoading with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
maxUses
final BetaWebSearchTool20260209.Builder maxUses(Long maxUses)
Maximum number of times the tool can be used in the API request.
-
maxUses
final BetaWebSearchTool20260209.Builder maxUses(Long maxUses)
Alias for Builder.maxUses.
This unboxed primitive overload exists for backwards compatibility.
-
maxUses
final BetaWebSearchTool20260209.Builder maxUses(Optional<Long> maxUses)
Alias for calling Builder.maxUses with
maxUses.orElse(null).
-
maxUses
final BetaWebSearchTool20260209.Builder maxUses(JsonField<Long> maxUses)
Sets Builder.maxUses to an arbitrary JSON value.
You should usually call Builder.maxUses with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
strict
final BetaWebSearchTool20260209.Builder strict(Boolean strict)
When true, guarantees schema validation on tool names and inputs
-
strict
final BetaWebSearchTool20260209.Builder strict(JsonField<Boolean> strict)
Sets Builder.strict to an arbitrary JSON value.
You should usually call Builder.strict with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
userLocation
final BetaWebSearchTool20260209.Builder userLocation(BetaUserLocation userLocation)
Parameters for the user's location. Used to provide more relevant search results.
-
userLocation
final BetaWebSearchTool20260209.Builder userLocation(Optional<BetaUserLocation> userLocation)
Alias for calling Builder.userLocation with
userLocation.orElse(null).
-
userLocation
final BetaWebSearchTool20260209.Builder userLocation(JsonField<BetaUserLocation> userLocation)
Sets Builder.userLocation to an arbitrary JSON value.
You should usually call Builder.userLocation with a well-typed BetaUserLocation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final BetaWebSearchTool20260209.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final BetaWebSearchTool20260209.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final BetaWebSearchTool20260209.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final BetaWebSearchTool20260209.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final BetaWebSearchTool20260209.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final BetaWebSearchTool20260209 build()
Returns an immutable instance of BetaWebSearchTool20260209.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-