Class BetaResponseFunctionToolCallOutputItem
-
- All Implemented Interfaces:
public final class BetaResponseFunctionToolCallOutputItem
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseFunctionToolCallOutputItem.BuilderA builder for BetaResponseFunctionToolCallOutputItem.
public final classBetaResponseFunctionToolCallOutputItem.OutputThe output from the function call generated by your code. Can be a string or an list of output content.
public final classBetaResponseFunctionToolCallOutputItem.StatusThe status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.public final classBetaResponseFunctionToolCallOutputItem.AgentThe agent that produced this item.
public final classBetaResponseFunctionToolCallOutputItem.CallerThe execution context that produced this tool call.
-
Method Summary
Modifier and Type Method Description final Stringid()The unique ID of the function call tool output. final StringcallId()The unique ID of the function tool call generated by the model. final BetaResponseFunctionToolCallOutputItem.Outputoutput()The output from the function call generated by your code. final BetaResponseFunctionToolCallOutputItem.Statusstatus()The status of the item. final JsonValue_type()The type of the function tool call output. final Optional<BetaResponseFunctionToolCallOutputItem.Agent>agent()The agent that produced this item. final Optional<BetaResponseFunctionToolCallOutputItem.Caller>caller()The execution context that produced this tool call. final Optional<String>createdBy()The identifier of the actor that created 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<BetaResponseFunctionToolCallOutputItem.Output>_output()Returns the raw JSON value of output. final JsonField<BetaResponseFunctionToolCallOutputItem.Status>_status()Returns the raw JSON value of status. final JsonField<BetaResponseFunctionToolCallOutputItem.Agent>_agent()Returns the raw JSON value of agent. final JsonField<BetaResponseFunctionToolCallOutputItem.Caller>_caller()Returns the raw JSON value of caller. final JsonField<String>_createdBy()Returns the raw JSON value of createdBy. final Map<String, JsonValue>_additionalProperties()final BetaResponseFunctionToolCallOutputItem.BuildertoBuilder()final BetaResponseFunctionToolCallOutputItemvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseFunctionToolCallOutputItem.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseFunctionToolCallOutputItem. -
-
Method Detail
-
output
final BetaResponseFunctionToolCallOutputItem.Output output()
The output from the function call generated by your code. Can be a string or an list of output content.
-
status
final BetaResponseFunctionToolCallOutputItem.Status status()
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
_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).
-
agent
final Optional<BetaResponseFunctionToolCallOutputItem.Agent> agent()
The agent that produced this item.
-
caller
final Optional<BetaResponseFunctionToolCallOutputItem.Caller> caller()
The execution context that produced this tool call.
-
_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<BetaResponseFunctionToolCallOutputItem.Output> _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<BetaResponseFunctionToolCallOutputItem.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_agent
final JsonField<BetaResponseFunctionToolCallOutputItem.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<BetaResponseFunctionToolCallOutputItem.Caller> _caller()
Returns the raw JSON value of caller.
Unlike caller, 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 BetaResponseFunctionToolCallOutputItem.Builder toBuilder()
-
validate
final BetaResponseFunctionToolCallOutputItem 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 BetaResponseFunctionToolCallOutputItem.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseFunctionToolCallOutputItem.
The following fields are required:
.id() .callId() .output() .status()
-
-
-
-