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

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:68

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

`Optional` inputKey

inputKey?: string

`Optional` outputKey

outputKey?: string

Accessors

memoryKeys

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

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 libs/langchain-community/dist/memory/chat_memory.d.ts:35

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:88

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:111

Class ConversationTokenBufferMemory

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: ConversationTokenBufferMemoryInput

Returns ConversationTokenBufferMemory

Properties

aiPrefix

chatHistory

humanPrefix

llm

maxTokenLimit

memoryKey

returnMessages

Optional inputKey

Optional outputKey

Accessors

memoryKeys

Returns string[]

Methods

clear

Returns Promise<void>

loadMemoryVariables

Parameters

_values: InputValues

Returns Promise<MemoryVariables>

saveContext

Parameters

inputValues: InputValues

outputValues: OutputValues

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` inputKey

`Optional` outputKey