langchain 0.0.131 → 0.0.132

package/dist/output_parsers/fix.cjs

@@ -4,10 +4,23 @@ exports.OutputFixingParser = void 0;
 const output_parser_js_1 = require("../schema/output_parser.cjs");
 const llm_chain_js_1 = require("../chains/llm_chain.cjs");
 const prompts_js_1 = require("./prompts.cjs");
+/**
+ * Class that extends the BaseOutputParser to handle situations where the
+ * initial parsing attempt fails. It contains a retryChain for retrying
+ * the parsing process in case of a failure.
+ */
 class OutputFixingParser extends output_parser_js_1.BaseOutputParser {
     static lc_name() {
         return "OutputFixingParser";
     }
+    /**
+     * Static method to create a new instance of OutputFixingParser using a
+     * given language model, parser, and optional fields.
+     * @param llm The language model to be used.
+     * @param parser The parser to be used.
+     * @param fields Optional fields which may contain a prompt.
+     * @returns A new instance of OutputFixingParser.
+     */
     static fromLLM(llm, parser, fields) {
         const prompt = fields?.prompt ?? prompts_js_1.NAIVE_FIX_PROMPT;
         const chain = new llm_chain_js_1.LLMChain({ llm, prompt });
@@ -42,6 +55,14 @@ class OutputFixingParser extends output_parser_js_1.BaseOutputParser {
         this.parser = parser;
         this.retryChain = retryChain;
     }
+    /**
+     * Method to parse the completion using the parser. If the initial parsing
+     * fails, it uses the retryChain to attempt to fix the output and retry
+     * the parsing process.
+     * @param completion The completion to be parsed.
+     * @param callbacks Optional callbacks to be used during parsing.
+     * @returns The parsed output.
+     */
     async parse(completion, callbacks) {
         try {
             return await this.parser.parse(completion, callbacks);
@@ -60,6 +81,10 @@ class OutputFixingParser extends output_parser_js_1.BaseOutputParser {
             throw e;
         }
     }
+    /**
+     * Method to get the format instructions for the parser.
+     * @returns The format instructions for the parser.
+     */
     getFormatInstructions() {
         return this.parser.getFormatInstructions();
     }

package/dist/output_parsers/fix.d.ts

@@ -3,12 +3,25 @@ import { BasePromptTemplate } from "../prompts/base.js";
 import { LLMChain } from "../chains/llm_chain.js";
 import { BaseLanguageModel } from "../base_language/index.js";
 import { Callbacks } from "../callbacks/manager.js";
+/**
+ * Class that extends the BaseOutputParser to handle situations where the
+ * initial parsing attempt fails. It contains a retryChain for retrying
+ * the parsing process in case of a failure.
+ */
 export declare class OutputFixingParser<T> extends BaseOutputParser<T> {
     static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
     parser: BaseOutputParser<T>;
     retryChain: LLMChain;
+    /**
+     * Static method to create a new instance of OutputFixingParser using a
+     * given language model, parser, and optional fields.
+     * @param llm The language model to be used.
+     * @param parser The parser to be used.
+     * @param fields Optional fields which may contain a prompt.
+     * @returns A new instance of OutputFixingParser.
+     */
     static fromLLM<T>(llm: BaseLanguageModel, parser: BaseOutputParser<T>, fields?: {
         prompt?: BasePromptTemplate;
     }): OutputFixingParser<T>;
@@ -16,6 +29,18 @@ export declare class OutputFixingParser<T> extends BaseOutputParser<T> {
         parser: BaseOutputParser<T>;
         retryChain: LLMChain;
     });
+    /**
+     * Method to parse the completion using the parser. If the initial parsing
+     * fails, it uses the retryChain to attempt to fix the output and retry
+     * the parsing process.
+     * @param completion The completion to be parsed.
+     * @param callbacks Optional callbacks to be used during parsing.
+     * @returns The parsed output.
+     */
     parse(completion: string, callbacks?: Callbacks): Promise<T>;
+    /**
+     * Method to get the format instructions for the parser.
+     * @returns The format instructions for the parser.
+     */
     getFormatInstructions(): string;
 }

package/dist/output_parsers/fix.js

@@ -1,10 +1,23 @@
 import { BaseOutputParser, OutputParserException, } from "../schema/output_parser.js";
 import { LLMChain } from "../chains/llm_chain.js";
 import { NAIVE_FIX_PROMPT } from "./prompts.js";
+/**
+ * Class that extends the BaseOutputParser to handle situations where the
+ * initial parsing attempt fails. It contains a retryChain for retrying
+ * the parsing process in case of a failure.
+ */
 export class OutputFixingParser extends BaseOutputParser {
     static lc_name() {
         return "OutputFixingParser";
     }
+    /**
+     * Static method to create a new instance of OutputFixingParser using a
+     * given language model, parser, and optional fields.
+     * @param llm The language model to be used.
+     * @param parser The parser to be used.
+     * @param fields Optional fields which may contain a prompt.
+     * @returns A new instance of OutputFixingParser.
+     */
     static fromLLM(llm, parser, fields) {
         const prompt = fields?.prompt ?? NAIVE_FIX_PROMPT;
         const chain = new LLMChain({ llm, prompt });
@@ -39,6 +52,14 @@ export class OutputFixingParser extends BaseOutputParser {
         this.parser = parser;
         this.retryChain = retryChain;
     }
+    /**
+     * Method to parse the completion using the parser. If the initial parsing
+     * fails, it uses the retryChain to attempt to fix the output and retry
+     * the parsing process.
+     * @param completion The completion to be parsed.
+     * @param callbacks Optional callbacks to be used during parsing.
+     * @returns The parsed output.
+     */
     async parse(completion, callbacks) {
         try {
             return await this.parser.parse(completion, callbacks);
@@ -57,6 +78,10 @@ export class OutputFixingParser extends BaseOutputParser {
             throw e;
         }
     }
+    /**
+     * Method to get the format instructions for the parser.
+     * @returns The format instructions for the parser.
+     */
     getFormatInstructions() {
         return this.parser.getFormatInstructions();
     }

package/dist/output_parsers/list.cjs

@@ -32,6 +32,12 @@ class CommaSeparatedListOutputParser extends ListOutputParser {
     static lc_name() {
         return "CommaSeparatedListOutputParser";
     }
+    /**
+     * Parses the given text into an array of strings, using a comma as the
+     * separator. If the parsing fails, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each comma.
+     */
     async parse(text) {
         try {
             return text
@@ -43,6 +49,11 @@ class CommaSeparatedListOutputParser extends ListOutputParser {
             throw new output_parser_js_1.OutputParserException(`Could not parse output: ${text}`, text);
         }
     }
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CommaSeparatedListOutputParser.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions() {
         return `Your response should be a list of comma separated values, eg: \`foo, bar, baz\``;
     }
@@ -76,6 +87,13 @@ class CustomListOutputParser extends ListOutputParser {
         this.length = length;
         this.separator = separator || ",";
     }
+    /**
+     * Parses the given text into an array of strings, using the specified
+     * separator. If the parsing fails or the number of items in the list
+     * doesn't match the expected length, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each occurrence of the specified separator.
+     */
     async parse(text) {
         try {
             const items = text
@@ -94,6 +112,12 @@ class CustomListOutputParser extends ListOutputParser {
             throw new output_parser_js_1.OutputParserException(`Could not parse output: ${text}`);
         }
     }
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CustomListOutputParser, including the number of items and the
+     * separator.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions() {
         return `Your response should be a list of ${this.length} items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
     }

package/dist/output_parsers/list.d.ts

@@ -13,7 +13,18 @@ export declare class CommaSeparatedListOutputParser extends ListOutputParser {
     static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
+    /**
+     * Parses the given text into an array of strings, using a comma as the
+     * separator. If the parsing fails, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each comma.
+     */
     parse(text: string): Promise<string[]>;
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CommaSeparatedListOutputParser.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions(): string;
 }
 /**
@@ -28,6 +39,19 @@ export declare class CustomListOutputParser extends ListOutputParser {
         length?: number;
         separator?: string;
     });
+    /**
+     * Parses the given text into an array of strings, using the specified
+     * separator. If the parsing fails or the number of items in the list
+     * doesn't match the expected length, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each occurrence of the specified separator.
+     */
     parse(text: string): Promise<string[]>;
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CustomListOutputParser, including the number of items and the
+     * separator.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions(): string;
 }

package/dist/output_parsers/list.js

@@ -28,6 +28,12 @@ export class CommaSeparatedListOutputParser extends ListOutputParser {
     static lc_name() {
         return "CommaSeparatedListOutputParser";
     }
+    /**
+     * Parses the given text into an array of strings, using a comma as the
+     * separator. If the parsing fails, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each comma.
+     */
     async parse(text) {
         try {
             return text
@@ -39,6 +45,11 @@ export class CommaSeparatedListOutputParser extends ListOutputParser {
             throw new OutputParserException(`Could not parse output: ${text}`, text);
         }
     }
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CommaSeparatedListOutputParser.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions() {
         return `Your response should be a list of comma separated values, eg: \`foo, bar, baz\``;
     }
@@ -71,6 +82,13 @@ export class CustomListOutputParser extends ListOutputParser {
         this.length = length;
         this.separator = separator || ",";
     }
+    /**
+     * Parses the given text into an array of strings, using the specified
+     * separator. If the parsing fails or the number of items in the list
+     * doesn't match the expected length, throws an OutputParserException.
+     * @param text The text to parse.
+     * @returns An array of strings obtained by splitting the input text at each occurrence of the specified separator.
+     */
     async parse(text) {
         try {
             const items = text
@@ -89,6 +107,12 @@ export class CustomListOutputParser extends ListOutputParser {
             throw new OutputParserException(`Could not parse output: ${text}`);
         }
     }
+    /**
+     * Provides instructions on the expected format of the response for the
+     * CustomListOutputParser, including the number of items and the
+     * separator.
+     * @returns A string containing instructions on the expected format of the response.
+     */
     getFormatInstructions() {
         return `Your response should be a list of ${this.length} items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
     }

package/dist/output_parsers/noop.cjs

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoOpOutputParser = void 0;
 const output_parser_js_1 = require("../schema/output_parser.cjs");
+/**
+ * The NoOpOutputParser class is a type of output parser that does not
+ * perform any operations on the output. It extends the BaseOutputParser
+ * class and is part of the LangChain's output parsers module. This class
+ * is useful in scenarios where the raw output of the Large Language
+ * Models (LLMs) is required.
+ */
 class NoOpOutputParser extends output_parser_js_1.BaseOutputParser {
     constructor() {
         super(...arguments);
@@ -21,9 +28,20 @@ class NoOpOutputParser extends output_parser_js_1.BaseOutputParser {
     static lc_name() {
         return "NoOpOutputParser";
     }
+    /**
+     * This method takes a string as input and returns the same string as
+     * output. It does not perform any operations on the input string.
+     * @param text The input string to be parsed.
+     * @returns The same input string without any operations performed on it.
+     */
     parse(text) {
         return Promise.resolve(text);
     }
+    /**
+     * This method returns an empty string. It does not provide any formatting
+     * instructions.
+     * @returns An empty string, indicating no formatting instructions.
+     */
     getFormatInstructions() {
         return "";
     }

package/dist/output_parsers/noop.d.ts

@@ -1,8 +1,26 @@
 import { BaseOutputParser } from "../schema/output_parser.js";
+/**
+ * The NoOpOutputParser class is a type of output parser that does not
+ * perform any operations on the output. It extends the BaseOutputParser
+ * class and is part of the LangChain's output parsers module. This class
+ * is useful in scenarios where the raw output of the Large Language
+ * Models (LLMs) is required.
+ */
 export declare class NoOpOutputParser extends BaseOutputParser<string> {
     static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
+    /**
+     * This method takes a string as input and returns the same string as
+     * output. It does not perform any operations on the input string.
+     * @param text The input string to be parsed.
+     * @returns The same input string without any operations performed on it.
+     */
     parse(text: string): Promise<string>;
+    /**
+     * This method returns an empty string. It does not provide any formatting
+     * instructions.
+     * @returns An empty string, indicating no formatting instructions.
+     */
     getFormatInstructions(): string;
 }

package/dist/output_parsers/noop.js

@@ -1,4 +1,11 @@
 import { BaseOutputParser } from "../schema/output_parser.js";
+/**
+ * The NoOpOutputParser class is a type of output parser that does not
+ * perform any operations on the output. It extends the BaseOutputParser
+ * class and is part of the LangChain's output parsers module. This class
+ * is useful in scenarios where the raw output of the Large Language
+ * Models (LLMs) is required.
+ */
 export class NoOpOutputParser extends BaseOutputParser {
     constructor() {
         super(...arguments);
@@ -18,9 +25,20 @@ export class NoOpOutputParser extends BaseOutputParser {
     static lc_name() {
         return "NoOpOutputParser";
     }
+    /**
+     * This method takes a string as input and returns the same string as
+     * output. It does not perform any operations on the input string.
+     * @param text The input string to be parsed.
+     * @returns The same input string without any operations performed on it.
+     */
     parse(text) {
         return Promise.resolve(text);
     }
+    /**
+     * This method returns an empty string. It does not provide any formatting
+     * instructions.
+     * @returns An empty string, indicating no formatting instructions.
+     */
     getFormatInstructions() {
         return "";
     }

package/dist/output_parsers/openai_functions.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonKeyOutputFunctionsParser = exports.JsonOutputFunctionsParser = exports.OutputFunctionsParser = void 0;
 const output_parser_js_1 = require("../schema/output_parser.cjs");
+/**
+ * Class for parsing the output of an LLM. Can be configured to return
+ * only the arguments of the function call in the output.
+ */
 class OutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
     static lc_name() {
         return "OutputFunctionsParser";
@@ -28,6 +32,12 @@ class OutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
         });
         this.argsOnly = config?.argsOnly ?? this.argsOnly;
     }
+    /**
+     * Parses the output and returns a string representation of the function
+     * call or its arguments.
+     * @param generations The output of the LLM to parse.
+     * @returns A string representation of the function call or its arguments.
+     */
     async parseResult(generations) {
         if ("message" in generations[0]) {
             const gen = generations[0];
@@ -49,6 +59,10 @@ class OutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
     }
 }
 exports.OutputFunctionsParser = OutputFunctionsParser;
+/**
+ * Class for parsing the output of an LLM into a JSON object. Uses an
+ * instance of `OutputFunctionsParser` to parse the output.
+ */
 class JsonOutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
     static lc_name() {
         return "JsonOutputFunctionsParser";
@@ -82,6 +96,12 @@ class JsonOutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
         this.argsOnly = config?.argsOnly ?? this.argsOnly;
         this.outputParser = new OutputFunctionsParser(config);
     }
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
     async parseResult(generations) {
         const result = await this.outputParser.parseResult(generations);
         if (!result) {
@@ -96,6 +116,11 @@ class JsonOutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
     }
 }
 exports.JsonOutputFunctionsParser = JsonOutputFunctionsParser;
+/**
+ * Class for parsing the output of an LLM into a JSON object and returning
+ * a specific attribute. Uses an instance of `JsonOutputFunctionsParser`
+ * to parse the output.
+ */
 class JsonKeyOutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParser {
     static lc_name() {
         return "JsonKeyOutputFunctionsParser";
@@ -128,6 +153,12 @@ class JsonKeyOutputFunctionsParser extends output_parser_js_1.BaseLLMOutputParse
         });
         this.attrName = fields.attrName;
     }
+    /**
+     * Parses the output and returns a specific attribute of the parsed JSON
+     * object.
+     * @param generations The output of the LLM to parse.
+     * @returns The value of a specific attribute of the parsed JSON object.
+     */
     async parseResult(generations) {
         const result = await this.outputParser.parseResult(generations);
         return result[this.attrName];

package/dist/output_parsers/openai_functions.d.ts

@@ -2,7 +2,14 @@ import { JsonSchema7ObjectType } from "zod-to-json-schema/src/parsers/object.js"
 import { ChatGeneration, Generation } from "../schema/index.js";
 import { Optional } from "../types/type-utils.js";
 import { BaseLLMOutputParser } from "../schema/output_parser.js";
+/**
+ * Represents optional parameters for a function in a JSON Schema.
+ */
 export type FunctionParameters = Optional<JsonSchema7ObjectType, "additionalProperties">;
+/**
+ * Class for parsing the output of an LLM. Can be configured to return
+ * only the arguments of the function call in the output.
+ */
 export declare class OutputFunctionsParser extends BaseLLMOutputParser<string> {
     static lc_name(): string;
     lc_namespace: string[];
@@ -11,8 +18,18 @@ export declare class OutputFunctionsParser extends BaseLLMOutputParser<string> {
     constructor(config?: {
         argsOnly: boolean;
     });
+    /**
+     * Parses the output and returns a string representation of the function
+     * call or its arguments.
+     * @param generations The output of the LLM to parse.
+     * @returns A string representation of the function call or its arguments.
+     */
     parseResult(generations: Generation[] | ChatGeneration[]): Promise<string>;
 }
+/**
+ * Class for parsing the output of an LLM into a JSON object. Uses an
+ * instance of `OutputFunctionsParser` to parse the output.
+ */
 export declare class JsonOutputFunctionsParser extends BaseLLMOutputParser<object> {
     static lc_name(): string;
     lc_namespace: string[];
@@ -22,8 +39,19 @@ export declare class JsonOutputFunctionsParser extends BaseLLMOutputParser<objec
     constructor(config?: {
         argsOnly: boolean;
     });
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
     parseResult(generations: Generation[] | ChatGeneration[]): Promise<object>;
 }
+/**
+ * Class for parsing the output of an LLM into a JSON object and returning
+ * a specific attribute. Uses an instance of `JsonOutputFunctionsParser`
+ * to parse the output.
+ */
 export declare class JsonKeyOutputFunctionsParser<T = object> extends BaseLLMOutputParser<T> {
     static lc_name(): string;
     lc_namespace: string[];
@@ -33,5 +61,11 @@ export declare class JsonKeyOutputFunctionsParser<T = object> extends BaseLLMOut
     constructor(fields: {
         attrName: string;
     });
+    /**
+     * Parses the output and returns a specific attribute of the parsed JSON
+     * object.
+     * @param generations The output of the LLM to parse.
+     * @returns The value of a specific attribute of the parsed JSON object.
+     */
     parseResult(generations: Generation[] | ChatGeneration[]): Promise<T>;
 }

package/dist/output_parsers/openai_functions.js

@@ -1,4 +1,8 @@
 import { BaseLLMOutputParser } from "../schema/output_parser.js";
+/**
+ * Class for parsing the output of an LLM. Can be configured to return
+ * only the arguments of the function call in the output.
+ */
 export class OutputFunctionsParser extends BaseLLMOutputParser {
     static lc_name() {
         return "OutputFunctionsParser";
@@ -25,6 +29,12 @@ export class OutputFunctionsParser extends BaseLLMOutputParser {
         });
         this.argsOnly = config?.argsOnly ?? this.argsOnly;
     }
+    /**
+     * Parses the output and returns a string representation of the function
+     * call or its arguments.
+     * @param generations The output of the LLM to parse.
+     * @returns A string representation of the function call or its arguments.
+     */
     async parseResult(generations) {
         if ("message" in generations[0]) {
             const gen = generations[0];
@@ -45,6 +55,10 @@ export class OutputFunctionsParser extends BaseLLMOutputParser {
         }
     }
 }
+/**
+ * Class for parsing the output of an LLM into a JSON object. Uses an
+ * instance of `OutputFunctionsParser` to parse the output.
+ */
 export class JsonOutputFunctionsParser extends BaseLLMOutputParser {
     static lc_name() {
         return "JsonOutputFunctionsParser";
@@ -78,6 +92,12 @@ export class JsonOutputFunctionsParser extends BaseLLMOutputParser {
         this.argsOnly = config?.argsOnly ?? this.argsOnly;
         this.outputParser = new OutputFunctionsParser(config);
     }
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
     async parseResult(generations) {
         const result = await this.outputParser.parseResult(generations);
         if (!result) {
@@ -91,6 +111,11 @@ export class JsonOutputFunctionsParser extends BaseLLMOutputParser {
         return parsedResult;
     }
 }
+/**
+ * Class for parsing the output of an LLM into a JSON object and returning
+ * a specific attribute. Uses an instance of `JsonOutputFunctionsParser`
+ * to parse the output.
+ */
 export class JsonKeyOutputFunctionsParser extends BaseLLMOutputParser {
     static lc_name() {
         return "JsonKeyOutputFunctionsParser";
@@ -123,6 +148,12 @@ export class JsonKeyOutputFunctionsParser extends BaseLLMOutputParser {
         });
         this.attrName = fields.attrName;
     }
+    /**
+     * Parses the output and returns a specific attribute of the parsed JSON
+     * object.
+     * @param generations The output of the LLM to parse.
+     * @returns The value of a specific attribute of the parsed JSON object.
+     */
     async parseResult(generations) {
         const result = await this.outputParser.parseResult(generations);
         return result[this.attrName];

package/dist/output_parsers/regex.cjs

@@ -73,6 +73,13 @@ class RegexParser extends output_parser_js_1.BaseOutputParser {
     _type() {
         return "regex_parser";
     }
+    /**
+     * Parses the given text using the regex pattern and returns a dictionary
+     * with the parsed output. If the regex pattern does not match the text
+     * and no defaultOutputKey is provided, throws an OutputParserException.
+     * @param text The text to be parsed.
+     * @returns A dictionary with the parsed output.
+     */
     async parse(text) {
         const match = text.match(this.regex);
         if (match) {
@@ -89,6 +96,11 @@ class RegexParser extends output_parser_js_1.BaseOutputParser {
             return acc;
         }, {});
     }
+    /**
+     * Returns a string with instructions on how the LLM output should be
+     * formatted to match the regex pattern.
+     * @returns A string with formatting instructions.
+     */
     getFormatInstructions() {
         return `Your response should match the following regex: ${this.regex}`;
     }

package/dist/output_parsers/regex.d.ts

@@ -4,6 +4,9 @@ export interface RegExpFields {
     pattern: string;
     flags?: string;
 }
+/**
+ * Interface for the fields required to create a RegexParser instance.
+ */
 export interface RegexParserFields {
     regex: string | RegExp | RegExpFields;
     outputKeys: string[];
@@ -24,6 +27,18 @@ export declare class RegexParser extends BaseOutputParser<Record<string, string>
     constructor(fields: RegexParserFields);
     constructor(regex: string | RegExp, outputKeys: string[], defaultOutputKey?: string);
     _type(): string;
+    /**
+     * Parses the given text using the regex pattern and returns a dictionary
+     * with the parsed output. If the regex pattern does not match the text
+     * and no defaultOutputKey is provided, throws an OutputParserException.
+     * @param text The text to be parsed.
+     * @returns A dictionary with the parsed output.
+     */
     parse(text: string): Promise<Record<string, string>>;
+    /**
+     * Returns a string with instructions on how the LLM output should be
+     * formatted to match the regex pattern.
+     * @returns A string with formatting instructions.
+     */
     getFormatInstructions(): string;
 }

package/dist/output_parsers/regex.js

@@ -70,6 +70,13 @@ export class RegexParser extends BaseOutputParser {
     _type() {
         return "regex_parser";
     }
+    /**
+     * Parses the given text using the regex pattern and returns a dictionary
+     * with the parsed output. If the regex pattern does not match the text
+     * and no defaultOutputKey is provided, throws an OutputParserException.
+     * @param text The text to be parsed.
+     * @returns A dictionary with the parsed output.
+     */
     async parse(text) {
         const match = text.match(this.regex);
         if (match) {
@@ -86,6 +93,11 @@ export class RegexParser extends BaseOutputParser {
             return acc;
         }, {});
     }
+    /**
+     * Returns a string with instructions on how the LLM output should be
+     * formatted to match the regex pattern.
+     * @returns A string with formatting instructions.
+     */
     getFormatInstructions() {
         return `Your response should match the following regex: ${this.regex}`;
     }