Class GenerativeAgentMemory

Class that manages the memory of a generative agent in LangChain. It extends the BaseMemory class and has methods for adding a memory, formatting memories, getting memories until a token limit is reached, loading memory variables, saving the context of a model run to memory, and clearing memory contents.

Example

const createNewMemoryRetriever = async () => {
  const vectorStore = new MemoryVectorStore(new OpenAIEmbeddings());
  const retriever = new TimeWeightedVectorStoreRetriever({
    vectorStore,
    otherScoreKeys: ["importance"],
    k: 15,
  });
  return retriever;
};
const tommiesMemory = new GenerativeAgentMemory(
  llm,
  await createNewMemoryRetriever(),
  { reflectionThreshold: 8 },
);
const summary = await tommiesMemory.getSummary();

Hierarchy

  • BaseMemory
    • GenerativeAgentMemory

Constructors

constructor

Properties

addMemoryKey llm memoryChain memoryRetriever mostRecentMemoriesKey mostRecentMemoriesTokenKey nowKey queriesKey relevantMemoriesKey relevantMemoriesSimpleKey verbose reflectionThreshold?

Accessors

memoryKeys memoryVariables

Methods

addMemory clear formatMemoriesDetail formatMemoriesSimple getAddMemoryKey getCurrentTimeKey getMemoriesUntilLimit getMostRecentMemoriesTokenKey getRelevantMemoriesKey loadMemoryVariables saveContext

Constructors

constructor

Properties

addMemoryKey

addMemoryKey: string = "addMemory"

llm

llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

memoryChain

memoryChain: GenerativeAgentMemoryChain

memoryRetriever

memoryRetriever: TimeWeightedVectorStoreRetriever

mostRecentMemoriesKey

mostRecentMemoriesKey: string = "most_recent_memories"

mostRecentMemoriesTokenKey

mostRecentMemoriesTokenKey: string = "recent_memories_token"

nowKey

nowKey: string = "now"

queriesKey

queriesKey: string = "queries"

relevantMemoriesKey

relevantMemoriesKey: string = "relevant_memories"

relevantMemoriesSimpleKey

relevantMemoriesSimpleKey: string = "relevant_memories_simple"

verbose

verbose: boolean

Optional reflectionThreshold

reflectionThreshold?: number

Accessors

memoryKeys

memoryVariables

Methods

addMemory

  • addMemory(memoryContent, now?, metadata?, callbacks?): Promise<ChainValues>

  • Method that adds a memory to the agent's memory.

    Parameters

    • memoryContent: string

      The content of the memory to add.

    • Optional now: Date

      The current date.

    • Optional metadata: Record<string, unknown>

      The metadata for the memory.

    • Optional callbacks: CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

      The Callbacks to use for adding the memory.

    Returns Promise<ChainValues>

    The result of the memory addition.

clear

formatMemoriesDetail

formatMemoriesSimple

getAddMemoryKey

getCurrentTimeKey

getMemoriesUntilLimit

getMostRecentMemoriesTokenKey

getRelevantMemoriesKey

loadMemoryVariables

  • loadMemoryVariables(inputs): Promise<Record<string, string>>

  • Method that loads memory variables based on the given inputs.

    Parameters

    • inputs: InputValues

      The inputs to use for loading memory variables.

    Returns Promise<Record<string, string>>

    An object containing the loaded memory variables.

saveContext

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc