All Implemented Interfaces:
```
public final class BetaResponseFunctionWebSearch

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaResponseFunctionWebSearch.Builder`	A builder for BetaResponseFunctionWebSearch.
`public final class`	`BetaResponseFunctionWebSearch.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_in_page).
`public final class`	`BetaResponseFunctionWebSearch.Status`	The status of the web search tool call.
`public final class`	`BetaResponseFunctionWebSearch.Agent`	The agent that produced this item.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The unique ID of the web search tool call.
`final BetaResponseFunctionWebSearch.Action`	`action()`	An object describing the specific action taken in this web search call.
`final BetaResponseFunctionWebSearch.Status`	`status()`	The status of the web search tool call.
`final JsonValue`	`_type()`	The type of the web search tool call.
`final Optional<BetaResponseFunctionWebSearch.Agent>`	`agent()`	The agent that produced this item.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<BetaResponseFunctionWebSearch.Action>`	`_action()`	Returns the raw JSON value of action.
`final JsonField<BetaResponseFunctionWebSearch.Status>`	`_status()`	Returns the raw JSON value of status.
`final JsonField<BetaResponseFunctionWebSearch.Agent>`	`_agent()`	Returns the raw JSON value of agent.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaResponseFunctionWebSearch.Builder`	`toBuilder()`
`final BetaResponseFunctionWebSearch`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BetaResponseFunctionWebSearch.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BetaResponseFunctionWebSearch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The unique ID of the web search tool call.
  - action
```
 final BetaResponseFunctionWebSearch.Action 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_in_page).
  - status
```
 final BetaResponseFunctionWebSearch.Status status()
```
    The status of the web search tool call.
  - _type
```
 final JsonValue _type()
```
    The type of the web search tool call. Always web_search_call.
    Expected to always return the following:
    JsonValue.from("web_search_call")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - agent
```
 final Optional<BetaResponseFunctionWebSearch.Agent> agent()
```
    The agent that produced this item.
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _action
```
 final JsonField<BetaResponseFunctionWebSearch.Action> _action()
```
    Returns the raw JSON value of action.
    Unlike action, this method doesn't throw if the JSON field has an unexpected type.
  - _status
```
 final JsonField<BetaResponseFunctionWebSearch.Status> _status()
```
    Returns the raw JSON value of status.
    Unlike status, this method doesn't throw if the JSON field has an unexpected type.
  - _agent
```
 final JsonField<BetaResponseFunctionWebSearch.Agent> _agent()
```
    Returns the raw JSON value of agent.
    Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final BetaResponseFunctionWebSearch.Builder toBuilder()
```
  - validate
```
 final BetaResponseFunctionWebSearch validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BetaResponseFunctionWebSearch.Builder builder()
```
    Returns a mutable builder for constructing an instance of BetaResponseFunctionWebSearch.
    The following fields are required:
    .id() .action() .status()

Class BetaResponseFunctionWebSearch

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

action

status

_type

agent

_id

_action

_status

_agent

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder