class

OpenAI::WebSearchToolCall

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)
Source
new(id : String = "", type_value : WebSearchToolCallType = WebSearchToolCallType::WebSearchCall, status : WebSearchToolCallStatus = WebSearchToolCallStatus::InProgress, action : WebSearchToolCallAction = WebSearchActionSearch.new)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

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).

Source
action=(action : WebSearchToolCallAction)

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).

Source
id

The unique ID of the web search tool call.

Source
id=(id : String)

The unique ID of the web search tool call.

Source
status

The status of the web search tool call.

Source
status=(status : WebSearchToolCallStatus)

The status of the web search tool call.

Source
type_value

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

Source
type_value=(type_value : WebSearchToolCallType)

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

Source