ToolCall

public abstract class ToolCall extends JsonSerializable

A predicted server-side `ToolCall` returned from the model.

This message contains information about a tool that the model wants to invoke. The client is NOT expected to execute this `ToolCall`. Instead, the client should pass this `ToolCall` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolResponse`.

Constructors

Link copied to clipboard
public void ToolCall()

Types

Link copied to clipboard
public abstract class Builder
Builder for ToolCall.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<Map<String, Object>> args()
The tool call arguments.
Link copied to clipboard
public static ToolCall.Builder builder()
Instantiates a builder for ToolCall.
Link copied to clipboard
public static ToolCall fromJson(String jsonString)
Deserializes a JSON string to a ToolCall object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<String> id()
Unique identifier of the tool call.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract ToolCall.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<ToolType> toolType()
The type of tool that was called.