Class ExampleTool

java.lang.Object

com.google.adk.tools.BaseTool

com.google.adk.tools.ExampleTool

public final class ExampleTool
extends BaseTool

A tool that injects (few-shot) examples into the outgoing LLM request as system instructions.

Configuration (args) options for YAML:

• examples: Either a fully-qualified reference to a BaseExampleProvider instance (e.g., com.example.MyExamples.INSTANCE) or a list of examples with fields input and output (array of messages).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExampleTool.Builder	Builder for ExampleTool.

Nested classes/interfaces inherited from class BaseTool

BaseTool.ToolArgsConfig, BaseTool.ToolConfig

Method Summary

Modifier and Type	Method	Description
static ExampleTool.Builder	builder()
static ExampleTool	fromConfig(BaseTool.ToolArgsConfig args)	Overload to match resolver which passes only ToolArgsConfig.
static ExampleTool	fromConfig(BaseTool.ToolArgsConfig args, String configAbsPath)	Factory from YAML tool args.
io.reactivex.rxjava3.core.Completable	processLlmRequest(LlmRequest.Builder llmRequestBuilder, ToolContext toolContext)	Processes the outgoing LlmRequest.Builder.

Methods inherited from class BaseTool

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

Methods inherited from class Object

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

Method Details

processLlmRequest

public io.reactivex.rxjava3.core.Completable processLlmRequest(LlmRequest.Builder llmRequestBuilder,
 ToolContext toolContext)

Description copied from class: BaseTool

Processes the outgoing LlmRequest.Builder.

This implementation adds the current tool's BaseTool.declaration() to the GenerateContentConfig within the builder. If a tool with function declarations already exists, the current tool's declaration is merged into it. Otherwise, a new tool definition with the current tool's declaration is created. The current tool itself is also added to the builder's internal list of tools. Override this method for processing the outgoing request.

Overrides:

processLlmRequest in class BaseTool

fromConfig

public static ExampleTool fromConfig(BaseTool.ToolArgsConfig args,
 String configAbsPath)
                              throws ConfigAgentUtils.ConfigurationException

Factory from YAML tool args.

Throws:

ConfigAgentUtils.ConfigurationException

fromConfig

public static ExampleTool fromConfig(BaseTool.ToolArgsConfig args)
                              throws ConfigAgentUtils.ConfigurationException

Overload to match resolver which passes only ToolArgsConfig.

Throws:

ConfigAgentUtils.ConfigurationException

builder

public static ExampleTool.Builder builder()