ADK for TypeScript: API Reference
    Preparing search index...

    Interface RunnerConfig

    The configuration parameters for the Runner.

    interface RunnerConfig {
        agent?: RunnableNode;
        app?: App;
        appName?: string;
        artifactService?: BaseArtifactService | SessionArtifactService;
        autoCreateSession?: boolean;
        credentialService?: BaseCredentialService;
        memoryService?: BaseMemoryService;
        plugins?: BasePlugin[];
        resumabilityConfig?: ResumabilityConfig;
        sessionService: BaseSessionService;
    }
    agent?: RunnableNode

    The agent or workflow to run. Required if app is not provided.

    A bare node — a Workflow, most usefully — is accepted as the root and driven directly, so a graph does not have to be wrapped by hand to be run. The accepted set is the one an edge takes: any other node-like value becomes the single node of a one-node workflow.

    app?: App

    The application object. If provided, appName, agent, and plugins will default from this app.

    appName?: string

    The application name. Required if app is not provided.

    artifactService?: BaseArtifactService | SessionArtifactService

    An optional service for storing and retrieving artifacts.

    autoCreateSession?: boolean

    Whether to create the session when runAsync is given a session id that does not exist. Defaults to false, which reports the missing session as an error instead.

    Enabling this trades a loud failure for a silent one: a caller that mistypes a session id gets a new empty conversation rather than an error. Turn it on only where the session id is a key the caller owns and a first use is expected to create it.

    credentialService?: BaseCredentialService

    An optional service for managing authentication credentials.

    memoryService?: BaseMemoryService

    An optional service for storing and querying agent memory.

    plugins?: BasePlugin[]

    An optional list of plugins to apply globally across all agents.

    resumabilityConfig?: ResumabilityConfig

    An optional resumability configuration applied to the runner.

    sessionService: BaseSessionService

    The service for managing sessions.

    Properties