Class WebSearch

Search the Internet for sources related to the prompt.

See

https://platform.openai.com/docs/guides/tools-web-search

Hierarchy (view full)

Constructors

constructor

Properties

[PROVIDER_TOOL_SYMBOL] [TOOL_SYMBOL] filters id searchContextSize type userLocation

Methods

toToolConfig

Constructors

constructor

Properties

Readonly [PROVIDER_TOOL_SYMBOL]

[PROVIDER_TOOL_SYMBOL]: true

Readonly [TOOL_SYMBOL]

[TOOL_SYMBOL]: true

Readonly filters

filters: undefined | null | Filters

Filters for the search, such as allowed domains.

Readonly id

id: string

Stable identifier used to key the tool inside a ToolContext. For function tools this mirrors name; for provider tools this is the provider tool id.

Readonly searchContextSize

searchContextSize: null | WebSearchContextSize

Amount of context window space to use for the search.

Readonly type

type: "provider"

Readonly userLocation

userLocation: undefined | null | UserLocation

Approximate location of the user.

Methods

toToolConfig

Settings

Member Visibility

Theme

On This Page

constructor[PROVIDER_TOOL_SYMBOL][TOOL_SYMBOL]filtersidsearchContextSizetypeuserLocationtoToolConfig