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

Runner

interface Runner : AutoCloseable

The Runner interface defines the contract for running agents.

Inheritors

Properties

abstract val agent: BaseAgent

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

abstract val appName: String

artifactService

abstract val artifactService: ArtifactService?

abstract val memoryService: MemoryService?

open 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.

abstract val pluginManager: PluginManager

resumabilityConfig

abstract val resumabilityConfig: ResumabilityConfig

abstract val sessionService: SessionService

Functions

abstract override fun close()

Releases resources held by this runner, such as its plugins and the toolsets its agents own.

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

Rewinds the session to before the specified invocation.

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

Sync interface for local testing and convenience purpose.

abstract 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 asynchronously.

@ExperimentalLiveApi

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

Runs the agent over a live (bidirectional streaming) connection and returns a cold Flow of the conversation's Events, delivering inline audio, video, and image data to the caller without storing it in the session. Closing the caller-owned liveRequestQueue ends the run, and RunConfig.maxLlmCalls does not apply to a live run. A Runner that does not override this fails with UnsupportedOperationException when the flow is collected.