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