Class ResponseCustomToolCallOutputItem
-
- All Implemented Interfaces:
public final class ResponseCustomToolCallOutputItemThe output of a custom tool call from your code, being sent back to the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCustomToolCallOutputItem.BuilderA builder for ResponseCustomToolCallOutputItem.
public final classResponseCustomToolCallOutputItem.StatusThe 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 ResponseCustomToolCallOutputtoResponseCustomToolCallOutput()final StringcallId()The call ID, used to map this custom tool call output to a custom tool call. final ResponseCustomToolCallOutput.Outputoutput()The output from the custom tool call generated by your code. final JsonValue_type()The type of the custom tool call output. final Optional<String>id()The unique ID of the custom tool call output in the OpenAI platform. final ResponseCustomToolCallOutputItem.Statusstatus()The status of the item. final Optional<String>createdBy()The identifier of the actor that created the item. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<ResponseCustomToolCallOutput.Output>_output()Returns the raw JSON value of output. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<ResponseCustomToolCallOutputItem.Status>_status()Returns the raw JSON value of status. final JsonField<String>_createdBy()Returns the raw JSON value of createdBy. final Map<String, JsonValue>_additionalProperties()final ResponseCustomToolCallOutputItem.BuildertoBuilder()final ResponseCustomToolCallOutputItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCustomToolCallOutputItem.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseCustomToolCallOutputItem. -
-
Method Detail
-
toResponseCustomToolCallOutput
final ResponseCustomToolCallOutput toResponseCustomToolCallOutput()
-
callId
final String callId()
The call ID, used to map this custom tool call output to a custom tool call.
-
output
final ResponseCustomToolCallOutput.Output output()
The output from the custom tool call generated by your code. Can be a string or an list of output content.
-
_type
final JsonValue _type()
The type of the custom tool call output. Always
custom_tool_call_output.Expected to always return the following:
JsonValue.from("custom_tool_call_output")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
status
final ResponseCustomToolCallOutputItem.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<ResponseCustomToolCallOutput.Output> _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<ResponseCustomToolCallOutputItem.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_createdBy
final JsonField<String> _createdBy()
Returns the raw JSON value of createdBy.
Unlike createdBy, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCustomToolCallOutputItem.Builder toBuilder()
-
validate
final ResponseCustomToolCallOutputItem validate()
-
builder
final static ResponseCustomToolCallOutputItem.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCallOutputItem.
The following fields are required:
.callId() .output() .status()
-
-
-
-