Interface IHistoryAdapter

Interface defining methods for interacting with a history adapter.

interface IHistoryAdapter {
    dispose: (clientId: string, agentName: string) => Promise<void>;
    pop: (
        clientId: string,
        agentName: string,
    ) => Promise<IModelMessage<object>>;
    push: (
        value: IModelMessage,
        clientId: string,
        agentName: string,
    ) => Promise<void>;
    iterate(
        clientId: string,
        agentName: string,
    ): AsyncIterableIterator<IModelMessage<object>>;
}

Properties

dispose pop push

Methods

iterate

Properties

dispose

dispose: (clientId: string, agentName: string) => Promise<void>

Disposes of the history for a client and agent, optionally clearing all data.

Type declaration

    • (clientId: string, agentName: string): Promise<void>

    • Parameters

      • clientId: string

        The client ID.

      • agentName: string

        The name of the agent, or null to dispose fully.

      Returns Promise<void>

      A promise that resolves when disposal is complete.

pop

pop: (clientId: string, agentName: string) => Promise<IModelMessage<object>>

Removes and returns the last message from the history.

Type declaration

    • (clientId: string, agentName: string): Promise<IModelMessage<object>>

    • Parameters

      • clientId: string

        The client ID.

      • agentName: string

        The name of the agent.

      Returns Promise<IModelMessage<object>>

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

push

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

Adds a new message to the history.

Type declaration

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

    • Parameters

      • value: IModelMessage

        The message to add.

      • clientId: string

        The client ID.

      • agentName: string

        The name of the agent.

      Returns Promise<void>

      A promise that resolves when the message is added.

Methods

iterate

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

    Iterates over history messages for a client and agent.

    Parameters

    • clientId: string

      The client ID.

    • agentName: string

      The name of the agent.

    Returns AsyncIterableIterator<IModelMessage<object>>

    An async iterator yielding history messages.

Settings

Member Visibility

On This Page

Properties
Methods