Class BetaResponseFunctionToolCall
-
- All Implemented Interfaces:
public final class BetaResponseFunctionToolCallA tool call to run a function. See the function calling guide for more information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaResponseFunctionToolCall.BuilderA builder for BetaResponseFunctionToolCall.
public final classBetaResponseFunctionToolCall.AgentThe agent that produced this item.
public final classBetaResponseFunctionToolCall.CallerThe execution context that produced this tool call.
public final classBetaResponseFunctionToolCall.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 Stringarguments()A JSON string of the arguments to pass to the function. final StringcallId()The unique ID of the function tool call generated by the model. final Stringname()The name of the function to run. final JsonValue_type()The type of the function tool call. final Optional<String>id()The unique ID of the function tool call. final Optional<BetaResponseFunctionToolCall.Agent>agent()The agent that produced this item. final Optional<BetaResponseFunctionToolCall.Caller>caller()The execution context that produced this tool call. final Optional<String>namespace()The namespace of the function to run. final Optional<BetaResponseFunctionToolCall.Status>status()The status of the item. final JsonField<String>_arguments()Returns the raw JSON value of arguments. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<BetaResponseFunctionToolCall.Agent>_agent()Returns the raw JSON value of agent. final JsonField<BetaResponseFunctionToolCall.Caller>_caller()Returns the raw JSON value of caller. final JsonField<String>_namespace()Returns the raw JSON value of namespace. final JsonField<BetaResponseFunctionToolCall.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final BetaResponseFunctionToolCall.BuildertoBuilder()final BetaResponseFunctionToolCallvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaResponseFunctionToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of BetaResponseFunctionToolCall. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the function tool call. Always
function_call.Expected to always return the following:
JsonValue.from("function_call")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
agent
final Optional<BetaResponseFunctionToolCall.Agent> agent()
The agent that produced this item.
-
caller
final Optional<BetaResponseFunctionToolCall.Caller> caller()
The execution context that produced this tool call.
-
status
final Optional<BetaResponseFunctionToolCall.Status> status()
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
_arguments
final JsonField<String> _arguments()
Returns the raw JSON value of arguments.
Unlike arguments, 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.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, 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<BetaResponseFunctionToolCall.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<BetaResponseFunctionToolCall.Caller> _caller()
Returns the raw JSON value of caller.
Unlike caller, this method doesn't throw if the JSON field has an unexpected type.
-
_namespace
final JsonField<String> _namespace()
Returns the raw JSON value of namespace.
Unlike namespace, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BetaResponseFunctionToolCall.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 BetaResponseFunctionToolCall.Builder toBuilder()
-
validate
final BetaResponseFunctionToolCall 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 BetaResponseFunctionToolCall.Builder builder()
Returns a mutable builder for constructing an instance of BetaResponseFunctionToolCall.
The following fields are required:
.arguments() .callId() .name()
-
-
-
-