Package com.openai.models.responses
Class ResponseFunctionToolCall
-
- All Implemented Interfaces:
public final class ResponseFunctionToolCall
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
ResponseFunctionToolCall.Builder
A builder for ResponseFunctionToolCall.
public final class
ResponseFunctionToolCall.Status
The status of the item. One of
in_progress
,completed
, orincomplete
. Populated when items are returned via API.
-
Method Summary
Modifier and Type Method Description final String
id()
The unique ID of the function tool call. 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<ResponseFunctionToolCall.Status>
status()
The status of the item. final JsonField<String>
_id()
The unique ID of the function tool call. final JsonField<String>
_arguments()
A JSON string of the arguments to pass to the function. final JsonField<String>
_callId()
The unique ID of the function tool call generated by the model. final JsonField<String>
_name()
The name of the function to run. final JsonField<ResponseFunctionToolCall.Status>
_status()
The status of the item. final Map<String, JsonValue>
_additionalProperties()
final ResponseFunctionToolCall
validate()
final ResponseFunctionToolCall.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionToolCall.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCall. -
-
Method Detail
-
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()
A JSON string of the arguments to pass to the function.
-
_callId
final JsonField<String> _callId()
The unique ID of the function tool call generated by the model.
-
_status
final JsonField<ResponseFunctionToolCall.Status> _status()
The status of the item. One of
in_progress
,completed
, orincomplete
. Populated when items are returned via API.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ResponseFunctionToolCall validate()
-
toBuilder
final ResponseFunctionToolCall.Builder toBuilder()
-
builder
final static ResponseFunctionToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCall.
The following fields are required:
.id() .arguments() .callId() .name()
-
-
-
-