Class EntityMemory

Class for managing entity extraction and summarization to memory in chatbot applications. Extends the BaseChatMemory class and implements the EntityMemoryInput interface.

Example

const memory = new EntityMemory({
  llm: new ChatOpenAI({ temperature: 0 }),
  chatHistoryKey: "history",
  entitiesKey: "entities",
});
const model = new ChatOpenAI({ temperature: 0.9 });
const chain = new LLMChain({
  llm: model,
  prompt: ENTITY_MEMORY_CONVERSATION_TEMPLATE,
  memory,
});

const res1 = await chain.call({ input: "Hi! I'm Jim." });
console.log({
  res1,
  memory: await memory.loadMemoryVariables({ input: "Who is Jim?" }),
});

const res2 = await chain.call({
  input: "I work in construction. What about you?",
});
console.log({
  res2,
  memory: await memory.loadMemoryVariables({ input: "Who is Jim?" }),
});

Hierarchy

Implements

  • EntityMemoryInput

Constructors

constructor

Properties

chatHistory chatHistoryKey entitiesKey entityCache entityStore k llm returnMessages aiPrefix? humanPrefix? inputKey? outputKey?

Accessors

memoryKeys memoryVariables

Methods

clear loadMemoryVariables saveContext

Constructors

constructor

Properties

chatHistory

chatHistory: BaseChatMessageHistory

chatHistoryKey

chatHistoryKey: string = "history"

entitiesKey

entitiesKey: string = "entities"

entityCache

entityCache: string[] = []

entityStore

entityStore: BaseEntityStore

k

k: number = 3

llm

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

returnMessages

returnMessages: boolean

Optional aiPrefix

aiPrefix?: string

Optional humanPrefix

humanPrefix?: string

Optional inputKey

inputKey?: string

Optional outputKey

outputKey?: string

Accessors

memoryKeys

  • get memoryKeys(): string[]

  • Returns string[]

memoryVariables

  • get memoryVariables(): string[]

  • Returns string[]

Methods

clear

  • Method to clear the memory contents.

    Returns Promise<void>

    Promise resolving to void.

loadMemoryVariables

  • Method to load memory variables and perform entity extraction.

    Parameters

    Returns Promise<MemoryVariables>

    Promise resolving to an object containing memory variables.

saveContext

  • Method to save the context from a conversation to a buffer and perform entity summarization.

    Parameters

    Returns Promise<void>

    Promise resolving to void.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc