Variable HistoryPersistInstanceConst

Type declaration

• • new (
        clientId: string,
        callbacks: Partial<IHistoryInstanceCallbacks>,
    ): {
        callbacks: Partial<IHistoryInstanceCallbacks>;
        clientId: string;
        dispose(agentName: string): Promise<void>;
        iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>;
        pop(agentName: string): Promise<IModelMessage<object>>;
        push(value: IModelMessage, agentName: string): Promise<void>;
        waitForInit(agentName: string): Promise<void>;
    }

  • Parameters

    • clientId: string
    • callbacks: Partial<IHistoryInstanceCallbacks>

    Returns {
        callbacks: Partial<IHistoryInstanceCallbacks>;
        clientId: string;
        dispose(agentName: string): Promise<void>;
        iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>;
        pop(agentName: string): Promise<IModelMessage<object>>;
        push(value: IModelMessage, agentName: string): Promise<void>;
        waitForInit(agentName: string): Promise<void>;
    }

    • Readonlycallbacks: Partial<IHistoryInstanceCallbacks>

    • ReadonlyclientId: string

    • dispose:function

      • dispose(agentName: string): Promise<void>

        Disposes of the history, clearing all data if agentName is null. Invokes onDispose callback if provided.

        Parameters

        • agentName: string

          The name of the agent, or null to clear all data.

        Returns Promise<void>

        A promise that resolves when disposal is complete.

    • iterate:function

      • iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>

        Iterates over history messages, applying filters and system prompts if configured. Invokes onRead callbacks during iteration if provided.

        Parameters

        • agentName: string

          The name of the agent.

        Returns AsyncIterableIterator<IModelMessage<object>>

        An async iterator yielding filtered messages.

    • pop:function

      • pop(agentName: string): Promise<IModelMessage<object>>

        Removes and returns the last message from the history, updating persistent storage. Invokes onPop and onChange callbacks if provided.

        Parameters

        • agentName: string

          The name of the agent.

        Returns Promise<IModelMessage<object>>

        The last message, or null if the history is empty.

    • push:function

      • push(value: IModelMessage, agentName: string): Promise<void>

        Adds a new message to the history, persisting it to storage. Invokes onPush and onChange callbacks if provided.

        Parameters

        • value: IModelMessage

          The message to add.
        • agentName: string

          The name of the agent.

        Returns Promise<void>

        A promise that resolves when the message is persisted.

    • waitForInit:function

      • waitForInit(agentName: string): Promise<void>

        Initializes the history for an agent, loading data from persistent storage if needed.

        Parameters

        • agentName: string

          The name of the agent.

        Returns Promise<void>

        A promise that resolves when initialization is complete.