Class ToolContext

java.lang.Object

com.google.adk.agents.ReadonlyContext

com.google.adk.agents.Context

com.google.adk.agents.CallbackContext

com.google.adk.tools.ToolContext

public class ToolContext
extends CallbackContext

ToolContext object provides a structured context for executing tools or functions.

Extends CallbackContext (and through it Context); BaseTool.runAsync(Map, ToolContext) and tool callbacks take this type.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class Context

eventActions

Modifier and Type	Field	Description
protected EventActions	eventActions	The event actions that record this context's changes.

Fields inherited from class ReadonlyContext

invocationContext

Modifier and Type	Field	Description
protected final InvocationContext	invocationContext

Method Summary

Modifier and Type	Method	Description
static ToolContext.Builder	builder(InvocationContext invocationContext)
void	setActions(EventActions actions)
ToolContext.Builder	toBuilder()
String	toString()

Methods inherited from class Context

actions, eventActions, eventId, functionCallId, functionCallId, listArtifacts, loadArtifact, loadArtifact, requestConfirmation, requestConfirmation, requestConfirmation, saveArtifact, searchMemory, state, toolConfirmation, toolConfirmation

Modifier and Type	Method	Description
EventActions	actions()	Returns the same EventActions as Context.eventActions().
EventActions	eventActions()	Returns the EventActions associated with this context.
String	eventId()	Returns the ID of the event associated with this context, or null if there is none.
Optional<String>	functionCallId()	Returns the ID of the function call that invoked the current tool, if any.
void	functionCallId(@Nullable String functionCallId)	Sets the ID of the function call that invoked the current tool, or clears it if null.
io.reactivex.rxjava3.core.Single<List<String>>	listArtifacts()	Lists the filenames of the artifacts attached to the current session.
io.reactivex.rxjava3.core.Maybe<com.google.genai.types.Part>	loadArtifact(String filename)	Loads the latest version of an artifact from the service.
io.reactivex.rxjava3.core.Maybe<com.google.genai.types.Part>	loadArtifact(String filename, int version)	Loads a specific version of an artifact from the service.
void	requestConfirmation()	Requests confirmation for the current function call.
void	requestConfirmation(@Nullable String hint)	Requests confirmation for the current function call.
void	requestConfirmation(@Nullable String hint, @Nullable Object payload)	Requests confirmation for the current function call.
io.reactivex.rxjava3.core.Completable	saveArtifact(String filename, com.google.genai.types.Part artifact)	Saves an artifact and records it as a delta for the current session.
io.reactivex.rxjava3.core.Single<SearchMemoryResponse>	searchMemory(String query)	Searches the memory of the current user.
State	state()	Returns the delta-aware state of the current context.
Optional<ToolConfirmation>	toolConfirmation()	Returns the confirmation of the current tool call, if any.
void	toolConfirmation(@Nullable ToolConfirmation toolConfirmation)	Sets the confirmation of the current tool call, or clears it if null.

Methods inherited from class ReadonlyContext

agentName, branch, events, invocationContext, invocationId, sessionId, userContent, userId

Modifier and Type	Method	Description
String	agentName()	Returns the name of the agent currently running.
Optional<String>	branch()	Returns the branch of the current invocation, if present.
List<Event>	events()	Returns an unmodifiable view of the events of the session.
InvocationContext	invocationContext()	Returns the invocation context.
String	invocationId()	Returns the ID of the current invocation.
String	sessionId()	Returns the session ID.
Optional<com.google.genai.types.Content>	userContent()	Returns the user content that initiated this invocation.
String	userId()	Returns the user ID.

Methods inherited from class Object

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

Method Details

setActions

public void setActions(EventActions actions)

builder

public static ToolContext.Builder builder(InvocationContext invocationContext)

toBuilder

public ToolContext.Builder toBuilder()

toString

public String toString()

Overrides:

toString in class Object