Class InMemoryRunner<T>

An in-memory Runner for testing and development.

Type Parameters

T extends BaseAgent = BaseAgent

Hierarchy (view full)

Runner<T>
- InMemoryRunner

Index

Constructors

Properties

appName agent artifactService? sessionService memoryService? pluginManager eventsCompactionConfig? contextCacheConfig? logger

Methods

run runAsync close rewind

Constructors

constructor

new InMemoryRunner<T>(agent, __namedParameters?): InMemoryRunner<T>
Type Parameters
- T extends BaseAgent = BaseAgent
Parameters
- agent: T
- __namedParameters: {
  appName?: string;
  plugins?: BasePlugin[];
  } = {}
  - OptionalappName?: string
  - Optionalplugins?: BasePlugin[]
Returns InMemoryRunner<T>
Overrides Runner.constructor
- Defined in packages/adk/src/runners.ts:780

Properties

appName

appName: string

The app name of the runner.

agent

agent: T

The root agent to run.

`Optional`artifactService

artifactService?: BaseArtifactService

The artifact service for the runner.

sessionService

sessionService: BaseSessionService

The session service for the runner.

`Optional`memoryService

memoryService?: MemoryService

The memory service for the runner.

pluginManager

pluginManager: PluginManager

The plugin manager for the runner.

`Optional`eventsCompactionConfig

eventsCompactionConfig?: EventsCompactionConfig

Configuration for event compaction.

`Optional`contextCacheConfig

contextCacheConfig?: ContextCacheConfig

The context cache config for the runner.

`Protected`logger

logger: Logger = ...

Methods

run

run(__namedParameters): Generator<Event, void, unknown>
Runs the agent synchronously. NOTE: This sync interface is only for local testing and convenience purpose. Consider using runAsync for production usage.
Parameters
- __namedParameters: {
      userId: string;
      sessionId: string;
      newMessage: Content;
      runConfig?: RunConfig;
  }
  - userId: string
  - sessionId: string
  - newMessage: Content
  - OptionalrunConfig?: RunConfig
Returns Generator<Event, void, unknown>
Inherited from Runner.run
- Defined in packages/adk/src/runners.ts:161

runAsync

runAsync(__namedParameters): AsyncGenerator<Event, void, unknown>
Main entry method to run the agent in this runner.
Parameters
- __namedParameters: {
      userId: string;
      sessionId: string;
      newMessage: Content;
      runConfig?: RunConfig;
  }
  - userId: string
  - sessionId: string
  - newMessage: Content
  - OptionalrunConfig?: RunConfig
Returns AsyncGenerator<Event, void, unknown>
Inherited from Runner.runAsync
- Defined in packages/adk/src/runners.ts:220

close

close(): Promise<void>
Closes the runner and its plugin manager.

Returns Promise<void>
Inherited from Runner.close
- Defined in packages/adk/src/runners.ts:598

rewind

rewind(args): Promise<void>
Parameters
- args: {
      userId: string;
      sessionId: string;
      rewindBeforeInvocationId: string;
  }
  - userId: string
  - sessionId: string
  - rewindBeforeInvocationId: string
Returns Promise<void>
Inherited from Runner.rewind
- Defined in packages/adk/src/runners.ts:602