Class Runner<T>

constructor

• new Runner<T>(__namedParameters): Runner<T>

• Initializes the Runner.

  Type Parameters

  • T extends BaseAgent = BaseAgent

  Parameters

  • __namedParameters: {
        appName: string;
        agent: T;
        artifactService?: BaseArtifactService;
        sessionService: BaseSessionService;
        memoryService?: MemoryService;
        eventsCompactionConfig?: EventsCompactionConfig;
        contextCacheConfig?: ContextCacheConfig;
        plugins?: BasePlugin[];
        pluginCloseTimeout?: number;
    }

    • appName: string

    • agent: T

    • OptionalartifactService?: BaseArtifactService

    • sessionService: BaseSessionService

    • OptionalmemoryService?: MemoryService

    • OptionaleventsCompactionConfig?: EventsCompactionConfig

    • OptionalcontextCacheConfig?: ContextCacheConfig

    • Optionalplugins?: BasePlugin[]

    • OptionalpluginCloseTimeout?: number

  Returns Runner<T>

appName

agent

OptionalartifactService

sessionService

OptionalmemoryService

pluginManager

OptionaleventsCompactionConfig

OptionalcontextCacheConfig

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>

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>

close

• close(): Promise<void>

• Closes the runner and its plugin manager.

  Returns Promise<void>

rewind

• rewind(args): Promise<void>

• Parameters

  • args: {
        userId: string;
        sessionId: string;
        rewindBeforeInvocationId: string;
    }

    • userId: string

    • sessionId: string

    • rewindBeforeInvocationId: string

  Returns Promise<void>