Interface WebSearchOptions

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

interface WebSearchOptions {
    search_context_size?: "low" | "medium" | "high";
    user_location?:
        | ChatCompletionCreateParams.WebSearchOptions.UserLocation
        | null;
}

Properties

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.

Approximate location parameters for the search.