google-adk-kotlin-core/com.google.adk.kt.runners/AbstractRunner

AbstractRunner

An abstract base class for Runner implementations that provides common orchestration logic.

Inheritors

Constructors

constructor(appName: String, agent: BaseAgent, sessionService: SessionService, artifactService: ArtifactService?, memoryService: MemoryService?, pluginManager: PluginManager, resumabilityConfig: ResumabilityConfig = ResumabilityConfig())

Creates a runner from explicit fields, not using an App.

constructor(app: App, sessionService: SessionService, artifactService: ArtifactService?, memoryService: MemoryService?, skipClosingPlugins: Boolean = false)

Creates a runner from an App, deriving its App.appName, App.rootAgent, App.plugins, and App.resumabilityConfig.

Properties

agent

override val agent: BaseAgent

The agent this runner runs. For a node-rooted runner this is a NodeViewAgent over the running node.

appName

override val appName: String

artifactService

override val artifactService: ArtifactService?

memoryService

override val memoryService: MemoryService?

node

override val node: Node?

The node this runner runs, set when rooted on a node graph. The go-forward field; once agent is removed it holds the running unit for every runner.

pluginManager

override val pluginManager: PluginManager

resumabilityConfig

override val resumabilityConfig: ResumabilityConfig

sessionService

override val sessionService: SessionService

Functions

open override fun close()

Closes this runner, releasing the resources it owns.

rewindAsync

open suspend override fun rewindAsync(userId: String, sessionId: String, rewindBeforeInvocationId: String)

Rewinds the session as Runner.rewindAsync describes, then flushes sessionService so the rewind is persisted.

run

open override fun run(userId: String, sessionId: String, newMessage: Content, runConfig: RunConfig? = null): Iterator<Event>

Sync interface for local testing and convenience purpose.

runAsync

open override fun runAsync(userId: String, sessionId: String, invocationId: String? = null, newMessage: Content? = null, stateDelta: Map<String, Any>? = null, runConfig: RunConfig? = null): Flow<Event>

Main entry method to run the agent in this runner.

runLive

@ExperimentalLiveApi

open override fun runLive(userId: String, sessionId: String, liveRequestQueue: LiveRequestQueue, runConfig: RunConfig? = null): Flow<Event>

Runs the agent live as Runner.runLive describes. Flushes sessionService once per turn, when the turn completes or hands over to another agent or step, and when the run completes or fails; each flush is bounded, so a stuck session service fails the run instead of hanging it.