Class FunctionTool

java.lang.Object

com.google.adk.tools.BaseTool

com.google.adk.tools.FunctionTool

Direct Known Subclasses:

ComputerUseTool, LoadMemoryTool, LongRunningFunctionTool

public class FunctionTool
extends BaseTool

FunctionTool implements a customized function calling tool.

Nested Class Summary

Nested classes/interfaces inherited from class BaseTool

BaseTool.ToolArgsConfig, BaseTool.ToolConfig

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FunctionTool(Object instance, Method func, boolean isLongRunning)
protected	FunctionTool(Object instance, Method func, boolean isLongRunning, boolean requireConfirmation)
protected	FunctionTool(Object instance, Method func, boolean isLongRunning, boolean requireConfirmation, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
protected	FunctionTool(Object instance, Method func, boolean isLongRunning, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

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.
io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(Map<String,Object> args, ToolContext toolContext)	Calls a tool.

Methods inherited from class BaseTool

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

Methods inherited from class Object

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

Constructor Details

FunctionTool

protected FunctionTool(@Nullable
 Object instance,
 Method func,
 boolean isLongRunning)

FunctionTool

protected FunctionTool(@Nullable
 Object instance,
 Method func,
 boolean isLongRunning,
 boolean requireConfirmation)

FunctionTool

protected FunctionTool(@Nullable
 Object instance,
 Method func,
 boolean isLongRunning,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

FunctionTool

protected FunctionTool(@Nullable
 Object instance,
 Method func,
 boolean isLongRunning,
 boolean requireConfirmation,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

create

public static FunctionTool create(Object instance,
 Method func)

create

public static FunctionTool create(Object instance,
 Method func,
 boolean requireConfirmation)

create

public static FunctionTool create(Object instance,
 Method func,
 boolean requireConfirmation,
 boolean isLongRunning)

create

public static FunctionTool create(Method func)

create

public static FunctionTool create(Method func,
 boolean requireConfirmation)

create

public static FunctionTool create(Method func,
 boolean requireConfirmation,
 boolean isLongRunning)

create

public static FunctionTool create(Class<?> cls,
 String methodName)

create

public static FunctionTool create(Class<?> cls,
 String methodName,
 boolean requireConfirmation)

create

public static FunctionTool create(Class<?> cls,
 String methodName,
 boolean requireConfirmation,
 boolean isLongRunning)

create

public static FunctionTool create(Object instance,
 String methodName)

create

public static FunctionTool create(Object instance,
 String methodName,
 boolean requireConfirmation)

create

public static FunctionTool create(Object instance,
 String methodName,
 boolean requireConfirmation,
 boolean isLongRunning)

declaration

public Optional<com.google.genai.types.FunctionDeclaration> declaration()

Description copied from class: BaseTool

Gets the FunctionDeclaration representation of this tool.

Overrides:

declaration in class BaseTool

func

public Method func()

Returns the underlying function Method.

isStreaming

public boolean isStreaming()

Returns true if the wrapped function returns a Flowable and can be used for streaming.

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 BaseTool

callLive

public io.reactivex.rxjava3.core.Flowable<Map<String,Object>> callLive(Map<String,Object> args,
 ToolContext toolContext,
 InvocationContext invocationContext)
                                                                throws IllegalAccessException,
InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException