Interface IHistoryInstance

Interface defining methods for a history instance implementation.

interface IHistoryInstance {
    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, init: boolean): Promise<void>;
}

Index

Methods

dispose iterate pop push waitForInit

Methods

dispose

dispose(agentName: string): Promise<void>
Disposes of the history for an agent, optionally clearing all data.
Parameters
- agentName: string
Returns Promise<void>
- Defined in types.d.ts:2308

iterate

iterate(agentName: string): AsyncIterableIterator<IModelMessage<object>>
Iterates over history messages for an agent.
Parameters
- agentName: string
Returns AsyncIterableIterator<IModelMessage<object>>
- Defined in types.d.ts:2292

pop

pop(agentName: string): Promise<IModelMessage<object>>
Removes and returns the last message from the history for an agent.
Parameters
- agentName: string
Returns Promise<IModelMessage<object>>
- Defined in types.d.ts:2304

push

push(value: IModelMessage, agentName: string): Promise<void>
Adds a new message to the history for an agent.
Parameters
- value: IModelMessage
- agentName: string
Returns Promise<void>
- Defined in types.d.ts:2300

waitForInit

waitForInit(agentName: string, init: boolean): Promise<void>
Initializes the history for an agent, loading initial data if needed.
Parameters
- agentName: string
- init: boolean
Returns Promise<void>
- Defined in types.d.ts:2296