Class ResponseFunctionToolCallItem
-
- All Implemented Interfaces:
public final class ResponseFunctionToolCallItem
A tool call to run a function. See the function calling guide for more information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFunctionToolCallItem.Builder
A builder for ResponseFunctionToolCallItem.
-
Method Summary
Modifier and Type Method Description final ResponseFunctionToolCall
toResponseFunctionToolCall()
final String
arguments()
A JSON string of the arguments to pass to the function. final String
callId()
The unique ID of the function tool call generated by the model. final String
name()
The name of the function to run. final JsonValue
_type()
The type of the function tool call. final Optional<String>
id()
The unique ID of the function tool call. final Optional<ResponseFunctionToolCall.Status>
status()
The status of the item. final JsonField<String>
_arguments()
Returns the raw JSON value of arguments. final JsonField<String>
_callId()
Returns the raw JSON value of callId. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<ResponseFunctionToolCall.Status>
_status()
Returns the raw JSON value of status. final Map<String, JsonValue>
_additionalProperties()
final ResponseFunctionToolCallItem.Builder
toBuilder()
final ResponseFunctionToolCallItem
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionToolCallItem.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCallItem. -
-
Method Detail
-
toResponseFunctionToolCall
final ResponseFunctionToolCall toResponseFunctionToolCall()
-
_type
final JsonValue _type()
The type of the function tool call. Always
function_call
.Expected to always return the following:
JsonValue.from("function_call")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
status
final Optional<ResponseFunctionToolCall.Status> status()
The status of the item. One of
in_progress
,completed
, orincomplete
. Populated when items are returned via API.
-
_arguments
final JsonField<String> _arguments()
Returns the raw JSON value of arguments.
Unlike arguments, this method doesn't throw if the JSON field has an unexpected type.
-
_callId
final JsonField<String> _callId()
Returns the raw JSON value of callId.
Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_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<ResponseFunctionToolCall.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 ResponseFunctionToolCallItem.Builder toBuilder()
-
validate
final ResponseFunctionToolCallItem validate()
-
builder
final static ResponseFunctionToolCallItem.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCallItem.
The following fields are required:
.arguments() .callId() .name()
-
-
-
-