Interface WebSearchTool

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

interface WebSearchTool {
    search_context_size?: "low" | "medium" | "high";
    type: "web_search_preview" | "web_search_preview_2025_03_11";
    user_location?: null | OpenAIClient.Responses.WebSearchTool.UserLocation;
}

Index

Properties

search_context_size? type user_location?

Properties

`Optional`search_context_size

search_context_size?: "low" | "medium" | "high"

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.

type

type: "web_search_preview" | "web_search_preview_2025_03_11"

The type of the web search tool. One of:

web_search_preview
web_search_preview_2025_03_11

`Optional`user_location

user_location?: null | OpenAIClient.Responses.WebSearchTool.UserLocation