WebSearchTool

The built-in web search, executed on the API's side.

The model decides when to search, the server runs the query and continues generating — up to ten rounds — and each search surfaces as a WebSearchCallItem in the output. search_context_size and user_location are accepted by the API but ignored.

val params = responseParams { tools = listOf(WebSearchTool.webSearch) }

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val type: String

Raw tool type, either web_search or a dated variant of it.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String