Checkpoints - Agentium

Import these 2 exports from @agentium/core. Read the checkpoints guide for setup and behavior, or return to the package reference. A ? marks an optional field. These are declarations for lookup; run the examples in the linked guide. Follow related-type links for Agentium types and source links for imported dependency types.

Checkpoint

export interface Checkpoint {
    id: string;
    runId: string;
    roundtrip: number;
    messages: ChatMessage[];
    tokenUsage: TokenUsage;
    sessionState: Record<string, unknown>;
    timestamp: Date;
}

Related: ChatMessage, TokenUsage.

CheckpointManager

export declare class CheckpointManager {
    constructor(storage?: StorageDriver);
    save(checkpoint: Omit<Checkpoint, "id" | "timestamp">): Promise<string>;
    load(checkpointId: string): Promise<Checkpoint | null>;
    list(runId: string): Promise<Checkpoint[]>;
    rollback(checkpointId: string): Promise<Checkpoint | null>;
    prune(maxAgeMs: number): Promise<number>;
    /**
     * Create an onRoundtripComplete hook for auto-checkpointing.
     */
    toOnRoundtripCompleteHook(runId: string, getMessages: () => ChatMessage[], getSessionState: () => Record<string, unknown>): (roundtrip: number, tokensSoFar: TokenUsage) => Promise<{
        stop?: boolean;
    } | void>;
}

Related: ChatMessage, Checkpoint, StorageDriver, TokenUsage.