intellibrix v1.0.0
    Preparing search index...

    Type Alias LoopOptions

    type LoopOptions = {
        abortSignal?: AbortSignal;
        brick?: unknown;
        brickName?: string;
        checkpointer?: Checkpointer;
        maxSteps?: number;
        messages: Message[];
        model: string;
        onEvent?: (event: LoopEvent) => void;
        onRunEvent?: RunEventHandler;
        onToolApproval?: ApprovalHook;
        provider: Provider;
        resume?: boolean;
        runId?: string;
        stopWhen?: (result: StepResult) => boolean | Promise<boolean>;
        system?: string;
        tools?: ToolDefinition[];
    }
    Index
    abortSignal? brick? brickName? checkpointer? maxSteps? messages model onEvent? onRunEvent? onToolApproval? provider resume? runId? stopWhen? system? tools?
    abortSignal?: AbortSignal
    brick?: unknown
    brickName?: string

    Annotates run:start/run:finish RunEvents, e.g. with the owning Brick's name.

    checkpointer?: Checkpointer
    maxSteps?: number
    messages: Message[]
    model: string
    onEvent?: (event: LoopEvent) => void
    onRunEvent?: RunEventHandler

    Structural observability events, layered onto onEvent's LoopEvents.

    onToolApproval?: ApprovalHook
    provider: Provider
    resume?: boolean

    When true, resumes from the checkpointer's saved state for runId instead of starting fresh.

    runId?: string
    stopWhen?: (result: StepResult) => boolean | Promise<boolean>

    Called once per step; return true to stop the loop after this step.

    system?: string
    tools?: ToolDefinition[]

    Settings
    Member Visibility

    On This Page
    Properties