langchain 0.0.131 → 0.0.132

package/dist/experimental/generative_agents/generative_agent.js

@@ -1,6 +1,11 @@
 import { LLMChain } from "../../chains/llm_chain.js";
 import { PromptTemplate } from "../../prompts/index.js";
 import { BaseChain } from "../../chains/base.js";
+/**
+ * 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.
+ */
 export class GenerativeAgent extends BaseChain {
     static lc_name() {
         return "GenerativeAgent";
@@ -93,12 +98,23 @@ export class GenerativeAgent extends BaseChain {
         // this.dailySummaries = config.dailySummaries ?? this.dailySummaries;
     }
     // LLM methods
+    /**
+     * Parses a newline-separated string into a list of strings.
+     * @param text The string to parse.
+     * @returns An array of strings parsed from the input text.
+     */
     parseList(text) {
         // parse a newline-seperated string into a list of strings
         const lines = text.trim().split("\n");
         const result = lines.map((line) => line.replace(/^\s*\d+\.\s*/, "").trim());
         return result;
     }
+    /**
+     * Creates a new LLMChain with the given prompt and the agent's language
+     * model, verbosity, output key, and memory.
+     * @param prompt The prompt to use for the LLMChain.
+     * @returns A new LLMChain instance.
+     */
     chain(prompt) {
         const chain = new LLMChain({
             llm: this.llm,
@@ -109,6 +125,12 @@ export class GenerativeAgent extends BaseChain {
         });
         return chain;
     }
+    /**
+     * Extracts the observed entity from the given observation.
+     * @param observation The observation to extract the entity from.
+     * @param runManager Optional CallbackManagerForChainRun instance.
+     * @returns The extracted entity as a string.
+     */
     async getEntityFromObservations(observation, runManager) {
         const prompt = PromptTemplate.fromTemplate("What is the observed entity in the following observation? {observation}" +
             "\nEntity=");
@@ -117,6 +139,13 @@ export class GenerativeAgent extends BaseChain {
         }, runManager?.getChild("entity_extractor"));
         return result.output;
     }
+    /**
+     * Extracts the action of the given entity from the given observation.
+     * @param observation The observation to extract the action from.
+     * @param entityName The name of the entity to extract the action for.
+     * @param runManager Optional CallbackManagerForChainRun instance.
+     * @returns The extracted action as a string.
+     */
     async getEntityAction(observation, entityName, runManager) {
         const prompt = PromptTemplate.fromTemplate("What is the {entity} doing in the following observation? {observation}" +
             "\nThe {entity} is");
@@ -127,6 +156,12 @@ export class GenerativeAgent extends BaseChain {
         const trimmedResult = result.output.trim();
         return trimmedResult;
     }
+    /**
+     * Summarizes memories that are most relevant to an observation.
+     * @param observation The observation to summarize related memories for.
+     * @param runManager Optional CallbackManagerForChainRun instance.
+     * @returns The summarized memories as a string.
+     */
     async summarizeRelatedMemories(observation, runManager) {
         // summarize memories that are most relevant to an observation
         const prompt = PromptTemplate.fromTemplate(`
@@ -209,6 +244,12 @@ Relevant context:`);
         const regex = new RegExp(`^${this.name} `);
         return text.replace(regex, "").trim();
     }
+    /**
+     * Generates a reaction to the given observation.
+     * @param observation The observation to generate a reaction for.
+     * @param now Optional current date.
+     * @returns A boolean indicating whether to continue the dialogue and the output string.
+     */
     async generateReaction(observation, now) {
         const callToActionTemplate = `Should {agent_name} react to the observation, and if so,` +
             ` what would be an appropriate reaction? Respond in one line.` +
@@ -222,6 +263,12 @@ Relevant context:`);
         });
         return [continue_dialogue, output];
     }
+    /**
+     * Generates a dialogue response to the given observation.
+     * @param observation The observation to generate a dialogue response for.
+     * @param now Optional current date.
+     * @returns A boolean indicating whether to continue the dialogue and the output string.
+     */
     async generateDialogueResponse(observation, now) {
         const callToActionTemplate = `What would ${this.name} say? To end the conversation, write: GOODBYE: "what to say". Otherwise to continue the conversation, write: SAY: "what to say next"\n\n`;
         const { output, continue_dialogue } = await this.call({
@@ -235,6 +282,14 @@ Relevant context:`);
     // Each dialog or response prompt includes a header
     // summarizing the agent's self-description. This is
     // updated periodically through probing it's memories
+    /**
+     * 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.
+     * @param config Optional configuration object with current date and a boolean to force refresh.
+     * @param runManager Optional CallbackManagerForChainRun instance.
+     * @returns The agent's summary as a string.
+     */
     async getSummary(config, runManager) {
         const { now = new Date(), forceRefresh = false } = config ?? {};
         const sinceRefresh = Math.floor((now.getTime() - this.lastRefreshed.getTime()) / 1000);
@@ -255,6 +310,12 @@ Relevant context:`);
 Innate traits: ${this.traits}
 ${this.summary}`;
     }
+    /**
+     * Computes the agent's summary by summarizing the agent's core
+     * characteristics given the agent's relevant memories.
+     * @param runManager Optional CallbackManagerForChainRun instance.
+     * @returns The computed summary as a string.
+     */
     async computeAgentSummary(runManager) {
         const prompt = PromptTemplate.fromTemplate("How would you summarize {name}'s core characteristics given the following statements:\n" +
             "----------" +
@@ -269,6 +330,11 @@ ${this.summary}`;
         }, runManager?.getChild("compute_agent_summary"));
         return result.output.trim();
     }
+    /**
+     * Returns a full header of the agent's status, summary, and current time.
+     * @param config Optional configuration object with current date and a boolean to force refresh.
+     * @returns The full header as a string.
+     */
     getFullHeader(config = {}) {
         const { now = new Date(), forceRefresh = false } = config;
         // return a full header of the agent's status, summary, and current time.
@@ -283,6 +349,14 @@ ${this.summary}`;
         });
         return `${summary}\nIt is ${currentTimeString}.\n${this.name}'s status: ${this.status}`;
     }
+    /**
+     * Adds a memory to the agent's long-term memory.
+     * @param memoryContent The content of the memory to add.
+     * @param now Optional current date.
+     * @param metadata Optional metadata for the memory.
+     * @param callbacks Optional Callbacks instance.
+     * @returns The result of adding the memory to the agent's long-term memory.
+     */
     async addMemory(memoryContent, now, metadata, callbacks) {
         return this.longTermMemory.addMemory(memoryContent, now, metadata, callbacks);
     }

package/dist/experimental/generative_agents/generative_agent_memory.cjs

@@ -6,6 +6,13 @@ const index_js_1 = require("../../prompts/index.cjs");
 const base_js_1 = require("../../chains/base.cjs");
 const document_js_1 = require("../../document.cjs");
 const base_js_2 = require("../../memory/base.cjs");
+/**
+ * Class that manages the memory of a generative agent in LangChain. It
+ * extends the `BaseChain` class and has methods for adding observations
+ * or memories to the agent's memory, scoring the importance of a memory,
+ * reflecting on recent events to add synthesized memories, and generating
+ * insights on a topic of reflection based on pertinent memories.
+ */
 class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
     static lc_name() {
         return "GenerativeAgentMemoryChain";
@@ -69,6 +76,11 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
     get outputKeys() {
         return ["output"];
     }
+    /**
+     * Method that creates a new LLMChain with the given prompt.
+     * @param prompt The PromptTemplate to use for the new LLMChain.
+     * @returns A new LLMChain instance.
+     */
     chain(prompt) {
         const chain = new llm_chain_js_1.LLMChain({
             llm: this.llm,
@@ -105,6 +117,13 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
         }
         return { output: importanceScore };
     }
+    /**
+     * Method that pauses the agent to reflect on recent events and generate
+     * new insights.
+     * @param now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for the reflection.
+     * @returns An array of new insights as strings.
+     */
     async pauseToReflect(now, runManager) {
         if (this.verbose) {
             console.log("Pausing to reflect...");
@@ -127,6 +146,12 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
         }
         return newInsights;
     }
+    /**
+     * Method that scores the importance of a given memory.
+     * @param memoryContent The content of the memory to score.
+     * @param runManager The CallbackManagerForChainRun to use for scoring.
+     * @returns The importance score of the memory as a number.
+     */
     async scoreMemoryImportance(memoryContent, runManager) {
         // score the absolute importance of a given memory
         const prompt = index_js_1.PromptTemplate.fromTemplate("On the scale of 1 to 10, where 1 is purely mundane" +
@@ -151,6 +176,13 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
             return 0.0;
         }
     }
+    /**
+     * Method that retrieves the topics of reflection based on the last K
+     * memories.
+     * @param lastK The number of most recent memories to consider for generating topics.
+     * @param runManager The CallbackManagerForChainRun to use for retrieving topics.
+     * @returns An array of topics of reflection as strings.
+     */
     async getTopicsOfReflection(lastK, runManager) {
         const prompt = index_js_1.PromptTemplate.fromTemplate("{observations}\n\n" +
             "Given only the information above, what are the 3 most salient" +
@@ -163,6 +195,14 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
         const result = await this.chain(prompt).run(observationStr, runManager?.getChild("reflection_topics"));
         return GenerativeAgentMemoryChain.parseList(result);
     }
+    /**
+     * Method that generates insights on a given topic of reflection based on
+     * pertinent memories.
+     * @param topic The topic of reflection.
+     * @param now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for generating insights.
+     * @returns An array of insights as strings.
+     */
     async getInsightsOnTopic(topic, now, runManager) {
         // generate insights on a topic of reflection, based on pertinent memories
         const prompt = index_js_1.PromptTemplate.fromTemplate("Statements about {topic}\n" +
@@ -179,15 +219,34 @@ class GenerativeAgentMemoryChain extends base_js_1.BaseChain {
         }, runManager?.getChild("reflection_insights"));
         return GenerativeAgentMemoryChain.parseList(result.output); // added output
     }
+    /**
+     * Method that parses a newline-separated string into a list of strings.
+     * @param text The newline-separated string to parse.
+     * @returns An array of strings.
+     */
     static parseList(text) {
         // parse a newine seperates string into a list of strings
         return text.split("\n").map((s) => s.trim());
     }
     // TODO: Mock "now" to simulate different times
+    /**
+     * Method that fetches memories related to a given observation.
+     * @param observation The observation to fetch memories for.
+     * @param _now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for fetching memories.
+     * @returns An array of Document instances representing the fetched memories.
+     */
     async fetchMemories(observation, _now, runManager) {
         return this.memoryRetriever.getRelevantDocuments(observation, runManager?.getChild("memory_retriever"));
     }
 }
+/**
+ * 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.
+ */
 class GenerativeAgentMemory extends base_js_2.BaseMemory {
     constructor(llm, memoryRetriever, config) {
         super();
@@ -280,15 +339,31 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
             importanceWeight: config?.importanceWeight,
         });
     }
+    /**
+     * Method that returns the key for relevant memories.
+     * @returns The key for relevant memories as a string.
+     */
     getRelevantMemoriesKey() {
         return this.relevantMemoriesKey;
     }
+    /**
+     * Method that returns the key for the most recent memories token.
+     * @returns The key for the most recent memories token as a string.
+     */
     getMostRecentMemoriesTokenKey() {
         return this.mostRecentMemoriesTokenKey;
     }
+    /**
+     * Method that returns the key for adding a memory.
+     * @returns The key for adding a memory as a string.
+     */
     getAddMemoryKey() {
         return this.addMemoryKey;
     }
+    /**
+     * Method that returns the key for the current time.
+     * @returns The key for the current time as a string.
+     */
     getCurrentTimeKey() {
         return this.nowKey;
     }
@@ -296,9 +371,22 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
         // Return an array of memory keys
         return [this.relevantMemoriesKey, this.mostRecentMemoriesKey];
     }
+    /**
+     * Method that adds a memory to the agent's memory.
+     * @param memoryContent The content of the memory to add.
+     * @param now The current date.
+     * @param metadata The metadata for the memory.
+     * @param callbacks The Callbacks to use for adding the memory.
+     * @returns The result of the memory addition.
+     */
     async addMemory(memoryContent, now, metadata, callbacks) {
         return this.memoryChain.call({ memory_content: memoryContent, now, memory_metadata: metadata }, callbacks);
     }
+    /**
+     * Method that formats the given relevant memories in detail.
+     * @param relevantMemories The relevant memories to format.
+     * @returns The formatted memories as a string.
+     */
     formatMemoriesDetail(relevantMemories) {
         if (!relevantMemories.length) {
             return "No relevant information.";
@@ -323,12 +411,22 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
         const joinedContent = content.map((mem) => `${mem}`).join("\n");
         return joinedContent;
     }
+    /**
+     * Method that formats the given relevant memories in a simple manner.
+     * @param relevantMemories The relevant memories to format.
+     * @returns The formatted memories as a string.
+     */
     formatMemoriesSimple(relevantMemories) {
         const joinedContent = relevantMemories
             .map((mem) => `${mem.pageContent}`)
             .join("; ");
         return joinedContent;
     }
+    /**
+     * Method that retrieves memories until a token limit is reached.
+     * @param consumedTokens The number of tokens consumed so far.
+     * @returns The memories as a string.
+     */
     async getMemoriesUntilLimit(consumedTokens) {
         // reduce the number of tokens in the documents
         const result = [];
@@ -354,6 +452,11 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
         // input keys this memory class will load dynamically
         return [];
     }
+    /**
+     * Method that loads memory variables based on the given inputs.
+     * @param inputs The inputs to use for loading memory variables.
+     * @returns An object containing the loaded memory variables.
+     */
     async loadMemoryVariables(inputs) {
         const queries = inputs[this.queriesKey];
         const now = inputs[this.nowKey];
@@ -372,6 +475,12 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
         }
         return {};
     }
+    /**
+     * Method that saves the context of a model run to memory.
+     * @param _inputs The inputs of the model run.
+     * @param outputs The outputs of the model run.
+     * @returns Nothing.
+     */
     async saveContext(_inputs, outputs) {
         // save the context of this model run to memory
         const mem = outputs[this.addMemoryKey];
@@ -380,6 +489,10 @@ class GenerativeAgentMemory extends base_js_2.BaseMemory {
             await this.addMemory(mem, now, {});
         }
     }
+    /**
+     * Method that clears the memory contents.
+     * @returns Nothing.
+     */
     clear() {
         // TODO: clear memory contents
     }

package/dist/experimental/generative_agents/generative_agent_memory.d.ts

@@ -13,6 +13,13 @@ export type GenerativeAgentMemoryConfig = {
     verbose?: boolean;
     maxTokensLimit?: number;
 };
+/**
+ * Class that manages the memory of a generative agent in LangChain. It
+ * extends the `BaseChain` class and has methods for adding observations
+ * or memories to the agent's memory, scoring the importance of a memory,
+ * reflecting on recent events to add synthesized memories, and generating
+ * insights on a topic of reflection based on pertinent memories.
+ */
 declare class GenerativeAgentMemoryChain extends BaseChain {
     static lc_name(): string;
     reflecting: boolean;
@@ -26,17 +33,69 @@ declare class GenerativeAgentMemoryChain extends BaseChain {
     _chainType(): string;
     get inputKeys(): string[];
     get outputKeys(): string[];
+    /**
+     * Method that creates a new LLMChain with the given prompt.
+     * @param prompt The PromptTemplate to use for the new LLMChain.
+     * @returns A new LLMChain instance.
+     */
     chain(prompt: PromptTemplate): LLMChain;
     _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<{
         output: number;
     }>;
+    /**
+     * Method that pauses the agent to reflect on recent events and generate
+     * new insights.
+     * @param now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for the reflection.
+     * @returns An array of new insights as strings.
+     */
     pauseToReflect(now?: Date, runManager?: CallbackManagerForChainRun): Promise<string[]>;
+    /**
+     * Method that scores the importance of a given memory.
+     * @param memoryContent The content of the memory to score.
+     * @param runManager The CallbackManagerForChainRun to use for scoring.
+     * @returns The importance score of the memory as a number.
+     */
     scoreMemoryImportance(memoryContent: string, runManager?: CallbackManagerForChainRun): Promise<number>;
+    /**
+     * Method that retrieves the topics of reflection based on the last K
+     * memories.
+     * @param lastK The number of most recent memories to consider for generating topics.
+     * @param runManager The CallbackManagerForChainRun to use for retrieving topics.
+     * @returns An array of topics of reflection as strings.
+     */
     getTopicsOfReflection(lastK: number, runManager?: CallbackManagerForChainRun): Promise<string[]>;
+    /**
+     * Method that generates insights on a given topic of reflection based on
+     * pertinent memories.
+     * @param topic The topic of reflection.
+     * @param now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for generating insights.
+     * @returns An array of insights as strings.
+     */
     getInsightsOnTopic(topic: string, now?: Date, runManager?: CallbackManagerForChainRun): Promise<string[]>;
+    /**
+     * Method that parses a newline-separated string into a list of strings.
+     * @param text The newline-separated string to parse.
+     * @returns An array of strings.
+     */
     static parseList(text: string): string[];
+    /**
+     * Method that fetches memories related to a given observation.
+     * @param observation The observation to fetch memories for.
+     * @param _now The current date.
+     * @param runManager The CallbackManagerForChainRun to use for fetching memories.
+     * @returns An array of Document instances representing the fetched memories.
+     */
     fetchMemories(observation: string, _now?: Date, runManager?: CallbackManagerForChainRun): Promise<Document[]>;
 }
+/**
+ * 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.
+ */
 export declare class GenerativeAgentMemory extends BaseMemory {
     llm: BaseLanguageModel;
     memoryRetriever: TimeWeightedVectorStoreRetriever;
@@ -52,18 +111,72 @@ export declare class GenerativeAgentMemory extends BaseMemory {
     nowKey: string;
     memoryChain: GenerativeAgentMemoryChain;
     constructor(llm: BaseLanguageModel, memoryRetriever: TimeWeightedVectorStoreRetriever, config?: GenerativeAgentMemoryConfig);
+    /**
+     * Method that returns the key for relevant memories.
+     * @returns The key for relevant memories as a string.
+     */
     getRelevantMemoriesKey(): string;
+    /**
+     * Method that returns the key for the most recent memories token.
+     * @returns The key for the most recent memories token as a string.
+     */
     getMostRecentMemoriesTokenKey(): string;
+    /**
+     * Method that returns the key for adding a memory.
+     * @returns The key for adding a memory as a string.
+     */
     getAddMemoryKey(): string;
+    /**
+     * Method that returns the key for the current time.
+     * @returns The key for the current time as a string.
+     */
     getCurrentTimeKey(): string;
     get memoryKeys(): string[];
+    /**
+     * Method that adds a memory to the agent's memory.
+     * @param memoryContent The content of the memory to add.
+     * @param now The current date.
+     * @param metadata The metadata for the memory.
+     * @param callbacks The Callbacks to use for adding the memory.
+     * @returns The result of the memory addition.
+     */
     addMemory(memoryContent: string, now?: Date, metadata?: Record<string, unknown>, callbacks?: Callbacks): Promise<ChainValues>;
+    /**
+     * Method that formats the given relevant memories in detail.
+     * @param relevantMemories The relevant memories to format.
+     * @returns The formatted memories as a string.
+     */
     formatMemoriesDetail(relevantMemories: Document[]): string;
+    /**
+     * Method that formats the given relevant memories in a simple manner.
+     * @param relevantMemories The relevant memories to format.
+     * @returns The formatted memories as a string.
+     */
     formatMemoriesSimple(relevantMemories: Document[]): string;
+    /**
+     * Method that retrieves memories until a token limit is reached.
+     * @param consumedTokens The number of tokens consumed so far.
+     * @returns The memories as a string.
+     */
     getMemoriesUntilLimit(consumedTokens: number): Promise<string>;
     get memoryVariables(): string[];
+    /**
+     * Method that loads memory variables based on the given inputs.
+     * @param inputs The inputs to use for loading memory variables.
+     * @returns An object containing the loaded memory variables.
+     */
     loadMemoryVariables(inputs: InputValues): Promise<Record<string, string>>;
+    /**
+     * Method that saves the context of a model run to memory.
+     * @param _inputs The inputs of the model run.
+     * @param outputs The outputs of the model run.
+     * @returns Nothing.
+     */
     saveContext(_inputs: InputValues, outputs: OutputValues): Promise<void>;
+    /**
+     * Method that clears the memory contents.
+     * @returns Nothing.
+     */
     clear(): void;
 }
 export {};