Constructor Detail

Method Detail

• type

   final WebSearchTool.Type type()

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

• searchContextSize

   final Optional<WebSearchTool.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<WebSearchTool.UserLocation> userLocation()

  The user's location.

• _type

   final JsonField<WebSearchTool.Type> _type()

  Returns the raw JSON value of type.

  Unlike type, this method doesn't throw if the JSON field has an unexpected type.

• _searchContextSize

   final JsonField<WebSearchTool.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<WebSearchTool.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 WebSearchTool.Builder toBuilder()

• validate

   final WebSearchTool validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static WebSearchTool.Builder builder()

  Returns a mutable builder for constructing an instance of WebSearchTool.

  The following fields are required:

  .type()