Class GenerativeAgentMemory

constructor

• new GenerativeAgentMemory(llm, memoryRetriever, config?): GenerativeAgentMemory

• Parameters

  • llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

  • memoryRetriever: TimeWeightedVectorStoreRetriever

  • Optional config: GenerativeAgentMemoryConfig

  Returns GenerativeAgentMemory

addMemoryKey

llm

memoryChain

memoryRetriever

mostRecentMemoriesKey

mostRecentMemoriesTokenKey

nowKey

queriesKey

relevantMemoriesKey

relevantMemoriesSimpleKey

verbose

Optional reflectionThreshold

memoryKeys

• get memoryKeys(): string[]

• Returns string[]

memoryVariables

• get memoryVariables(): string[]

• Returns string[]

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

    The Callbacks to use for adding the memory.

  Returns Promise<ChainValues>

  The result of the memory addition.

clear

• clear(): void

• Method that clears the memory contents.

  Returns void

  Nothing.

formatMemoriesDetail

• formatMemoriesDetail(relevantMemories): string

• Method that formats the given relevant memories in detail.

  Parameters

  • relevantMemories: Document<Record<string, any>>[]

    The relevant memories to format.

  Returns string

  The formatted memories as a string.

formatMemoriesSimple

• formatMemoriesSimple(relevantMemories): string

• Method that formats the given relevant memories in a simple manner.

  Parameters

  • relevantMemories: Document<Record<string, any>>[]

    The relevant memories to format.

  Returns string

  The formatted memories as a string.

getAddMemoryKey

• getAddMemoryKey(): string

• Method that returns the key for adding a memory.

  Returns string

  The key for adding a memory as a string.

getCurrentTimeKey

• getCurrentTimeKey(): string

• Method that returns the key for the current time.

  Returns string

  The key for the current time as a string.

getMemoriesUntilLimit

• getMemoriesUntilLimit(consumedTokens): Promise<string>

• Method that retrieves memories until a token limit is reached.

  Parameters

  • consumedTokens: number

    The number of tokens consumed so far.

  Returns Promise<string>

  The memories as a string.

getMostRecentMemoriesTokenKey

• getMostRecentMemoriesTokenKey(): string

• Method that returns the key for the most recent memories token.

  Returns string

  The key for the most recent memories token as a string.

getRelevantMemoriesKey

• getRelevantMemoriesKey(): string

• Method that returns the key for relevant memories.

  Returns string

  The key for relevant memories as a string.

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

• saveContext(_inputs, outputs): Promise<void>

• Method that saves the context of a model run to memory.

  Parameters

  • _inputs: InputValues

    The inputs of the model run.

  • outputs: OutputValues

    The outputs of the model run.

  Returns Promise<void>

  Nothing.