Class BetaResponseCustomToolCallOutput
-
- All Implemented Interfaces:
public final class BetaResponseCustomToolCallOutputThe 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 classBetaResponseCustomToolCallOutput.BuilderA builder for BetaResponseCustomToolCallOutput.
public final classBetaResponseCustomToolCallOutput.OutputThe output from the custom tool call generated by your code. Can be a string or an list of output content.
public final classBetaResponseCustomToolCallOutput.AgentThe agent that produced this item.
public final classBetaResponseCustomToolCallOutput.CallerThe execution context that produced this tool call.
-
Method Summary
Modifier and Type Method Description 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 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 Map<String, JsonValue>_additionalProperties()final BetaResponseCustomToolCallOutput.BuildertoBuilder()final BetaResponseCustomToolCallOutputvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseCustomToolCallOutput.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallOutput. -
-
Method Detail
-
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.
-
_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaResponseCustomToolCallOutput.Builder toBuilder()
-
validate
final BetaResponseCustomToolCallOutput 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 BetaResponseCustomToolCallOutput.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseCustomToolCallOutput.
The following fields are required:
.callId() .output()
-
-
-
-