Class ResponseFunctionWebSearch
-
- All Implemented Interfaces:
public final class ResponseFunctionWebSearch
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
ResponseFunctionWebSearch.Builder
A builder for ResponseFunctionWebSearch.
public final class
ResponseFunctionWebSearch.Status
The status of the web search tool call.
-
Method Summary
Modifier and Type Method Description final String
id()
The unique ID of the web search tool call. final ResponseFunctionWebSearch.Status
status()
The status of the web search tool call. final JsonValue
_type()
The type of the web search tool call. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<ResponseFunctionWebSearch.Status>
_status()
Returns the raw JSON value of status. final Map<String, JsonValue>
_additionalProperties()
final ResponseFunctionWebSearch.Builder
toBuilder()
final ResponseFunctionWebSearch
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionWebSearch.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFunctionWebSearch. -
-
Method Detail
-
status
final ResponseFunctionWebSearch.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).
-
_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.
-
_status
final JsonField<ResponseFunctionWebSearch.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFunctionWebSearch.Builder toBuilder()
-
validate
final ResponseFunctionWebSearch validate()
-
builder
final static ResponseFunctionWebSearch.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionWebSearch.
The following fields are required:
.id() .status()
-
-
-
-