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 (view full)

BaseChatMemory
- ConversationTokenBufferMemory

Implements

ConversationTokenBufferMemoryInput

Index

Constructors

constructor

new ConversationTokenBufferMemory(fields): ConversationTokenBufferMemory
Parameters
- fields: ConversationTokenBufferMemoryInput
Returns ConversationTokenBufferMemory
Overrides BaseChatMemory.constructor
- Defined in langchain/src/memory/buffer_token_memory.ts:67

Properties

aiPrefix

aiPrefix: string = "AI"

chatHistory

chatHistory: BaseChatMessageHistory

humanPrefix

humanPrefix: string = "Human"

`Optional`inputKey

inputKey?: string

llm

llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

maxTokenLimit

maxTokenLimit: number = 2000

memoryKey

memoryKey: string = "history"

`Optional`outputKey

outputKey?: string

returnMessages

returnMessages: boolean = false

Accessors

memoryKeys

get memoryKeys(): string[]
Returns string[]
Overrides BaseChatMemory.memoryKeys
- Defined in langchain/src/memory/buffer_token_memory.ts:76

Methods

clear

clear(): Promise<void>
Method to clear the chat history.

Returns Promise<void>
Promise that resolves when the chat history has been cleared.
Inherited from BaseChatMemory.clear
- Defined in langchain/src/memory/chat_memory.ts:67

loadMemoryVariables

loadMemoryVariables(_values): Promise<MemoryVariables>
Loads the memory variables. It takes an InputValues object as a parameter and returns a Promise that resolves with a MemoryVariables object.
Parameters
- _values: InputValues
  InputValues object.
Returns Promise<MemoryVariables>
A Promise that resolves with a MemoryVariables object.
Overrides BaseChatMemory.loadMemoryVariables
- Defined in langchain/src/memory/buffer_token_memory.ts:87

saveContext

saveContext(inputValues, outputValues): Promise<void>
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
- inputValues: InputValues
- outputValues: OutputValues
Returns Promise<void>
Overrides BaseChatMemory.saveContext
- Defined in langchain/src/memory/buffer_token_memory.ts:110

Class ConversationTokenBufferMemory

Example

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConversationTokenBufferMemory

Properties

aiPrefix

chatHistory

humanPrefix

`Optional`inputKey

llm

maxTokenLimit

memoryKey

`Optional`outputKey

returnMessages

Accessors

memoryKeys

Returns string[]

Methods

clear

Returns Promise<void>

loadMemoryVariables

Parameters

Returns Promise<MemoryVariables>

saveContext

Parameters

Returns Promise<void>

Settings

On This Page

Class ConversationTokenBufferMemory

Example

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConversationTokenBufferMemory

Properties

aiPrefix

chatHistory

humanPrefix

OptionalinputKey

llm

maxTokenLimit

memoryKey

OptionaloutputKey

returnMessages

Accessors

memoryKeys

Returns string[]

Methods

clear

Returns Promise<void>

loadMemoryVariables

Parameters

Returns Promise<MemoryVariables>

saveContext

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`inputKey

`Optional`outputKey