Class InMemoryRunner

A Runner pre-configured with in-memory services.

Suitable for local development, testing, and prototyping. All session, artifact, and memory data is stored in-process and is not persisted between runs.

Example:

const runner = new InMemoryRunner({agent: myAgent});

for await (const event of runner.runEphemeral({
  userId: 'user1',
  newMessage: {parts: [{text: 'Hello'}]},
})) {
  console.log(event);
}

Hierarchy (View Summary)

Runner
- InMemoryRunner

Constructors

constructor

new InMemoryRunner(
    params: {
        agent?: RunnableRoot;
        app?: App;
        appName?: string;
        plugins?: BasePlugin[];
        resumabilityConfig?: ResumabilityConfig;
    },
): InMemoryRunner
Creates a new InMemoryRunner instance.
Parameters
- params: {
      agent?: RunnableRoot;
      app?: App;
      appName?: string;
      plugins?: BasePlugin[];
      resumabilityConfig?: ResumabilityConfig;
  }
  The configuration for the runner.
  - Optionalagent?: RunnableRoot
    The root agent to run.
  - Optionalapp?: App
    An optional application instance to run.
  - OptionalappName?: string
    The application name. Defaults to 'InMemoryRunner'.
  - Optionalplugins?: BasePlugin[]
    An optional list of plugins.
  - OptionalresumabilityConfig?: ResumabilityConfig
    An optional resumability configuration.
Returns InMemoryRunner
Overrides Runner.constructor
- Defined in core/src/runner/in_memory_runner.ts:47

Properties

`Readonly`[RUNNER_SIGNATURE_SYMBOL]

"[RUNNER_SIGNATURE_SYMBOL]": true

`Readonly`agent

agent: RunnableRoot

The root being run: an agent, or a bare node (a Workflow) that the runner drives directly.

`Readonly`appName

appName: string

`Readonly`pluginManager

pluginManager: PluginManager

`Optional` `Readonly`resumabilityConfig

resumabilityConfig?: ResumabilityConfig

`Readonly`sessionService

sessionService: BaseSessionService

Methods

runAsync

runAsync(
    params: {
        abortSignal?: AbortSignal;
        customMetadata?: Record<string, unknown>;
        newMessage: Content;
        runConfig?: RunConfig;
        sessionId: string;
        stateDelta?: Record<string, unknown>;
        userId: string;
    },
): AsyncGenerator<Event, void, undefined>
Runs the agent with the given message, and returns an async generator of events.
Parameters
- params: {
      abortSignal?: AbortSignal;
      customMetadata?: Record<string, unknown>;
      newMessage: Content;
      runConfig?: RunConfig;
      sessionId: string;
      stateDelta?: Record<string, unknown>;
      userId: string;
  }
  - OptionalabortSignal?: AbortSignal
  - OptionalcustomMetadata?: Record<string, unknown>
  - newMessage: Content
    A new message to append to the session.
  - OptionalrunConfig?: RunConfig
    The run config for the agent.
  - sessionId: string
    The session ID of the session.
  - OptionalstateDelta?: Record<string, unknown>
    An optional state delta to apply to the session.
  - userId: string
    The user ID of the session.
Returns AsyncGenerator<Event, void, undefined>
Yields
The events generated by the agent.
Inherited from Runner.runAsync
- Defined in core/src/runner/runner.ts:255

runEphemeral

runEphemeral(
    params: {
        customMetadata?: Record<string, unknown>;
        newMessage: Content;
        runConfig?: RunConfig;
        stateDelta?: Record<string, unknown>;
        userId: string;
    },
): AsyncGenerator<Event, void, undefined>
Runs the agent with a new, ephemeral session.
Parameters
- params: {
      customMetadata?: Record<string, unknown>;
      newMessage: Content;
      runConfig?: RunConfig;
      stateDelta?: Record<string, unknown>;
      userId: string;
  }
  - OptionalcustomMetadata?: Record<string, unknown>
  - newMessage: Content
    A new message to append to the session.
  - OptionalrunConfig?: RunConfig
    The run config for the agent.
  - OptionalstateDelta?: Record<string, unknown>
    An optional state delta to apply to the session.
  - userId: string
    The user ID of the session.
Returns AsyncGenerator<Event, void, undefined>
Yields
The Events generated by the agent.
Inherited from Runner.runEphemeral
- Defined in core/src/runner/runner.ts:212

