Interface WebSearchOptions

Options for the OpenAI web search tool.

interface WebSearchOptions {
    filters?: null | Filters;
    searchContextSize?: null | WebSearchContextSize;
    userLocation?: null | UserLocation;
}

Index

Properties

filters? searchContextSize? userLocation?

Properties

`Optional` filters

filters?: null | Filters

Filters for the search, such as allowed domains. If not provided, all domains are allowed.

`Optional` searchContextSize

searchContextSize?: null | WebSearchContextSize

Amount of context window space to use for the search. Defaults to medium.

`Optional` userLocation

userLocation?: null | UserLocation

Approximate location of the user, such as city, region, country, or timezone.