Constructor Detail

Method Detail

• type

   final WebSearchPreviewTool.Builder type(WebSearchPreviewTool.Type type)

  The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.

• type

   final WebSearchPreviewTool.Builder type(JsonField<WebSearchPreviewTool.Type> type)

  Sets Builder.type to an arbitrary JSON value.

  You should usually call Builder.type with a well-typed Type value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• searchContextSize

   final WebSearchPreviewTool.Builder searchContextSize(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.

• searchContextSize

   final WebSearchPreviewTool.Builder searchContextSize(JsonField<WebSearchPreviewTool.SearchContextSize> searchContextSize)

  Sets Builder.searchContextSize to an arbitrary JSON value.

  You should usually call Builder.searchContextSize with a well-typed SearchContextSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• userLocation

   final WebSearchPreviewTool.Builder userLocation(WebSearchPreviewTool.UserLocation userLocation)

  The user's location.

• userLocation

   final WebSearchPreviewTool.Builder userLocation(Optional<WebSearchPreviewTool.UserLocation> userLocation)

  Alias for calling Builder.userLocation with userLocation.orElse(null).

• userLocation

   final WebSearchPreviewTool.Builder userLocation(JsonField<WebSearchPreviewTool.UserLocation> userLocation)

  Sets Builder.userLocation to an arbitrary JSON value.

  You should usually call Builder.userLocation with a well-typed UserLocation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final WebSearchPreviewTool.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final WebSearchPreviewTool.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final WebSearchPreviewTool.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final WebSearchPreviewTool.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final WebSearchPreviewTool.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final WebSearchPreviewTool build()

  Returns an immutable instance of WebSearchPreviewTool.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .type()