Share via


ItemWebSearchToolCall interface

The results of a web search tool call. See the web search guide for more information.

Extends

Properties

action

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find).

id

The unique ID of the web search tool call.

status

The status of the web search tool call.

type

The type of the web search tool call. Always web_search_call.

Property Details

action

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find).

action: WebSearchActionSearch | WebSearchActionOpenPage | WebSearchActionFind

Property Value

id

The unique ID of the web search tool call.

id: string

Property Value

string

status

The status of the web search tool call.

status: "in_progress" | "completed" | "failed" | "searching"

Property Value

"in_progress" | "completed" | "failed" | "searching"

type

The type of the web search tool call. Always web_search_call.

type: "web_search_call"

Property Value

"web_search_call"