langchain 0.0.131 → 0.0.132

package/dist/memory/entity_memory.cjs

@@ -7,6 +7,11 @@ const base_js_1 = require("./base.cjs");
 const llm_chain_js_1 = require("../chains/llm_chain.cjs");
 const in_memory_js_1 = require("./stores/entity/in_memory.cjs");
 // Entity extractor & summarizer to memory.
+/**
+ * Class for managing entity extraction and summarization to memory in
+ * chatbot applications. Extends the BaseChatMemory class and implements
+ * the EntityMemoryInput interface.
+ */
 class EntityMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {
         super({
@@ -100,6 +105,11 @@ class EntityMemory extends chat_memory_js_1.BaseChatMemory {
         return [this.entitiesKey, this.chatHistoryKey];
     }
     // Return history buffer.
+    /**
+     * Method to load memory variables and perform entity extraction.
+     * @param inputs Input values for the method.
+     * @returns Promise resolving to an object containing memory variables.
+     */
     async loadMemoryVariables(inputs) {
         const promptInputKey = this.inputKey ?? (0, base_js_1.getPromptInputKey)(inputs, this.memoryVariables);
         const messages = await this.chatHistory.getMessages();
@@ -123,6 +133,13 @@ class EntityMemory extends chat_memory_js_1.BaseChatMemory {
         };
     }
     // Save context from this conversation to buffer.
+    /**
+     * Method to save the context from a conversation to a buffer and perform
+     * entity summarization.
+     * @param inputs Input values for the method.
+     * @param outputs Output values from the method.
+     * @returns Promise resolving to void.
+     */
     async saveContext(inputs, outputs) {
         await super.saveContext(inputs, outputs);
         const promptInputKey = this.inputKey ?? (0, base_js_1.getPromptInputKey)(inputs, this.memoryVariables);
@@ -143,6 +160,10 @@ class EntityMemory extends chat_memory_js_1.BaseChatMemory {
         }
     }
     // Clear memory contents.
+    /**
+     * Method to clear the memory contents.
+     * @returns Promise resolving to void.
+     */
     async clear() {
         await super.clear();
         await this.entityStore.clear();

package/dist/memory/entity_memory.d.ts

@@ -3,6 +3,9 @@ import { BaseEntityStore } from "../schema/index.js";
 import { BaseChatMemory, BaseChatMemoryInput } from "./chat_memory.js";
 import { InputValues, MemoryVariables, OutputValues } from "./base.js";
 import { PromptTemplate } from "../prompts/prompt.js";
+/**
+ * Interface for the input parameters required by the EntityMemory class.
+ */
 export interface EntityMemoryInput extends BaseChatMemoryInput {
     llm: BaseLanguageModel;
     humanPrefix?: string;
@@ -15,6 +18,11 @@ export interface EntityMemoryInput extends BaseChatMemoryInput {
     entitiesKey?: string;
     entityStore?: BaseEntityStore;
 }
+/**
+ * Class for managing entity extraction and summarization to memory in
+ * chatbot applications. Extends the BaseChatMemory class and implements
+ * the EntityMemoryInput interface.
+ */
 export declare class EntityMemory extends BaseChatMemory implements EntityMemoryInput {
     private entityExtractionChain;
     private entitySummarizationChain;
@@ -29,7 +37,23 @@ export declare class EntityMemory extends BaseChatMemory implements EntityMemory
     constructor(fields: EntityMemoryInput);
     get memoryKeys(): string[];
     get memoryVariables(): string[];
+    /**
+     * Method to load memory variables and perform entity extraction.
+     * @param inputs Input values for the method.
+     * @returns Promise resolving to an object containing memory variables.
+     */
     loadMemoryVariables(inputs: InputValues): Promise<MemoryVariables>;
+    /**
+     * Method to save the context from a conversation to a buffer and perform
+     * entity summarization.
+     * @param inputs Input values for the method.
+     * @param outputs Output values from the method.
+     * @returns Promise resolving to void.
+     */
     saveContext(inputs: InputValues, outputs: OutputValues): Promise<void>;
+    /**
+     * Method to clear the memory contents.
+     * @returns Promise resolving to void.
+     */
     clear(): Promise<void>;
 }

package/dist/memory/entity_memory.js

@@ -4,6 +4,11 @@ import { getBufferString, getPromptInputKey, } from "./base.js";
 import { LLMChain } from "../chains/llm_chain.js";
 import { InMemoryEntityStore } from "./stores/entity/in_memory.js";
 // Entity extractor & summarizer to memory.
+/**
+ * Class for managing entity extraction and summarization to memory in
+ * chatbot applications. Extends the BaseChatMemory class and implements
+ * the EntityMemoryInput interface.
+ */
 export class EntityMemory extends BaseChatMemory {
     constructor(fields) {
         super({
@@ -97,6 +102,11 @@ export class EntityMemory extends BaseChatMemory {
         return [this.entitiesKey, this.chatHistoryKey];
     }
     // Return history buffer.
+    /**
+     * Method to load memory variables and perform entity extraction.
+     * @param inputs Input values for the method.
+     * @returns Promise resolving to an object containing memory variables.
+     */
     async loadMemoryVariables(inputs) {
         const promptInputKey = this.inputKey ?? getPromptInputKey(inputs, this.memoryVariables);
         const messages = await this.chatHistory.getMessages();
@@ -120,6 +130,13 @@ export class EntityMemory extends BaseChatMemory {
         };
     }
     // Save context from this conversation to buffer.
+    /**
+     * Method to save the context from a conversation to a buffer and perform
+     * entity summarization.
+     * @param inputs Input values for the method.
+     * @param outputs Output values from the method.
+     * @returns Promise resolving to void.
+     */
     async saveContext(inputs, outputs) {
         await super.saveContext(inputs, outputs);
         const promptInputKey = this.inputKey ?? getPromptInputKey(inputs, this.memoryVariables);
@@ -140,6 +157,10 @@ export class EntityMemory extends BaseChatMemory {
         }
     }
     // Clear memory contents.
+    /**
+     * Method to clear the memory contents.
+     * @returns Promise resolving to void.
+     */
     async clear() {
         await super.clear();
         await this.entityStore.clear();

package/dist/memory/motorhead_memory.cjs

@@ -5,6 +5,11 @@ const chat_memory_js_1 = require("./chat_memory.cjs");
 const base_js_1 = require("./base.cjs");
 const async_caller_js_1 = require("../util/async_caller.cjs");
 const MANAGED_URL = "https://api.getmetal.io/v1/motorhead";
+/**
+ * Class for managing chat message memory using the Motorhead service. It
+ * extends BaseChatMemory and includes methods for initializing the
+ * memory, loading memory variables, and saving the context.
+ */
 class MotorheadMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {
         const { sessionId, url, memoryKey, timeout, returnMessages, inputKey, outputKey, chatHistory, apiKey, clientId, ...rest } = fields;
@@ -83,6 +88,11 @@ class MotorheadMemory extends chat_memory_js_1.BaseChatMemory {
         }
         return headers;
     }
+    /**
+     * Method that initializes the memory by fetching the session memory from
+     * the Motorhead service. It adds the messages to the chat history and
+     * sets the context if it is not 'NONE'.
+     */
     async init() {
         const res = await this.caller.call(fetch, `${this.url}/sessions/${this.sessionId}/memory`, {
             signal: this.timeout ? AbortSignal.timeout(this.timeout) : undefined,
@@ -103,6 +113,12 @@ class MotorheadMemory extends chat_memory_js_1.BaseChatMemory {
             this.context = context;
         }
     }
+    /**
+     * Method that loads the memory variables. It gets the chat messages and
+     * returns them as a string or an array based on the returnMessages flag.
+     * @param _values The input values.
+     * @returns A promise that resolves with the memory variables.
+     */
     async loadMemoryVariables(_values) {
         const messages = await this.chatHistory.getMessages();
         if (this.returnMessages) {
@@ -116,6 +132,15 @@ class MotorheadMemory extends chat_memory_js_1.BaseChatMemory {
         };
         return result;
     }
+    /**
+     * Method that saves the context to the Motorhead service and the base
+     * chat memory. It sends a POST request to the Motorhead service with the
+     * input and output messages, and calls the saveContext method of the base
+     * chat memory.
+     * @param inputValues The input values.
+     * @param outputValues The output values.
+     * @returns A promise that resolves when the context is saved.
+     */
     async saveContext(inputValues, outputValues) {
         const input = (0, base_js_1.getInputValue)(inputValues, this.inputKey);
         const output = (0, base_js_1.getOutputValue)(outputValues, this.outputKey);

package/dist/memory/motorhead_memory.d.ts

@@ -1,6 +1,10 @@
 import { BaseChatMemory, BaseChatMemoryInput } from "./chat_memory.js";
 import { InputValues, OutputValues, MemoryVariables } from "./base.js";
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
+/**
+ * Interface for the structure of a memory message in the Motorhead
+ * service. It includes the role and content of the message.
+ */
 export interface MotorheadMemoryMessage {
     role: string;
     content: string;
@@ -16,6 +20,11 @@ export type MotorheadMemoryInput = BaseChatMemoryInput & AsyncCallerParams & {
     apiKey?: string;
     clientId?: string;
 };
+/**
+ * Class for managing chat message memory using the Motorhead service. It
+ * extends BaseChatMemory and includes methods for initializing the
+ * memory, loading memory variables, and saving the context.
+ */
 export declare class MotorheadMemory extends BaseChatMemory {
     url: string;
     timeout: number;
@@ -28,7 +37,27 @@ export declare class MotorheadMemory extends BaseChatMemory {
     constructor(fields: MotorheadMemoryInput);
     get memoryKeys(): string[];
     _getHeaders(): HeadersInit;
+    /**
+     * Method that initializes the memory by fetching the session memory from
+     * the Motorhead service. It adds the messages to the chat history and
+     * sets the context if it is not 'NONE'.
+     */
     init(): Promise<void>;
+    /**
+     * Method that loads the memory variables. It gets the chat messages and
+     * returns them as a string or an array based on the returnMessages flag.
+     * @param _values The input values.
+     * @returns A promise that resolves with the memory variables.
+     */
     loadMemoryVariables(_values: InputValues): Promise<MemoryVariables>;
+    /**
+     * Method that saves the context to the Motorhead service and the base
+     * chat memory. It sends a POST request to the Motorhead service with the
+     * input and output messages, and calls the saveContext method of the base
+     * chat memory.
+     * @param inputValues The input values.
+     * @param outputValues The output values.
+     * @returns A promise that resolves when the context is saved.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
 }

package/dist/memory/motorhead_memory.js

@@ -2,6 +2,11 @@ import { BaseChatMemory } from "./chat_memory.js";
 import { getBufferString, getInputValue, getOutputValue, } from "./base.js";
 import { AsyncCaller } from "../util/async_caller.js";
 const MANAGED_URL = "https://api.getmetal.io/v1/motorhead";
+/**
+ * Class for managing chat message memory using the Motorhead service. It
+ * extends BaseChatMemory and includes methods for initializing the
+ * memory, loading memory variables, and saving the context.
+ */
 export class MotorheadMemory extends BaseChatMemory {
     constructor(fields) {
         const { sessionId, url, memoryKey, timeout, returnMessages, inputKey, outputKey, chatHistory, apiKey, clientId, ...rest } = fields;
@@ -80,6 +85,11 @@ export class MotorheadMemory extends BaseChatMemory {
         }
         return headers;
     }
+    /**
+     * Method that initializes the memory by fetching the session memory from
+     * the Motorhead service. It adds the messages to the chat history and
+     * sets the context if it is not 'NONE'.
+     */
     async init() {
         const res = await this.caller.call(fetch, `${this.url}/sessions/${this.sessionId}/memory`, {
             signal: this.timeout ? AbortSignal.timeout(this.timeout) : undefined,
@@ -100,6 +110,12 @@ export class MotorheadMemory extends BaseChatMemory {
             this.context = context;
         }
     }
+    /**
+     * Method that loads the memory variables. It gets the chat messages and
+     * returns them as a string or an array based on the returnMessages flag.
+     * @param _values The input values.
+     * @returns A promise that resolves with the memory variables.
+     */
     async loadMemoryVariables(_values) {
         const messages = await this.chatHistory.getMessages();
         if (this.returnMessages) {
@@ -113,6 +129,15 @@ export class MotorheadMemory extends BaseChatMemory {
         };
         return result;
     }
+    /**
+     * Method that saves the context to the Motorhead service and the base
+     * chat memory. It sends a POST request to the Motorhead service with the
+     * input and output messages, and calls the saveContext method of the base
+     * chat memory.
+     * @param inputValues The input values.
+     * @param outputValues The output values.
+     * @returns A promise that resolves when the context is saved.
+     */
     async saveContext(inputValues, outputValues) {
         const input = getInputValue(inputValues, this.inputKey);
         const output = getOutputValue(outputValues, this.outputKey);

package/dist/memory/stores/entity/in_memory.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InMemoryEntityStore = void 0;
 const index_js_1 = require("../../../schema/index.cjs");
+/**
+ * An entity store that keeps data in memory. It extends from the
+ * `BaseEntityStore` class and is used to store and manage entities.
+ */
 class InMemoryEntityStore extends index_js_1.BaseEntityStore {
     constructor() {
         super();
@@ -19,18 +23,43 @@ class InMemoryEntityStore extends index_js_1.BaseEntityStore {
         });
         this.store = Object.create(null);
     }
+    /**
+     * Retrieves the value associated with the given key from the store. If
+     * the key does not exist in the store, it returns the provided default
+     * value.
+     * @param key The key to retrieve the value for.
+     * @param defaultValue The default value to return if the key does not exist in the store.
+     * @returns The value associated with the key, or the default value if the key does not exist in the store.
+     */
     async get(key, defaultValue) {
         return key in this.store ? this.store[key] : defaultValue;
     }
+    /**
+     * Sets the value associated with the given key in the store.
+     * @param key The key to set the value for.
+     * @param value The value to set.
+     */
     async set(key, value) {
         this.store[key] = value;
     }
+    /**
+     * Removes the key and its associated value from the store.
+     * @param key The key to remove.
+     */
     async delete(key) {
         delete this.store[key];
     }
+    /**
+     * Checks if a key exists in the store.
+     * @param key The key to check.
+     * @returns A boolean indicating whether the key exists in the store.
+     */
     async exists(key) {
         return key in this.store;
     }
+    /**
+     * Removes all keys and their associated values from the store.
+     */
     async clear() {
         this.store = Object.create(null);
     }

package/dist/memory/stores/entity/in_memory.d.ts

@@ -1,11 +1,40 @@
 import { BaseEntityStore } from "../../../schema/index.js";
+/**
+ * An entity store that keeps data in memory. It extends from the
+ * `BaseEntityStore` class and is used to store and manage entities.
+ */
 export declare class InMemoryEntityStore extends BaseEntityStore {
     lc_namespace: string[];
     private store;
     constructor();
+    /**
+     * Retrieves the value associated with the given key from the store. If
+     * the key does not exist in the store, it returns the provided default
+     * value.
+     * @param key The key to retrieve the value for.
+     * @param defaultValue The default value to return if the key does not exist in the store.
+     * @returns The value associated with the key, or the default value if the key does not exist in the store.
+     */
     get(key: string, defaultValue: string | undefined): Promise<string | undefined>;
+    /**
+     * Sets the value associated with the given key in the store.
+     * @param key The key to set the value for.
+     * @param value The value to set.
+     */
     set(key: string, value: string | undefined): Promise<void>;
+    /**
+     * Removes the key and its associated value from the store.
+     * @param key The key to remove.
+     */
     delete(key: string): Promise<void>;
+    /**
+     * Checks if a key exists in the store.
+     * @param key The key to check.
+     * @returns A boolean indicating whether the key exists in the store.
+     */
     exists(key: string): Promise<boolean>;
+    /**
+     * Removes all keys and their associated values from the store.
+     */
     clear(): Promise<void>;
 }

package/dist/memory/stores/entity/in_memory.js

@@ -1,4 +1,8 @@
 import { BaseEntityStore } from "../../../schema/index.js";
+/**
+ * An entity store that keeps data in memory. It extends from the
+ * `BaseEntityStore` class and is used to store and manage entities.
+ */
 export class InMemoryEntityStore extends BaseEntityStore {
     constructor() {
         super();
@@ -16,18 +20,43 @@ export class InMemoryEntityStore extends BaseEntityStore {
         });
         this.store = Object.create(null);
     }
+    /**
+     * Retrieves the value associated with the given key from the store. If
+     * the key does not exist in the store, it returns the provided default
+     * value.
+     * @param key The key to retrieve the value for.
+     * @param defaultValue The default value to return if the key does not exist in the store.
+     * @returns The value associated with the key, or the default value if the key does not exist in the store.
+     */
     async get(key, defaultValue) {
         return key in this.store ? this.store[key] : defaultValue;
     }
+    /**
+     * Sets the value associated with the given key in the store.
+     * @param key The key to set the value for.
+     * @param value The value to set.
+     */
     async set(key, value) {
         this.store[key] = value;
     }
+    /**
+     * Removes the key and its associated value from the store.
+     * @param key The key to remove.
+     */
     async delete(key) {
         delete this.store[key];
     }
+    /**
+     * Checks if a key exists in the store.
+     * @param key The key to check.
+     * @returns A boolean indicating whether the key exists in the store.
+     */
     async exists(key) {
         return key in this.store;
     }
+    /**
+     * Removes all keys and their associated values from the store.
+     */
     async clear() {
         this.store = Object.create(null);
     }

package/dist/memory/summary.cjs

@@ -6,6 +6,11 @@ const index_js_1 = require("../schema/index.cjs");
 const base_js_1 = require("./base.cjs");
 const chat_memory_js_1 = require("./chat_memory.cjs");
 const prompt_js_1 = require("./prompt.cjs");
+/**
+ * Abstract class that provides a structure for storing and managing the
+ * memory of a conversation. It includes methods for predicting a new
+ * summary for the conversation given the existing messages and summary.
+ */
 class BaseConversationSummaryMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {
         const { returnMessages, inputKey, outputKey, chatHistory, humanPrefix, aiPrefix, llm, prompt, summaryChatMessageClass, } = fields;
@@ -54,6 +59,13 @@ class BaseConversationSummaryMemory extends chat_memory_js_1.BaseChatMemory {
         this.summaryChatMessageClass =
             summaryChatMessageClass ?? this.summaryChatMessageClass;
     }
+    /**
+     * Predicts a new summary for the conversation given the existing messages
+     * and summary.
+     * @param messages Existing messages in the conversation.
+     * @param existingSummary Current summary of the conversation.
+     * @returns A promise that resolves to a new summary string.
+     */
     async predictNewSummary(messages, existingSummary) {
         const newLines = (0, base_js_1.getBufferString)(messages, this.humanPrefix, this.aiPrefix);
         const chain = new llm_chain_js_1.LLMChain({ llm: this.llm, prompt: this.prompt });
@@ -64,6 +76,11 @@ class BaseConversationSummaryMemory extends chat_memory_js_1.BaseChatMemory {
     }
 }
 exports.BaseConversationSummaryMemory = BaseConversationSummaryMemory;
+/**
+ * Class that provides a concrete implementation of the conversation
+ * memory. It includes methods for loading memory variables, saving
+ * context, and clearing the memory.
+ */
 class ConversationSummaryMemory extends BaseConversationSummaryMemory {
     constructor(fields) {
         super(fields);
@@ -77,6 +94,10 @@ class ConversationSummaryMemory extends BaseConversationSummaryMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Loads the memory variables for the conversation memory.
+     * @returns A promise that resolves to an object containing the memory variables.
+     */
     async loadMemoryVariables(_) {
         if (this.returnMessages) {
             const result = {
@@ -87,11 +108,21 @@ class ConversationSummaryMemory extends BaseConversationSummaryMemory {
         const result = { [this.memoryKey]: this.buffer };
         return result;
     }
+    /**
+     * Saves the context of the conversation memory.
+     * @param inputValues Input values for the conversation.
+     * @param outputValues Output values from the conversation.
+     * @returns A promise that resolves when the context has been saved.
+     */
     async saveContext(inputValues, outputValues) {
         await super.saveContext(inputValues, outputValues);
         const messages = await this.chatHistory.getMessages();
         this.buffer = await this.predictNewSummary(messages.slice(-2), this.buffer);
     }
+    /**
+     * Clears the conversation memory.
+     * @returns A promise that resolves when the memory has been cleared.
+     */
     async clear() {
         await super.clear();
         this.buffer = "";

package/dist/memory/summary.d.ts

@@ -3,8 +3,16 @@ import { BasePromptTemplate } from "../prompts/base.js";
 import { BaseMessage } from "../schema/index.js";
 import { InputValues, MemoryVariables, OutputValues } from "./base.js";
 import { BaseChatMemory, BaseChatMemoryInput } from "./chat_memory.js";
+/**
+ * Interface for the input parameters of the ConversationSummaryMemory
+ * class.
+ */
 export interface ConversationSummaryMemoryInput extends BaseConversationSummaryMemoryInput {
 }
+/**
+ * Interface for the input parameters of the BaseConversationSummaryMemory
+ * class.
+ */
 export interface BaseConversationSummaryMemoryInput extends BaseChatMemoryInput {
     llm: BaseLanguageModel;
     memoryKey?: string;
@@ -13,6 +21,11 @@ export interface BaseConversationSummaryMemoryInput extends BaseChatMemoryInput
     prompt?: BasePromptTemplate;
     summaryChatMessageClass?: new (content: string) => BaseMessage;
 }
+/**
+ * Abstract class that provides a structure for storing and managing the
+ * memory of a conversation. It includes methods for predicting a new
+ * summary for the conversation given the existing messages and summary.
+ */
 export declare abstract class BaseConversationSummaryMemory extends BaseChatMemory {
     memoryKey: string;
     humanPrefix: string;
@@ -21,13 +34,39 @@ export declare abstract class BaseConversationSummaryMemory extends BaseChatMemo
     prompt: BasePromptTemplate;
     summaryChatMessageClass: new (content: string) => BaseMessage;
     constructor(fields: BaseConversationSummaryMemoryInput);
+    /**
+     * Predicts a new summary for the conversation given the existing messages
+     * and summary.
+     * @param messages Existing messages in the conversation.
+     * @param existingSummary Current summary of the conversation.
+     * @returns A promise that resolves to a new summary string.
+     */
     predictNewSummary(messages: BaseMessage[], existingSummary: string): Promise<string>;
 }
+/**
+ * Class that provides a concrete implementation of the conversation
+ * memory. It includes methods for loading memory variables, saving
+ * context, and clearing the memory.
+ */
 export declare class ConversationSummaryMemory extends BaseConversationSummaryMemory {
     buffer: string;
     constructor(fields: ConversationSummaryMemoryInput);
     get memoryKeys(): string[];
+    /**
+     * Loads the memory variables for the conversation memory.
+     * @returns A promise that resolves to an object containing the memory variables.
+     */
     loadMemoryVariables(_: InputValues): Promise<MemoryVariables>;
+    /**
+     * Saves the context of the conversation memory.
+     * @param inputValues Input values for the conversation.
+     * @param outputValues Output values from the conversation.
+     * @returns A promise that resolves when the context has been saved.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
+    /**
+     * Clears the conversation memory.
+     * @returns A promise that resolves when the memory has been cleared.
+     */
     clear(): Promise<void>;
 }

package/dist/memory/summary.js

@@ -3,6 +3,11 @@ import { SystemMessage } from "../schema/index.js";
 import { getBufferString, } from "./base.js";
 import { BaseChatMemory } from "./chat_memory.js";
 import { SUMMARY_PROMPT } from "./prompt.js";
+/**
+ * Abstract class that provides a structure for storing and managing the
+ * memory of a conversation. It includes methods for predicting a new
+ * summary for the conversation given the existing messages and summary.
+ */
 export class BaseConversationSummaryMemory extends BaseChatMemory {
     constructor(fields) {
         const { returnMessages, inputKey, outputKey, chatHistory, humanPrefix, aiPrefix, llm, prompt, summaryChatMessageClass, } = fields;
@@ -51,6 +56,13 @@ export class BaseConversationSummaryMemory extends BaseChatMemory {
         this.summaryChatMessageClass =
             summaryChatMessageClass ?? this.summaryChatMessageClass;
     }
+    /**
+     * Predicts a new summary for the conversation given the existing messages
+     * and summary.
+     * @param messages Existing messages in the conversation.
+     * @param existingSummary Current summary of the conversation.
+     * @returns A promise that resolves to a new summary string.
+     */
     async predictNewSummary(messages, existingSummary) {
         const newLines = getBufferString(messages, this.humanPrefix, this.aiPrefix);
         const chain = new LLMChain({ llm: this.llm, prompt: this.prompt });
@@ -60,6 +72,11 @@ export class BaseConversationSummaryMemory extends BaseChatMemory {
         });
     }
 }
+/**
+ * Class that provides a concrete implementation of the conversation
+ * memory. It includes methods for loading memory variables, saving
+ * context, and clearing the memory.
+ */
 export class ConversationSummaryMemory extends BaseConversationSummaryMemory {
     constructor(fields) {
         super(fields);
@@ -73,6 +90,10 @@ export class ConversationSummaryMemory extends BaseConversationSummaryMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Loads the memory variables for the conversation memory.
+     * @returns A promise that resolves to an object containing the memory variables.
+     */
     async loadMemoryVariables(_) {
         if (this.returnMessages) {
             const result = {
@@ -83,11 +104,21 @@ export class ConversationSummaryMemory extends BaseConversationSummaryMemory {
         const result = { [this.memoryKey]: this.buffer };
         return result;
     }
+    /**
+     * Saves the context of the conversation memory.
+     * @param inputValues Input values for the conversation.
+     * @param outputValues Output values from the conversation.
+     * @returns A promise that resolves when the context has been saved.
+     */
     async saveContext(inputValues, outputValues) {
         await super.saveContext(inputValues, outputValues);
         const messages = await this.chatHistory.getMessages();
         this.buffer = await this.predictNewSummary(messages.slice(-2), this.buffer);
     }
+    /**
+     * Clears the conversation memory.
+     * @returns A promise that resolves when the memory has been cleared.
+     */
     async clear() {
         await super.clear();
         this.buffer = "";