Class ResponseFunctionToolCallOutputItem
-
- All Implemented Interfaces:
public final class ResponseFunctionToolCallOutputItem
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFunctionToolCallOutputItem.Builder
A builder for ResponseFunctionToolCallOutputItem.
public final class
ResponseFunctionToolCallOutputItem.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 call tool output. 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<ResponseFunctionToolCallOutputItem.Status>
status()
The status of the item. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<String>
_callId()
Returns the raw JSON value of callId. final JsonField<String>
_output()
Returns the raw JSON value of output. final JsonField<ResponseFunctionToolCallOutputItem.Status>
_status()
Returns the raw JSON value of status. final Map<String, JsonValue>
_additionalProperties()
final ResponseFunctionToolCallOutputItem.Builder
toBuilder()
final ResponseFunctionToolCallOutputItem
validate()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionToolCallOutputItem.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCallOutputItem. -
-
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).
-
status
final Optional<ResponseFunctionToolCallOutputItem.Status> status()
The status of the item. One of
in_progress
,completed
, orincomplete
. Populated when items are returned via API.
-
_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.
-
_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.
-
_status
final JsonField<ResponseFunctionToolCallOutputItem.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 ResponseFunctionToolCallOutputItem.Builder toBuilder()
-
validate
final ResponseFunctionToolCallOutputItem validate()
-
builder
final static ResponseFunctionToolCallOutputItem.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionToolCallOutputItem.
The following fields are required:
.id() .callId() .output()
-
-
-
-