langchain 0.0.130 → 0.0.132

package/dist/memory/summary_buffer.cjs

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationSummaryBufferMemory = void 0;
 const base_js_1 = require("./base.cjs");
 const summary_js_1 = require("./summary.cjs");
+/**
+ * Class that extends BaseConversationSummaryMemory and implements
+ * ConversationSummaryBufferMemoryInput. It manages the conversation
+ * history in a LangChain application by maintaining a buffer of chat
+ * messages and providing methods to load, save, prune, and clear the
+ * memory.
+ */
 class ConversationSummaryBufferMemory extends summary_js_1.BaseConversationSummaryMemory {
     constructor(fields) {
         super(fields);
@@ -23,6 +30,13 @@ class ConversationSummaryBufferMemory extends summary_js_1.BaseConversationSumma
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method that loads the chat messages from the memory and returns them as
+     * a string or as a list of messages, depending on the returnMessages
+     * property.
+     * @param _ InputValues object, not used in this method.
+     * @returns Promise that resolves with MemoryVariables object containing the loaded chat messages.
+     */
     async loadMemoryVariables(_) {
         let buffer = await this.chatHistory.getMessages();
         if (this.movingSummaryBuffer) {
@@ -40,10 +54,25 @@ class ConversationSummaryBufferMemory extends summary_js_1.BaseConversationSumma
         }
         return { [this.memoryKey]: finalBuffer };
     }
+    /**
+     * Method that saves the context of the conversation, including the input
+     * and output values, and prunes the memory if it exceeds the maximum
+     * token limit.
+     * @param inputValues InputValues object containing the input values of the conversation.
+     * @param outputValues OutputValues object containing the output values of the conversation.
+     * @returns Promise that resolves when the context is saved and the memory is pruned.
+     */
     async saveContext(inputValues, outputValues) {
         await super.saveContext(inputValues, outputValues);
         await this.prune();
     }
+    /**
+     * Method that prunes the memory if the total number of tokens in the
+     * buffer exceeds the maxTokenLimit. It removes messages from the
+     * beginning of the buffer until the total number of tokens is within the
+     * limit.
+     * @returns Promise that resolves when the memory is pruned.
+     */
     async prune() {
         // Prune buffer if it exceeds max token limit
         let buffer = await this.chatHistory.getMessages();
@@ -66,6 +95,10 @@ class ConversationSummaryBufferMemory extends summary_js_1.BaseConversationSumma
             this.movingSummaryBuffer = await this.predictNewSummary(prunedMemory, this.movingSummaryBuffer);
         }
     }
+    /**
+     * Method that clears the memory and resets the movingSummaryBuffer.
+     * @returns Promise that resolves when the memory is cleared.
+     */
     async clear() {
         await super.clear();
         this.movingSummaryBuffer = "";

package/dist/memory/summary_buffer.d.ts

@@ -1,15 +1,52 @@
 import { InputValues, MemoryVariables, OutputValues } from "./base.js";
 import { BaseConversationSummaryMemory, BaseConversationSummaryMemoryInput } from "./summary.js";
+/**
+ * Interface for the input parameters of the
+ * ConversationSummaryBufferMemory class.
+ */
 export interface ConversationSummaryBufferMemoryInput extends BaseConversationSummaryMemoryInput {
     maxTokenLimit?: number;
 }
+/**
+ * Class that extends BaseConversationSummaryMemory and implements
+ * ConversationSummaryBufferMemoryInput. It manages the conversation
+ * history in a LangChain application by maintaining a buffer of chat
+ * messages and providing methods to load, save, prune, and clear the
+ * memory.
+ */
 export declare class ConversationSummaryBufferMemory extends BaseConversationSummaryMemory implements ConversationSummaryBufferMemoryInput {
     movingSummaryBuffer: string;
     maxTokenLimit: number;
     constructor(fields: ConversationSummaryBufferMemoryInput);
     get memoryKeys(): string[];
+    /**
+     * Method that loads the chat messages from the memory and returns them as
+     * a string or as a list of messages, depending on the returnMessages
+     * property.
+     * @param _ InputValues object, not used in this method.
+     * @returns Promise that resolves with MemoryVariables object containing the loaded chat messages.
+     */
     loadMemoryVariables(_: InputValues): Promise<MemoryVariables>;
+    /**
+     * Method that saves the context of the conversation, including the input
+     * and output values, and prunes the memory if it exceeds the maximum
+     * token limit.
+     * @param inputValues InputValues object containing the input values of the conversation.
+     * @param outputValues OutputValues object containing the output values of the conversation.
+     * @returns Promise that resolves when the context is saved and the memory is pruned.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
+    /**
+     * Method that prunes the memory if the total number of tokens in the
+     * buffer exceeds the maxTokenLimit. It removes messages from the
+     * beginning of the buffer until the total number of tokens is within the
+     * limit.
+     * @returns Promise that resolves when the memory is pruned.
+     */
     prune(): Promise<void>;
+    /**
+     * Method that clears the memory and resets the movingSummaryBuffer.
+     * @returns Promise that resolves when the memory is cleared.
+     */
     clear(): Promise<void>;
 }

package/dist/memory/summary_buffer.js

@@ -1,5 +1,12 @@
 import { getBufferString, } from "./base.js";
 import { BaseConversationSummaryMemory, } from "./summary.js";
+/**
+ * Class that extends BaseConversationSummaryMemory and implements
+ * ConversationSummaryBufferMemoryInput. It manages the conversation
+ * history in a LangChain application by maintaining a buffer of chat
+ * messages and providing methods to load, save, prune, and clear the
+ * memory.
+ */
 export class ConversationSummaryBufferMemory extends BaseConversationSummaryMemory {
     constructor(fields) {
         super(fields);
@@ -20,6 +27,13 @@ export class ConversationSummaryBufferMemory extends BaseConversationSummaryMemo
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method that loads the chat messages from the memory and returns them as
+     * a string or as a list of messages, depending on the returnMessages
+     * property.
+     * @param _ InputValues object, not used in this method.
+     * @returns Promise that resolves with MemoryVariables object containing the loaded chat messages.
+     */
     async loadMemoryVariables(_) {
         let buffer = await this.chatHistory.getMessages();
         if (this.movingSummaryBuffer) {
@@ -37,10 +51,25 @@ export class ConversationSummaryBufferMemory extends BaseConversationSummaryMemo
         }
         return { [this.memoryKey]: finalBuffer };
     }
+    /**
+     * Method that saves the context of the conversation, including the input
+     * and output values, and prunes the memory if it exceeds the maximum
+     * token limit.
+     * @param inputValues InputValues object containing the input values of the conversation.
+     * @param outputValues OutputValues object containing the output values of the conversation.
+     * @returns Promise that resolves when the context is saved and the memory is pruned.
+     */
     async saveContext(inputValues, outputValues) {
         await super.saveContext(inputValues, outputValues);
         await this.prune();
     }
+    /**
+     * Method that prunes the memory if the total number of tokens in the
+     * buffer exceeds the maxTokenLimit. It removes messages from the
+     * beginning of the buffer until the total number of tokens is within the
+     * limit.
+     * @returns Promise that resolves when the memory is pruned.
+     */
     async prune() {
         // Prune buffer if it exceeds max token limit
         let buffer = await this.chatHistory.getMessages();
@@ -63,6 +92,10 @@ export class ConversationSummaryBufferMemory extends BaseConversationSummaryMemo
             this.movingSummaryBuffer = await this.predictNewSummary(prunedMemory, this.movingSummaryBuffer);
         }
     }
+    /**
+     * Method that clears the memory and resets the movingSummaryBuffer.
+     * @returns Promise that resolves when the memory is cleared.
+     */
     async clear() {
         await super.clear();
         this.movingSummaryBuffer = "";

package/dist/memory/vector_store.cjs

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VectorStoreRetrieverMemory = void 0;
 const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for managing long-term memory in Large Language Model (LLM)
+ * applications. It provides a way to persist and retrieve relevant
+ * documents from a vector store database, which can be useful for
+ * maintaining conversation history or other types of memory in an LLM
+ * application.
+ */
 class VectorStoreRetrieverMemory extends base_js_1.BaseMemory {
     constructor(fields) {
         super();
@@ -38,6 +45,13 @@ class VectorStoreRetrieverMemory extends base_js_1.BaseMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method to load memory variables. It uses the vectorStoreRetriever to
+     * get relevant documents based on the query obtained from the input
+     * values.
+     * @param values An InputValues object.
+     * @returns A Promise that resolves to a MemoryVariables object.
+     */
     async loadMemoryVariables(values) {
         const query = (0, base_js_1.getInputValue)(values, this.inputKey);
         const results = await this.vectorStoreRetriever.getRelevantDocuments(query);
@@ -47,6 +61,14 @@ class VectorStoreRetrieverMemory extends base_js_1.BaseMemory {
                 : results.map((r) => r.pageContent).join("\n"),
         };
     }
+    /**
+     * Method to save context. It constructs a document from the input and
+     * output values (excluding the memory key) and adds it to the vector
+     * store database using the vectorStoreRetriever.
+     * @param inputValues An InputValues object.
+     * @param outputValues An OutputValues object.
+     * @returns A Promise that resolves to void.
+     */
     async saveContext(inputValues, outputValues) {
         const text = Object.entries(inputValues)
             .filter(([k]) => k !== this.memoryKey)

package/dist/memory/vector_store.d.ts

@@ -1,5 +1,9 @@
 import { VectorStoreRetriever } from "../vectorstores/base.js";
 import { BaseMemory, InputValues, MemoryVariables, OutputValues } from "./base.js";
+/**
+ * Interface for the parameters required to initialize a
+ * VectorStoreRetrieverMemory instance.
+ */
 export interface VectorStoreRetrieverMemoryParams {
     vectorStoreRetriever: VectorStoreRetriever;
     inputKey?: string;
@@ -7,6 +11,13 @@ export interface VectorStoreRetrieverMemoryParams {
     memoryKey?: string;
     returnDocs?: boolean;
 }
+/**
+ * Class for managing long-term memory in Large Language Model (LLM)
+ * applications. It provides a way to persist and retrieve relevant
+ * documents from a vector store database, which can be useful for
+ * maintaining conversation history or other types of memory in an LLM
+ * application.
+ */
 export declare class VectorStoreRetrieverMemory extends BaseMemory implements VectorStoreRetrieverMemoryParams {
     vectorStoreRetriever: VectorStoreRetriever;
     inputKey?: string;
@@ -14,6 +25,21 @@ export declare class VectorStoreRetrieverMemory extends BaseMemory implements Ve
     returnDocs: boolean;
     constructor(fields: VectorStoreRetrieverMemoryParams);
     get memoryKeys(): string[];
+    /**
+     * Method to load memory variables. It uses the vectorStoreRetriever to
+     * get relevant documents based on the query obtained from the input
+     * values.
+     * @param values An InputValues object.
+     * @returns A Promise that resolves to a MemoryVariables object.
+     */
     loadMemoryVariables(values: InputValues): Promise<MemoryVariables>;
+    /**
+     * Method to save context. It constructs a document from the input and
+     * output values (excluding the memory key) and adds it to the vector
+     * store database using the vectorStoreRetriever.
+     * @param inputValues An InputValues object.
+     * @param outputValues An OutputValues object.
+     * @returns A Promise that resolves to void.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
 }

package/dist/memory/vector_store.js

@@ -1,5 +1,12 @@
 import { Document } from "../document.js";
 import { BaseMemory, getInputValue, } from "./base.js";
+/**
+ * Class for managing long-term memory in Large Language Model (LLM)
+ * applications. It provides a way to persist and retrieve relevant
+ * documents from a vector store database, which can be useful for
+ * maintaining conversation history or other types of memory in an LLM
+ * application.
+ */
 export class VectorStoreRetrieverMemory extends BaseMemory {
     constructor(fields) {
         super();
@@ -35,6 +42,13 @@ export class VectorStoreRetrieverMemory extends BaseMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method to load memory variables. It uses the vectorStoreRetriever to
+     * get relevant documents based on the query obtained from the input
+     * values.
+     * @param values An InputValues object.
+     * @returns A Promise that resolves to a MemoryVariables object.
+     */
     async loadMemoryVariables(values) {
         const query = getInputValue(values, this.inputKey);
         const results = await this.vectorStoreRetriever.getRelevantDocuments(query);
@@ -44,6 +58,14 @@ export class VectorStoreRetrieverMemory extends BaseMemory {
                 : results.map((r) => r.pageContent).join("\n"),
         };
     }
+    /**
+     * Method to save context. It constructs a document from the input and
+     * output values (excluding the memory key) and adds it to the vector
+     * store database using the vectorStoreRetriever.
+     * @param inputValues An InputValues object.
+     * @param outputValues An OutputValues object.
+     * @returns A Promise that resolves to void.
+     */
     async saveContext(inputValues, outputValues) {
         const text = Object.entries(inputValues)
             .filter(([k]) => k !== this.memoryKey)

package/dist/memory/zep.cjs

@@ -5,6 +5,12 @@ const zep_js_1 = require("@getzep/zep-js");
 const base_js_1 = require("./base.cjs");
 const chat_memory_js_1 = require("./chat_memory.cjs");
 const index_js_1 = require("../schema/index.cjs");
+/**
+ * Class used to manage the memory of a chat session, including loading
+ * and saving the chat history, and clearing the memory when needed. It
+ * uses the ZepClient to interact with the Zep service for managing the
+ * chat session's memory.
+ */
 class ZepMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {
         super({
@@ -64,6 +70,12 @@ class ZepMemory extends chat_memory_js_1.BaseChatMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method that retrieves the chat history from the Zep service and formats
+     * it into a list of messages.
+     * @param values Input values for the method.
+     * @returns Promise that resolves with the chat history formatted into a list of messages.
+     */
     async loadMemoryVariables(values) {
         // use either lastN provided by developer or undefined to use the
         // server preset.
@@ -116,6 +128,12 @@ class ZepMemory extends chat_memory_js_1.BaseChatMemory {
             [this.memoryKey]: (0, base_js_1.getBufferString)(messages, this.humanPrefix, this.aiPrefix),
         };
     }
+    /**
+     * Method that saves the input and output messages to the Zep service.
+     * @param inputValues Input messages to be saved.
+     * @param outputValues Output messages to be saved.
+     * @returns Promise that resolves when the messages have been 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);
@@ -149,6 +167,10 @@ class ZepMemory extends chat_memory_js_1.BaseChatMemory {
         // Call the superclass's saveContext method
         await super.saveContext(inputValues, outputValues);
     }
+    /**
+     * Method that deletes the chat history from the Zep service.
+     * @returns Promise that resolves when the chat history has been deleted.
+     */
     async clear() {
         // Wait for ZepClient to be initialized
         const zepClient = await this.zepClientPromise;

package/dist/memory/zep.d.ts

@@ -1,6 +1,11 @@
 import { ZepClient } from "@getzep/zep-js";
 import { InputValues, MemoryVariables, OutputValues } from "./base.js";
 import { BaseChatMemory, BaseChatMemoryInput } from "./chat_memory.js";
+/**
+ * Interface defining the structure of the input data for the ZepMemory
+ * class. It includes properties like humanPrefix, aiPrefix, memoryKey,
+ * baseURL, sessionId, and apiKey.
+ */
 export interface ZepMemoryInput extends BaseChatMemoryInput {
     humanPrefix?: string;
     aiPrefix?: string;
@@ -9,6 +14,12 @@ export interface ZepMemoryInput extends BaseChatMemoryInput {
     sessionId: string;
     apiKey?: string;
 }
+/**
+ * Class used to manage the memory of a chat session, including loading
+ * and saving the chat history, and clearing the memory when needed. It
+ * uses the ZepClient to interact with the Zep service for managing the
+ * chat session's memory.
+ */
 export declare class ZepMemory extends BaseChatMemory implements ZepMemoryInput {
     humanPrefix: string;
     aiPrefix: string;
@@ -19,7 +30,23 @@ export declare class ZepMemory extends BaseChatMemory implements ZepMemoryInput
     private readonly zepInitFailMsg;
     constructor(fields: ZepMemoryInput);
     get memoryKeys(): string[];
+    /**
+     * Method that retrieves the chat history from the Zep service and formats
+     * it into a list of messages.
+     * @param values Input values for the method.
+     * @returns Promise that resolves with the chat history formatted into a list of messages.
+     */
     loadMemoryVariables(values: InputValues): Promise<MemoryVariables>;
+    /**
+     * Method that saves the input and output messages to the Zep service.
+     * @param inputValues Input messages to be saved.
+     * @param outputValues Output messages to be saved.
+     * @returns Promise that resolves when the messages have been saved.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
+    /**
+     * Method that deletes the chat history from the Zep service.
+     * @returns Promise that resolves when the chat history has been deleted.
+     */
     clear(): Promise<void>;
 }

package/dist/memory/zep.js

@@ -2,6 +2,12 @@ import { Memory, Message, NotFoundError, ZepClient } from "@getzep/zep-js";
 import { getBufferString, getInputValue, getOutputValue, } from "./base.js";
 import { BaseChatMemory } from "./chat_memory.js";
 import { AIMessage, ChatMessage, HumanMessage, SystemMessage, } from "../schema/index.js";
+/**
+ * Class used to manage the memory of a chat session, including loading
+ * and saving the chat history, and clearing the memory when needed. It
+ * uses the ZepClient to interact with the Zep service for managing the
+ * chat session's memory.
+ */
 export class ZepMemory extends BaseChatMemory {
     constructor(fields) {
         super({
@@ -61,6 +67,12 @@ export class ZepMemory extends BaseChatMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Method that retrieves the chat history from the Zep service and formats
+     * it into a list of messages.
+     * @param values Input values for the method.
+     * @returns Promise that resolves with the chat history formatted into a list of messages.
+     */
     async loadMemoryVariables(values) {
         // use either lastN provided by developer or undefined to use the
         // server preset.
@@ -113,6 +125,12 @@ export class ZepMemory extends BaseChatMemory {
             [this.memoryKey]: getBufferString(messages, this.humanPrefix, this.aiPrefix),
         };
     }
+    /**
+     * Method that saves the input and output messages to the Zep service.
+     * @param inputValues Input messages to be saved.
+     * @param outputValues Output messages to be saved.
+     * @returns Promise that resolves when the messages have been saved.
+     */
     async saveContext(inputValues, outputValues) {
         const input = getInputValue(inputValues, this.inputKey);
         const output = getOutputValue(outputValues, this.outputKey);
@@ -146,6 +164,10 @@ export class ZepMemory extends BaseChatMemory {
         // Call the superclass's saveContext method
         await super.saveContext(inputValues, outputValues);
     }
+    /**
+     * Method that deletes the chat history from the Zep service.
+     * @returns Promise that resolves when the chat history has been deleted.
+     */
     async clear() {
         // Wait for ZepClient to be initialized
         const zepClient = await this.zepClientPromise;

package/dist/output_parsers/combining.cjs

@@ -7,6 +7,9 @@ const output_parser_js_1 = require("../schema/output_parser.cjs");
  * @augments BaseOutputParser
  */
 class CombiningOutputParser extends output_parser_js_1.BaseOutputParser {
+    static lc_name() {
+        return "CombiningOutputParser";
+    }
     constructor(fields, ...parsers) {
         if (parsers.length > 0 || !("parsers" in fields)) {
             // eslint-disable-next-line no-param-reassign
@@ -41,6 +44,13 @@ class CombiningOutputParser extends output_parser_js_1.BaseOutputParser {
         });
         this.parsers = fields.parsers;
     }
+    /**
+     * Method to parse an input string using the parsers in the parsers array.
+     * The parsed outputs are combined into a single object and returned.
+     * @param input The input string to parse.
+     * @param callbacks Optional Callbacks object.
+     * @returns A Promise that resolves to a CombinedOutput object.
+     */
     async parse(input, callbacks) {
         const inputs = input
             .trim()
@@ -65,6 +75,11 @@ class CombiningOutputParser extends output_parser_js_1.BaseOutputParser {
         }
         return ret;
     }
+    /**
+     * Method to get instructions on how to format the LLM output. The
+     * instructions are based on the parsers array and the outputDelimiter.
+     * @returns A string with format instructions.
+     */
     getFormatInstructions() {
         return `${[
             `Return the following ${this.parsers.length} outputs, each formatted as described below. Include the delimiter characters "${this.outputDelimiter}" in your response:`,

package/dist/output_parsers/combining.d.ts

@@ -1,6 +1,12 @@
 import { Callbacks } from "../callbacks/manager.js";
 import { BaseOutputParser } from "../schema/output_parser.js";
+/**
+ * Type for the combined output of the CombiningOutputParser class.
+ */
 export type CombinedOutput = Record<string, any>;
+/**
+ * Interface for the fields required by the CombiningOutputParser class.
+ */
 export interface CombiningOutputParserFields {
     parsers: BaseOutputParser[];
 }
@@ -9,12 +15,25 @@ export interface CombiningOutputParserFields {
  * @augments BaseOutputParser
  */
 export declare class CombiningOutputParser extends BaseOutputParser<object> {
+    static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
     parsers: BaseOutputParser[];
     outputDelimiter: string;
     constructor(fields: CombiningOutputParserFields);
     constructor(...parsers: BaseOutputParser[]);
+    /**
+     * Method to parse an input string using the parsers in the parsers array.
+     * The parsed outputs are combined into a single object and returned.
+     * @param input The input string to parse.
+     * @param callbacks Optional Callbacks object.
+     * @returns A Promise that resolves to a CombinedOutput object.
+     */
     parse(input: string, callbacks?: Callbacks): Promise<CombinedOutput>;
+    /**
+     * Method to get instructions on how to format the LLM output. The
+     * instructions are based on the parsers array and the outputDelimiter.
+     * @returns A string with format instructions.
+     */
     getFormatInstructions(): string;
 }

package/dist/output_parsers/combining.js

@@ -4,6 +4,9 @@ import { BaseOutputParser } from "../schema/output_parser.js";
  * @augments BaseOutputParser
  */
 export class CombiningOutputParser extends BaseOutputParser {
+    static lc_name() {
+        return "CombiningOutputParser";
+    }
     constructor(fields, ...parsers) {
         if (parsers.length > 0 || !("parsers" in fields)) {
             // eslint-disable-next-line no-param-reassign
@@ -38,6 +41,13 @@ export class CombiningOutputParser extends BaseOutputParser {
         });
         this.parsers = fields.parsers;
     }
+    /**
+     * Method to parse an input string using the parsers in the parsers array.
+     * The parsed outputs are combined into a single object and returned.
+     * @param input The input string to parse.
+     * @param callbacks Optional Callbacks object.
+     * @returns A Promise that resolves to a CombinedOutput object.
+     */
     async parse(input, callbacks) {
         const inputs = input
             .trim()
@@ -62,6 +72,11 @@ export class CombiningOutputParser extends BaseOutputParser {
         }
         return ret;
     }
+    /**
+     * Method to get instructions on how to format the LLM output. The
+     * instructions are based on the parsers array and the outputDelimiter.
+     * @returns A string with format instructions.
+     */
     getFormatInstructions() {
         return `${[
             `Return the following ${this.parsers.length} outputs, each formatted as described below. Include the delimiter characters "${this.outputDelimiter}" in your response:`,

package/dist/output_parsers/expression.cjs

@@ -63,6 +63,13 @@ class ExpressionParser extends output_parser_js_1.BaseOutputParser {
             this.parser = await base_js_1.ASTParser.importASTParser();
         }
     }
+    /**
+     * Parses the given text. It first ensures the parser is loaded, then
+     * tries to parse the text. If the parsing fails, it throws an error. If
+     * the parsing is successful, it returns the parsed expression.
+     * @param text The text to be parsed.
+     * @returns The parsed expression
+     */
     async parse(text) {
         await this.ensureParser();
         try {
@@ -82,6 +89,11 @@ class ExpressionParser extends output_parser_js_1.BaseOutputParser {
             throw new Error(`Error parsing ${err}: ${text}`);
         }
     }
+    /**
+     * This method is currently empty, but it could be used to provide
+     * instructions on the format of the input text.
+     * @returns string
+     */
     getFormatInstructions() {
         return "";
     }

package/dist/output_parsers/expression.d.ts

@@ -28,7 +28,19 @@ export declare class ExpressionParser extends BaseOutputParser<ParsedType> {
      * subsequent calls. See expression.test.ts for an example.
      */
     ensureParser(): Promise<void>;
+    /**
+     * Parses the given text. It first ensures the parser is loaded, then
+     * tries to parse the text. If the parsing fails, it throws an error. If
+     * the parsing is successful, it returns the parsed expression.
+     * @param text The text to be parsed.
+     * @returns The parsed expression
+     */
     parse(text: string): Promise<ParsedType>;
+    /**
+     * This method is currently empty, but it could be used to provide
+     * instructions on the format of the input text.
+     * @returns string
+     */
     getFormatInstructions(): string;
 }
 export * from "./expression_type_handlers/types.js";

package/dist/output_parsers/expression.js

@@ -46,6 +46,13 @@ export class ExpressionParser extends BaseOutputParser {
             this.parser = await ASTParser.importASTParser();
         }
     }
+    /**
+     * Parses the given text. It first ensures the parser is loaded, then
+     * tries to parse the text. If the parsing fails, it throws an error. If
+     * the parsing is successful, it returns the parsed expression.
+     * @param text The text to be parsed.
+     * @returns The parsed expression
+     */
     async parse(text) {
         await this.ensureParser();
         try {
@@ -65,6 +72,11 @@ export class ExpressionParser extends BaseOutputParser {
             throw new Error(`Error parsing ${err}: ${text}`);
         }
     }
+    /**
+     * This method is currently empty, but it could be used to provide
+     * instructions on the format of the input text.
+     * @returns string
+     */
     getFormatInstructions() {
         return "";
     }