Class ConversationTokenBufferMemory

Class that represents a conversation chat memory with a token buffer. It extends the BaseChatMemory class and implements the ConversationTokenBufferMemoryInput interface.

Example

const memory = new ConversationTokenBufferMemory({
  llm: new ChatOpenAI({}),
  maxTokenLimit: 10,
});

// Save conversation context
await memory.saveContext({ input: "hi" }, { output: "whats up" });
await memory.saveContext({ input: "not much you" }, { output: "not much" });

// Load memory variables
const result = await memory.loadMemoryVariables({});
console.log(result);

Hierarchy

Implements

Constructors

constructor

Properties

aiPrefix chatHistory humanPrefix llm maxTokenLimit memoryKey returnMessages inputKey? outputKey?

Accessors

memoryKeys

Methods

clear loadMemoryVariables saveContext

Constructors

constructor

Properties

aiPrefix

aiPrefix: string = "AI"

chatHistory

chatHistory: BaseChatMessageHistory

humanPrefix

humanPrefix: string = "Human"

llm

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

maxTokenLimit

maxTokenLimit: number = 2000

memoryKey

memoryKey: string = "history"

returnMessages

returnMessages: boolean = false

Optional inputKey

inputKey?: string

Optional outputKey

outputKey?: string

Accessors

memoryKeys

  • get memoryKeys(): string[]

  • Returns string[]

Methods

clear

  • Method to clear the chat history.

    Returns Promise<void>

    Promise that resolves when the chat history has been cleared.

loadMemoryVariables

  • Loads the memory variables. It takes an InputValues object as a parameter and returns a Promise that resolves with a MemoryVariables object.

    Parameters

    Returns Promise<MemoryVariables>

    A Promise that resolves with a MemoryVariables object.

saveContext

  • Saves the context from this conversation to buffer. If the amount of tokens required to save the buffer exceeds MAX_TOKEN_LIMIT, prune it.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc