google-adk-kotlin-core/com.google.adk.kt.agents/LoopAgent

LoopAgent

class LoopAgent(name: String, val maxIterations: Int? = null, description: String = "", subAgents: List<BaseAgent> = emptyList(), beforeAgentCallbacks: List<BeforeAgentCallback> = emptyList(), afterAgentCallbacks: List<AfterAgentCallback> = emptyList()) : BaseAgent

A shell agent that runs its sub-agents in a loop.

It stops when a sub-agent generates an event with escalate or maxIterations are reached.

Constructors

LoopAgent

constructor(name: String, maxIterations: Int? = null, description: String = "", subAgents: List<BaseAgent> = emptyList(), beforeAgentCallbacks: List<BeforeAgentCallback> = emptyList(), afterAgentCallbacks: List<AfterAgentCallback> = emptyList())

Types

Builder

class Builder

Fluent builder for LoopAgent, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

Companion

object Companion

Properties

afterAgentCallbacks

val afterAgentCallbacks: List<AfterAgentCallback>

List of callbacks to run after the agent executes.

beforeAgentCallbacks

val beforeAgentCallbacks: List<BeforeAgentCallback>

List of callbacks to run before the agent executes.

description

open val description: String

The description of the agent.

disallowTransferToParent

val disallowTransferToParent: Boolean

When true, the framework will not route the next user turn back to this agent after the parent transfers control to it; instead the next turn falls back to the root agent. Set this on utility sub-agents the parent calls and returns from (translators, summarizers, classifiers). Leave at the default false for sub-agents that should keep handling follow-up turns directly (e.g. billing, support).

disallowTransferToPeers

val disallowTransferToPeers: Boolean

When true, prevents this agent from transferring sideways to a peer agent under the same parent. Typically set together with disallowTransferToParent on one-shot utility agents. Violations are surfaced by the runner as IllegalArgumentException.

maxIterations

val maxIterations: Int?

The maximum number of iterations to run the loop. If null, runs indefinitely until escalate.

name

val name: String

The name of the agent. Must be non-empty, must not be the reserved value "user", and must be groups of letters and digits joined by single dots, spaces, underscores, or hyphens, optionally starting with an underscore. Construction throws IllegalArgumentException if name does not meet these requirements.

subAgents

val subAgents: List<BaseAgent>

List of sub-agents.

Functions

findAgent

fun BaseAgent.findAgent(targetName: String): BaseAgent?

Finds an agent with the given name in this agent's subtree (including itself).

runAsync

fun runAsync(parentContext: InvocationContext): ERROR CLASS: Symbol not found for Flow<com/google/adk/kt/events/Event>

Public entry point for executing the agent asynchronously (text-based).