Class BaseAgent

java.lang.Object

com.google.adk.agents.BaseAgent

Direct Known Subclasses:

LlmAgent, LoopAgent, ParallelAgent, SequentialAgent

public abstract class BaseAgent
extends Object

Base class for all agents.

Constructor Summary

Constructors

Constructor	Description
BaseAgent(String name, String description, List<? extends BaseAgent> subAgents, Callbacks.BeforeAgentCallback beforeAgentCallback, Callbacks.AfterAgentCallback afterAgentCallback)

Method Summary

Modifier and Type	Method	Description
Optional<Callbacks.AfterAgentCallback>	afterAgentCallback()
Optional<Callbacks.BeforeAgentCallback>	beforeAgentCallback()
final String	description()	Gets the one-line description of the agent's capability.
BaseAgent	findAgent(String name)	Finds an agent (this or descendant) by name.
@Nullable BaseAgent	findSubAgent(String name)	Recursively search sub agent by name.
final String	name()	Gets the agent's unique name.
BaseAgent	parentAgent()	Retrieves the parent agent in the agent tree.
protected void	parentAgent(BaseAgent parentAgent)	Sets the parent agent.
BaseAgent	rootAgent()	Returns the root agent for this agent by traversing up the parent chain.
io.reactivex.rxjava3.core.Flowable<Event>	runAsync(InvocationContext parentContext)
protected abstract io.reactivex.rxjava3.core.Flowable<Event>	runAsyncImpl(InvocationContext invocationContext)
io.reactivex.rxjava3.core.Flowable<Event>	runLive(InvocationContext parentContext)
protected abstract io.reactivex.rxjava3.core.Flowable<Event>	runLiveImpl(InvocationContext invocationContext)
List<? extends BaseAgent>	subAgents()

Methods inherited from class java.lang.Object

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

Constructor Details

BaseAgent

public BaseAgent(String name,
 String description,
 List<? extends BaseAgent> subAgents,
 Callbacks.BeforeAgentCallback beforeAgentCallback,
 Callbacks.AfterAgentCallback afterAgentCallback)

Method Details

name

public final String name()

Gets the agent's unique name.

Returns:

the unique name of the agent.

description

public final String description()

Gets the one-line description of the agent's capability.

Returns:

the description of the agent.

parentAgent

public BaseAgent parentAgent()

Retrieves the parent agent in the agent tree.

Returns:

the parent agent, or null if this agent does not have a parent.

parentAgent

protected void parentAgent(BaseAgent parentAgent)

Sets the parent agent.

Parameters:

parentAgent - The parent agent to set.

rootAgent

public BaseAgent rootAgent()

Returns the root agent for this agent by traversing up the parent chain.

Returns:

the root agent.

findAgent

public BaseAgent findAgent(String name)

Finds an agent (this or descendant) by name.

Returns:

the agent or descendant with the given name, or null if not found.

findSubAgent

public @Nullable BaseAgent findSubAgent(String name)

Recursively search sub agent by name.

subAgents

public List<? extends BaseAgent> subAgents()

beforeAgentCallback

public Optional<Callbacks.BeforeAgentCallback> beforeAgentCallback()

afterAgentCallback

public Optional<Callbacks.AfterAgentCallback> afterAgentCallback()

runAsync

public io.reactivex.rxjava3.core.Flowable<Event> runAsync(InvocationContext parentContext)

runLive

public io.reactivex.rxjava3.core.Flowable<Event> runLive(InvocationContext parentContext)

runAsyncImpl

protected abstract io.reactivex.rxjava3.core.Flowable<Event> runAsyncImpl(InvocationContext invocationContext)

runLiveImpl

protected abstract io.reactivex.rxjava3.core.Flowable<Event> runLiveImpl(InvocationContext invocationContext)