Class GenerativeAgent

Implementation of a generative agent that can learn and form new memories over time. It extends the BaseChain class, which is a generic sequence of calls to components, including other chains.

Example

const tommie: GenerativeAgent = new GenerativeAgent(
  new OpenAI({ temperature: 0.9, maxTokens: 1500 }),
  new GenerativeAgentMemory(
    new ChatOpenAI(),
    new TimeWeightedVectorStoreRetriever({
      vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
      otherScoreKeys: ["importance"],
      k: 15,
    }),
    { reflectionThreshold: 8 },
  ),
  {
    name: "Tommie",
    age: 25,
    traits: "anxious, likes design, talkative",
    status: "looking for a job",
  },
);

await tommie.addMemory(
  "Tommie remembers his dog, Bruno, from when he was a kid",
  new Date(),
);
const summary = await tommie.getSummary({ forceRefresh: true });
const response = await tommie.generateDialogueResponse(
  "USER says Hello Tommie, how are you today?",
);

Hierarchy

BaseChain
- GenerativeAgent

Index

Constructors

constructor

new GenerativeAgent(llm, longTermMemory, config): GenerativeAgent
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
- longTermMemory: GenerativeAgentMemory
- config: GenerativeAgentConfig
Returns GenerativeAgent
Overrides BaseChain.constructor
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:105

Properties

llm

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

longTermMemory

longTermMemory: GenerativeAgentMemory

name

name: string

status

status: string

traits

traits: string

verbose

verbose: boolean

`Optional` age

age?: number

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:97

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:101

Methods

addMemory

addMemory(memoryContent, now?, metadata?, callbacks?): Promise<ChainValues>
Adds a memory to the agent's long-term memory.
Parameters
- memoryContent: string
  
  The content of the memory to add.
- Optional now: Date
  
  Optional current date.
- Optional metadata: Record<string, unknown>
  
  Optional metadata for the memory.
- Optional callbacks: Callbacks
  
  Optional Callbacks instance.
Returns Promise<ChainValues>
The result of adding the memory to the agent's long-term memory.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:505

apply

apply(inputs, config?): Promise<ChainValues[]>
Call the chain on all inputs in the list
Parameters
- inputs: ChainValues[]
- Optional config: (BaseCallbackConfig | Callbacks)[]
Returns Promise<ChainValues[]>
Inherited from BaseChain.apply
- Defined in docs/api_refs/langchain/src/chains/base.ts:252

call

call(values, config?, tags?): Promise<ChainValues>
Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Parameters
- values: ChainValues & {
  signal?: AbortSignal;
  timeout?: number;
  }
- Optional config: BaseCallbackConfig | Callbacks
- Optional tags: string[]
  
  Deprecated
Returns Promise<ChainValues>
Inherited from BaseChain.call
- Defined in docs/api_refs/langchain/src/chains/base.ts:192

chain

chain(prompt): LLMChain<string, LLMType>
Creates a new LLMChain with the given prompt and the agent's language model, verbosity, output key, and memory.
Parameters
- prompt: PromptTemplate<any, any>
  
  The prompt to use for the LLMChain.
Returns LLMChain<string, LLMType>
A new LLMChain instance.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:146

computeAgentSummary

computeAgentSummary(runManager?): Promise<string>
Computes the agent's summary by summarizing the agent's core characteristics given the agent's relevant memories.
Parameters
- Optional runManager: CallbackManagerForChainRun
  
  Optional CallbackManagerForChainRun instance.
Returns Promise<string>
The computed summary as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:450

generateDialogueResponse

generateDialogueResponse(observation, now?): Promise<[boolean, string]>
Generates a dialogue response to the given observation.
Parameters
- observation: string
  
  The observation to generate a dialogue response for.
- Optional now: Date
  
  Optional current date.
Returns Promise<[boolean, string]>
A boolean indicating whether to continue the dialogue and the output string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:385

generateReaction

generateReaction(observation, now?): Promise<[boolean, string]>
Generates a reaction to the given observation.
Parameters
- observation: string
  
  The observation to generate a reaction for.
- Optional now: Date
  
  Optional current date.
Returns Promise<[boolean, string]>
A boolean indicating whether to continue the dialogue and the output string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:360

getEntityAction

getEntityAction(observation, entityName, runManager?): Promise<string>
Extracts the action of the given entity from the given observation.
Parameters
- observation: string
  
  The observation to extract the action from.
- entityName: string
  
  The name of the entity to extract the action for.
- Optional runManager: CallbackManagerForChainRun
  
  Optional CallbackManagerForChainRun instance.
Returns Promise<string>
The extracted action as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:189

getEntityFromObservations

getEntityFromObservations(observation, runManager?): Promise<string>
Extracts the observed entity from the given observation.
Parameters
- observation: string
  
  The observation to extract the entity from.
- Optional runManager: CallbackManagerForChainRun
  
  Optional CallbackManagerForChainRun instance.
