IFClite TypeScript API
    Preparing search index...

    Interface AgentRunOptions

    @ifc-lite/ids-agent — the IDS authoring agent (ADR-008).

    A tool-calling loop over the op vocabulary of @ifc-lite/ids-authoring. The agent works on a sandbox fork, changes it only through the grounding gate, and returns a proposal the user reviews. Provider adapters live in @ifc-lite/ids-agent/anthropic and @ifc-lite/ids-agent/openai; model doubles and recorded transcripts in @ifc-lite/ids-agent/testing. See docs/architecture/ids-studio/03-architecture/06-ai-agent.md.

    interface AgentRunOptions {
        askUser?: AskUserHandler;
        attachments?: readonly Attachment[];
        bsdd?: BsddClient;
        budget?: RootBudget;
        doc: StudioDocument;
        gate: GateContext;
        limits?: {
            maxResultChars?: number;
            requestTimeoutMs?: number;
            routeCeiling?: number;
            wallClockMs?: number;
        };
        lint: LintContext;
        mode: AgentMode;
        model?: string;
        modelBridge?: ModelBridge;
        onEvent?: (event: AgentEvent) => void;
        pricing?: ModelPricing;
        request: string;
        route?: string;
        runId?: string;
        signal?: AbortSignal;
        transport: ToolTurnTransport;
    }
    Index
    askUser? attachments? bsdd? budget? doc gate limits? lint mode model? modelBridge? onEvent? pricing? request route? runId? signal? transport
    askUser?: AskUserHandler

    Default: the first choice (headless, non-interactive).

    attachments?: readonly Attachment[]
    bsdd?: BsddClient
    budget?: RootBudget

    Default: the mode's root budget. Pass a restored budget to resume spending from it.

    doc: StudioDocument
    gate: GateContext
    limits?: {
        maxResultChars?: number;
        requestTimeoutMs?: number;
        routeCeiling?: number;
        wallClockMs?: number;
    }

    Type Declaration

    • OptionalmaxResultChars?: number

      Tool results longer than this are cut (with a note). Default 16k characters.

    • OptionalrequestTimeoutMs?: number

      Per-request deadline. Default 5 minutes.

    • OptionalrouteCeiling?: number

      The route's hard output ceiling. Default 64k.

    • OptionalwallClockMs?: number

      Whole-run cap. Default 10 minutes.

    lint: LintContext
    mode: AgentMode
    model?: string

    Default DEFAULT_AGENT_MODEL.

    modelBridge?: ModelBridge
    onEvent?: (event: AgentEvent) => void
    pricing?: ModelPricing
    request: string
    route?: string

    Recorded on receipts, e.g. anthropic, openai, replay.

    runId?: string
    signal?: AbortSignal
    transport: ToolTurnTransport

    Settings
    Member Visibility

    On This Page
    Properties