Class CombinedMemory

Class that manages and manipulates previous chat messages. It extends from the BaseChatMemory class and implements the CombinedMemoryInput interface.

Hierarchy

BaseChatMemory
- CombinedMemory

Implements

CombinedMemoryInput

Index

Constructors

Properties

aiPrefix chatHistory humanPrefix memories memoryKey returnMessages inputKey? outputKey?

Accessors

Methods

checkInputKey checkRepeatedMemoryVariable clear loadMemoryVariables saveContext

Constructors

constructor

new CombinedMemory(fields?): CombinedMemory
Parameters
- Optional fields: CombinedMemoryInput
Returns CombinedMemory
Overrides BaseChatMemory.constructor
- Defined in langchain/src/memory/combined_memory.ts:38

Properties

aiPrefix

aiPrefix: string = "AI"

chatHistory

chatHistory: BaseChatMessageHistory

humanPrefix

humanPrefix: string = "Human"

memories

memories: BaseMemory[] = []

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/combined_memory.ts:134

Methods

checkInputKey

checkInputKey(): void
Checks if input keys are set for all memory objects. Logs a warning if any are missing.

Returns void
- Defined in langchain/src/memory/combined_memory.ts:77

checkRepeatedMemoryVariable

checkRepeatedMemoryVariable(): void
Checks for repeated memory variables across all memory objects. Throws an error if any are found.

Returns void
- Defined in langchain/src/memory/combined_memory.ts:58

clear

clear(): Promise<void>
Clears all memory objects.

Returns Promise<void>
Promise that resolves when all memory objects have been cleared.
Overrides BaseChatMemory.clear
- Defined in langchain/src/memory/combined_memory.ts:126

loadMemoryVariables

loadMemoryVariables(inputValues): Promise<MemoryVariables>
Loads memory variables from all memory objects.
Parameters
- inputValues: InputValues
  
  Input values to load memory variables from.
Returns Promise<MemoryVariables>
Promise that resolves with an object containing the loaded memory variables.
Overrides BaseChatMemory.loadMemoryVariables
- Defined in langchain/src/memory/combined_memory.ts:95

saveContext

saveContext(inputValues, outputValues): Promise<void>
Saves the context to all memory objects.
Parameters
- inputValues: InputValues
  
  Input values to save.
- outputValues: OutputValues
  
  Output values to save.
Returns Promise<void>
Promise that resolves when the context has been saved to all memory objects.
Overrides BaseChatMemory.saveContext
- Defined in langchain/src/memory/combined_memory.ts:116

Generated using TypeDoc