Interface IHistoryAdapter

Interface defining methods for interacting with a history adapter.

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

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.

pop

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

Removes and returns the last message from the history.

push

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

Adds a new message to the history.

Methods

iterate

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

    Iterates over history messages for a client and agent.

    Parameters

    • clientId: string
    • agentName: string

    Returns AsyncIterableIterator<IModelMessage<object>>

Settings

Member Visibility

On This Page

Properties
Methods