Class ComputerUseTool

java.lang.Object

com.google.adk.tools.BaseTool

com.google.adk.tools.FunctionTool

com.google.adk.tools.computeruse.ComputerUseTool

public class ComputerUseTool
extends FunctionTool

A tool that wraps computer control functions for use with LLMs.

This tool automatically normalizes coordinates from a virtual coordinate space (by default 1000x1000) to the actual screen size.

Nested Class Summary

Nested classes/interfaces inherited from class BaseTool

BaseTool.ToolArgsConfig, BaseTool.ToolConfig

Modifier and Type	Class	Description
static class	BaseTool.ToolArgsConfig	Configuration class for tool arguments that allows arbitrary key-value pairs.
static class	BaseTool.ToolConfig	Configuration class for a tool definition in YAML/JSON.

Constructor Summary

Constructors

Constructor	Description
ComputerUseTool(Object instance, Method func, int[] screenSize, int[] virtualScreenSize)

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(Map<String,Object> args, ToolContext toolContext)	Calls a tool.

Methods inherited from class FunctionTool

callLive, create, create, create, create, create, create, create, create, create, create, create, create, declaration, func, isStreaming

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Flowable<Map<String,Object>>	callLive(Map<String,Object> args, ToolContext toolContext, InvocationContext invocationContext)
static FunctionTool	create(Class<?> cls, String methodName)
static FunctionTool	create(Class<?> cls, String methodName, boolean requireConfirmation)
static FunctionTool	create(Class<?> cls, String methodName, boolean requireConfirmation, boolean isLongRunning)
static FunctionTool	create(Object instance, Method func)
static FunctionTool	create(Object instance, Method func, boolean requireConfirmation)
static FunctionTool	create(Object instance, Method func, boolean requireConfirmation, boolean isLongRunning)
static FunctionTool	create(Object instance, String methodName)
static FunctionTool	create(Object instance, String methodName, boolean requireConfirmation)
static FunctionTool	create(Object instance, String methodName, boolean requireConfirmation, boolean isLongRunning)
static FunctionTool	create(Method func)
static FunctionTool	create(Method func, boolean requireConfirmation)
static FunctionTool	create(Method func, boolean requireConfirmation, boolean isLongRunning)
Optional<com.google.genai.types.FunctionDeclaration>	declaration()	Gets the FunctionDeclaration representation of this tool.
Method	func()	Returns the underlying function Method.
boolean	isStreaming()	Returns true if the wrapped function returns a Flowable and can be used for streaming.

Methods inherited from class BaseTool

customMetadata, description, fromConfig, longRunning, name, processLlmRequest, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, setCustomMetadata

Modifier and Type	Method	Description
com.google.common.collect.ImmutableMap<String,Object>	customMetadata()	Returns a read-only view of the tool metadata.
String	description()
static BaseTool	fromConfig(BaseTool.ToolConfig config, String configAbsPath)	Creates a tool instance from a config.
boolean	longRunning()
String	name()
io.reactivex.rxjava3.core.Completable	processLlmRequest(LlmRequest.Builder llmRequestBuilder, ToolContext toolContext)	Processes the outgoing LlmRequest.Builder.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)	Calls a tool with generic arguments, returning the results converted to a specified type reference.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)	Calls a tool with generic arguments and a custom ObjectMapper, returning the results converted to a specified type reference.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Class<? extends O> oClass)	Calls a tool with generic arguments and a custom ObjectMapper, returning the results converted to a specified class.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, Class<? extends O> oClass)	Calls a tool with generic arguments, returning the results converted to a specified class.
final <T> io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(T args, ToolContext toolContext)	Calls a tool with generic arguments and returns a map of results.
final <T> io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(T args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Calls a tool with generic arguments using a custom ObjectMapper and returns a map of results.
void	setCustomMetadata(String key, Object value)	Sets custom metadata to the tool associated with a key.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ComputerUseTool

public ComputerUseTool(Object instance,
 Method func,
 int[] screenSize,
 int[] virtualScreenSize)

Method Details

runAsync

public io.reactivex.rxjava3.core.Single<Map<String,Object>> runAsync(Map<String,Object> args,
 ToolContext toolContext)

Description copied from class: BaseTool

Calls a tool.

Overrides:

runAsync in class FunctionTool