Class BetaResponseCustomToolCallOutputItem
-
- All Implemented Interfaces:
public final class BetaResponseCustomToolCallOutputItemThe 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 classBetaResponseCustomToolCallOutputItem.BuilderA builder for BetaResponseCustomToolCallOutputItem.
public final classBetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputtoBetaResponseCustomToolCallOutput()final StringcallId()The call ID, used to map this custom tool call output to a custom tool call. final BetaResponseCustomToolCallOutput.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 Optional<BetaResponseCustomToolCallOutput.Agent>agent()The agent that produced this item. final Optional<BetaResponseCustomToolCallOutput.Caller>caller()The execution context that produced this tool call. final BetaResponseCustomToolCallOutputItem.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<BetaResponseCustomToolCallOutput.Output>_output()Returns the raw JSON value of output. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<BetaResponseCustomToolCallOutput.Agent>_agent()Returns the raw JSON value of agent. final JsonField<BetaResponseCustomToolCallOutput.Caller>_caller()Returns the raw JSON value of caller. final JsonField<BetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputItem.BuildertoBuilder()final BetaResponseCustomToolCallOutputItemvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseCustomToolCallOutputItem.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallOutputItem. -
-
Method Detail
-
toBetaResponseCustomToolCallOutput
final BetaResponseCustomToolCallOutput toBetaResponseCustomToolCallOutput()
-
callId
final String callId()
The call ID, used to map this custom tool call output to a custom tool call.
-
output
final BetaResponseCustomToolCallOutput.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).
-
agent
final Optional<BetaResponseCustomToolCallOutput.Agent> agent()
The agent that produced this item.
-
caller
final Optional<BetaResponseCustomToolCallOutput.Caller> caller()
The execution context that produced this tool call.
-
status
final BetaResponseCustomToolCallOutputItem.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<BetaResponseCustomToolCallOutput.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.
-
_agent
final JsonField<BetaResponseCustomToolCallOutput.Agent> _agent()
Returns the raw JSON value of agent.
Unlike agent, this method doesn't throw if the JSON field has an unexpected type.
-
_caller
final JsonField<BetaResponseCustomToolCallOutput.Caller> _caller()
Returns the raw JSON value of caller.
Unlike caller, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BetaResponseCustomToolCallOutputItem.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 BetaResponseCustomToolCallOutputItem.Builder toBuilder()
-
validate
final BetaResponseCustomToolCallOutputItem validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaResponseCustomToolCallOutputItem.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallOutputItem.
The following fields are required:
.callId() .output() .status()
-
-
-
-