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

new GenerativeAgentMemory(llm, memoryRetriever, config?): GenerativeAgentMemory
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
- memoryRetriever: TimeWeightedVectorStoreRetriever
- Optional config: GenerativeAgentMemoryConfig
Returns GenerativeAgentMemory
Overrides BaseMemory.constructor
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:342

Properties

addMemoryKey

addMemoryKey: string = "addMemory"

llm

llm: BaseLanguageModel<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

get memoryKeys(): string[]
Returns string[]
Overrides BaseMemory.memoryKeys
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:392

memoryVariables

get memoryVariables(): string[]
Returns string[]
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:486

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: Callbacks
  
  The Callbacks to use for adding the memory.
Returns Promise<ChainValues>
The result of the memory addition.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:405

clear

clear(): void
Method that clears the memory contents.

Returns void
Nothing.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:548

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.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:422

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.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:452

getAddMemoryKey

getAddMemoryKey(): string
Method that returns the key for adding a memory.

Returns string
The key for adding a memory as a string.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:380

getCurrentTimeKey

getCurrentTimeKey(): string
Method that returns the key for the current time.

Returns string
The key for the current time as a string.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:388

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.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:464

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.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:372

getRelevantMemoriesKey

getRelevantMemoriesKey(): string
Method that returns the key for relevant memories.

Returns string
The key for relevant memories as a string.
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:364

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.
Overrides BaseMemory.loadMemoryVariables
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:496

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.
Overrides BaseMemory.saveContext
- Defined in langchain/src/experimental/generative_agents/generative_agent_memory.ts:532

Class GenerativeAgentMemory

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

memoryRetriever: TimeWeightedVectorStoreRetriever

Optional config: GenerativeAgentMemoryConfig

Returns GenerativeAgentMemory

Properties

addMemoryKey

llm

memoryChain

memoryRetriever

mostRecentMemoriesKey

mostRecentMemoriesTokenKey

nowKey

queriesKey

relevantMemoriesKey

relevantMemoriesSimpleKey

verbose

Optional reflectionThreshold

Accessors

memoryKeys

Returns string[]

memoryVariables

Returns string[]

Methods

addMemory

Parameters

memoryContent: string

Optional now: Date

Optional metadata: Record<string, unknown>

Optional callbacks: Callbacks

Returns Promise<ChainValues>

clear

Returns void

formatMemoriesDetail

Parameters

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

Returns string

formatMemoriesSimple

Parameters

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

Returns string

getAddMemoryKey

Returns string

getCurrentTimeKey

Returns string

getMemoriesUntilLimit

Parameters

consumedTokens: number

Returns Promise<string>

getMostRecentMemoriesTokenKey

Returns string

getRelevantMemoriesKey

Returns string

loadMemoryVariables

Parameters

inputs: InputValues

Returns Promise<Record<string, string>>

saveContext

Parameters

_inputs: InputValues

outputs: OutputValues

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` config: GenerativeAgentMemoryConfig

`Optional` reflectionThreshold

`Optional` now: Date

`Optional` metadata: Record<string, unknown>

`Optional` callbacks: Callbacks