Returns Promise<string>
The extracted entity as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:163

getFullHeader

getFullHeader(config?): string
Returns a full header of the agent's status, summary, and current time.
Parameters
- config: {
  forceRefresh?: boolean;
  now?: Date;
  } = {}
  
  Optional configuration object with current date and a boolean to force refresh.
  - Optional forceRefresh?: boolean
  - Optional now?: Date
Returns string
The full header as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:477

getSummary

getSummary(config?, runManager?): Promise<string>
Gets the agent's summary, which includes the agent's name, age, traits, and a summary of the agent's core characteristics. The summary is updated periodically through probing the agent's memories.
Parameters
- Optional config: {
  forceRefresh?: boolean;
  now?: Date;
  }
  
  Optional configuration object with current date and a boolean to force refresh.
  - Optional forceRefresh?: boolean
  - Optional now?: Date
- Optional runManager: CallbackManagerForChainRun
  
  Optional CallbackManagerForChainRun instance.
Returns Promise<string>
The agent's summary as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:410

invoke

invoke(input, config?): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  
  Input values for the chain run.
- Optional config: BaseCallbackConfig
  
  Optional configuration for the Runnable.
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in docs/api_refs/langchain/src/chains/base.ts:83

parseList

parseList(text): string[]
Parses a newline-separated string into a list of strings.
Parameters
- text: string
  
  The string to parse.
Returns string[]
An array of strings parsed from the input text.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:131

prepOutputs

prepOutputs(inputs, outputs, returnOnlyOutputs?): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from BaseChain.prepOutputs
- Defined in docs/api_refs/langchain/src/chains/base.ts:99

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<string>
Inherited from BaseChain.run
- Defined in docs/api_refs/langchain/src/chains/base.ts:140

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in docs/api_refs/langchain/src/chains/base.ts:132

summarizeRelatedMemories

summarizeRelatedMemories(observation, runManager?): Promise<string>
Summarizes memories that are most relevant to an observation.
Parameters
- observation: string
  
  The observation to summarize related memories for.
- Optional runManager: CallbackManagerForChainRun
  
  Optional CallbackManagerForChainRun instance.
Returns Promise<string>
The summarized memories as a string.
- Defined in docs/api_refs/langchain/src/experimental/generative_agents/generative_agent.ts:216

`Static` deserialize

deserialize(data, values?): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from BaseChain.deserialize
- Defined in docs/api_refs/langchain/src/chains/base.ts:264

Class GenerativeAgent

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

longTermMemory: GenerativeAgentMemory

config: GenerativeAgentConfig

Returns GenerativeAgent

Properties

llm

longTermMemory

name

status

traits

verbose

Optional age

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

addMemory

Parameters

memoryContent: string

Optional now: Date

Optional metadata: Record<string, unknown>

Optional callbacks: Callbacks

Returns Promise<ChainValues>

apply

Parameters

inputs: ChainValues[]

Optional config: (BaseCallbackConfig | Callbacks)[]

Returns Promise<ChainValues[]>

call

Parameters

values: ChainValues & { signal?: AbortSignal; timeout?: number; }

Optional config: BaseCallbackConfig | Callbacks

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

chain

Parameters

prompt: PromptTemplate<any, any>

Returns LLMChain<string, LLMType>

computeAgentSummary

Parameters

Optional runManager: CallbackManagerForChainRun

Returns Promise<string>

generateDialogueResponse

Parameters

observation: string

Optional now: Date

Returns Promise<[boolean, string]>

generateReaction

Parameters

observation: string

Optional now: Date

Returns Promise<[boolean, string]>

getEntityAction

Parameters

observation: string

entityName: string

Optional runManager: CallbackManagerForChainRun

Returns Promise<string>

getEntityFromObservations

Parameters

observation: string

Optional runManager: CallbackManagerForChainRun

Returns Promise<string>

getFullHeader

Parameters

`Optional` age

`Optional` memory

`Optional` now: Date

`Optional` metadata: Record<string, unknown>

`Optional` callbacks: Callbacks

`Optional` config: (BaseCallbackConfig | Callbacks)[]

values: ChainValues & {
signal?: AbortSignal;
timeout?: number;
}

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` tags: string[]

`Optional` runManager: CallbackManagerForChainRun

`Optional` now: Date

`Optional` now: Date

`Optional` runManager: CallbackManagerForChainRun

`Optional` runManager: CallbackManagerForChainRun

config: {
forceRefresh?: boolean;
now?: Date;
} = {}

`Optional` forceRefresh?: boolean

`Optional` now?: Date

`Optional` config: {
forceRefresh?: boolean;
now?: Date;
}

`Optional` forceRefresh?: boolean

`Optional` now?: Date

`Optional` runManager: CallbackManagerForChainRun

`Optional` config: BaseCallbackConfig

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` runManager: CallbackManagerForChainRun

`Static` deserialize