runLive

runLive(
    params: {
        abortSignal?: AbortSignal;
        liveRequestQueue: LiveRequestQueue;
        liveSessionResumptionHandle?: string;
        runConfig?: RunConfig;
        sessionId: string;
        userId: string;
    },
): AsyncGenerator<Event, void, undefined>
Runs the agent in the live (bidirectional streaming) mode.

Model media events that carry raw inline bytes (audio, video, or image) are yielded but not appended to the session to avoid persisting large blobs; events with fileData references and most other live events (transcriptions, tool calls, usage) are persisted as in runAsync.

This feature is experimental and its API may change.
Parameters
- params: {
      abortSignal?: AbortSignal;
      liveRequestQueue: LiveRequestQueue;
      liveSessionResumptionHandle?: string;
      runConfig?: RunConfig;
      sessionId: string;
      userId: string;
  }
  - OptionalabortSignal?: AbortSignal
    Optional signal to abort the live run.
  - liveRequestQueue: LiveRequestQueue
    The queue used to feed the live model.
  - OptionalliveSessionResumptionHandle?: string
    Optional session resumption handle observed from a prior runLive cycle on the same conversation. When set, the agent's live flow opens the connection with liveConnectConfig.sessionResumption.handle so the server restores its state instead of relying on client-side history replay.
  - OptionalrunConfig?: RunConfig
    The run config for the agent.
  - sessionId: string
    The session ID of the session.
  - userId: string
    The user ID of the session.
Returns AsyncGenerator<Event, void, undefined>
Yields
The events generated by the agent.
Inherited from Runner.runLive
- Defined in core/src/runner/runner.ts:649

Class InMemoryRunner

Hierarchy (View Summary)

Constructors

constructor

Parameters

Optionalagent?: RunnableRoot

Optionalapp?: App

OptionalappName?: string

Optionalplugins?: BasePlugin[]

OptionalresumabilityConfig?: ResumabilityConfig

Returns InMemoryRunner

Properties

Readonly[RUNNER_SIGNATURE_SYMBOL]

Readonlyagent

ReadonlyappName

Optional ReadonlyartifactService

Optional ReadonlycredentialService

Optional ReadonlymemoryService

ReadonlypluginManager

Optional ReadonlyresumabilityConfig

ReadonlysessionService

Methods

runAsync

Parameters

OptionalabortSignal?: AbortSignal

OptionalcustomMetadata?: Record<string, unknown>

newMessage: Content

OptionalrunConfig?: RunConfig

sessionId: string

OptionalstateDelta?: Record<string, unknown>

userId: string

Returns AsyncGenerator<Event, void, undefined>

Yields

runEphemeral

Parameters

OptionalcustomMetadata?: Record<string, unknown>

newMessage: Content

OptionalrunConfig?: RunConfig

OptionalstateDelta?: Record<string, unknown>

userId: string

Returns AsyncGenerator<Event, void, undefined>

Yields

runLive

Parameters

OptionalabortSignal?: AbortSignal

liveRequestQueue: LiveRequestQueue

OptionalliveSessionResumptionHandle?: string

OptionalrunConfig?: RunConfig

sessionId: string

userId: string

Returns AsyncGenerator<Event, void, undefined>

Yields

`Optional`agent?: RunnableRoot

`Optional`app?: App

`Optional`appName?: string

`Optional`plugins?: BasePlugin[]

`Optional`resumabilityConfig?: ResumabilityConfig

`Readonly`[RUNNER_SIGNATURE_SYMBOL]

`Readonly`agent

`Readonly`appName

`Optional` `Readonly`artifactService

`Optional` `Readonly`credentialService

`Optional` `Readonly`memoryService

`Readonly`pluginManager

`Optional` `Readonly`resumabilityConfig

`Readonly`sessionService

`Optional`abortSignal?: AbortSignal

`Optional`customMetadata?: Record<string, unknown>

`Optional`runConfig?: RunConfig

`Optional`stateDelta?: Record<string, unknown>

`Optional`customMetadata?: Record<string, unknown>

`Optional`runConfig?: RunConfig

`Optional`stateDelta?: Record<string, unknown>

`Optional`abortSignal?: AbortSignal

`Optional`liveSessionResumptionHandle?: string

`Optional`runConfig?: RunConfig