Polyman Documentation - v3.1.0
    Preparing search index...

    Interface ChatRuntimeOptions

    What createChatRuntime needs.

    interface ChatRuntimeOptions {
        dir?: string;
        provider: Provider;
        model: string;
        providerId?: string;
        capabilities?: Capabilities;
        budgets?: ChatBudgets;
        secrets?: string[];
        runner?: CliRunner;
        createScheduler?: (problemDir: string, runner: CliRunner) => WorkflowRunner;
        createIdeas?: () => IdeasRunner;
        cwd?: string;
        polygonCredentials?: () => PolygonCredentials | null;
    }
    Index
    dir?: string

    The folder the user gave, like ./pairs-sum.

    provider: Provider
    model: string
    providerId?: string

    The preset id of the provider, for the capability table. Defaults to provider.id.

    capabilities?: Capabilities

    What the models can do, with the live info and the ai.json overrides. A model without tools runs in chat-only mode. Defaults to an empty table, which still turns tools off after tools_not_supported.

    budgets?: ChatBudgets

    Budgets of the chat, from budgetsFor(). Defaults to DEFAULT_BUDGETS.

    secrets?: string[]

    Keys to redact from errors.

    runner?: CliRunner

    Runs polyman commands. Defaults to NodeCliRunner.

    createScheduler?: (problemDir: string, runner: CliRunner) => WorkflowRunner

    Builds the workflow scheduler. Defaults to a model manager and model workers.

    Type Declaration

    createIdeas?: () => IdeasRunner

    Builds the idea workflow. Defaults to the chat model.

    cwd?: string

    Base folder for a relative dir. Defaults to process.cwd().

    polygonCredentials?: () => PolygonCredentials | null

    The registered Polygon credentials, or null. Defaults to reading ~/.polyman. Read on each use, so a remote register run in another terminal works without a restart.