google-genai/com.google.genai.types/ToolResponse

ToolResponse

public abstract class ToolResponse extends JsonSerializable

The output from a server-side `ToolCall` execution.

This message contains the results of a tool invocation that was initiated by a `ToolCall` from the model. The client should pass this `ToolResponse` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolCall`.

Constructors

public void ToolResponse()

Types

public abstract class Builder

Builder for ToolResponse.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

public static ToolResponse.Builder builder()

Instantiates a builder for ToolResponse.

public static ToolResponse fromJson(String jsonString)

Deserializes a JSON string to a ToolResponse object.

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

public abstract Optional<String> id()

The identifier of the tool call this response is for.

public static ObjectMapper objectMapper()

public abstract Optional<Map<String, Object>> response()

The tool response.

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

public abstract ToolResponse.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.

public abstract Optional<ToolType> toolType()

The type of tool that was called, matching the tool_type in the corresponding ToolCall.