langchain 0.0.131 → 0.0.132

package/dist/agents/agent.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Agent = exports.LLMSingleActionAgent = exports.BaseMultiActionAgent = exports.BaseSingleActionAgent = exports.BaseAgent = void 0;
 const serializable_js_1 = require("../load/serializable.cjs");
+/**
+ * Error class for parse errors in LangChain. Contains information about
+ * the error message and the output that caused the error.
+ */
 class ParseError extends Error {
     constructor(msg, output) {
         super(msg);
@@ -14,6 +18,10 @@ class ParseError extends Error {
         this.output = output;
     }
 }
+/**
+ * Abstract base class for agents in LangChain. Provides common
+ * functionality for agents, such as handling inputs and outputs.
+ */
 class BaseAgent extends serializable_js_1.Serializable {
     get returnValues() {
         return ["output"];
@@ -47,18 +55,33 @@ class BaseAgent extends serializable_js_1.Serializable {
     }
 }
 exports.BaseAgent = BaseAgent;
+/**
+ * Abstract base class for single action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * single action agents.
+ */
 class BaseSingleActionAgent extends BaseAgent {
     _agentActionType() {
         return "single";
     }
 }
 exports.BaseSingleActionAgent = BaseSingleActionAgent;
+/**
+ * Abstract base class for multi-action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * multi-action agents.
+ */
 class BaseMultiActionAgent extends BaseAgent {
     _agentActionType() {
         return "multi";
     }
 }
 exports.BaseMultiActionAgent = BaseMultiActionAgent;
+/**
+ * Class representing a single action agent using a LLMChain in LangChain.
+ * Extends the BaseSingleActionAgent class and provides methods for
+ * planning agent actions based on LLMChain outputs.
+ */
 class LLMSingleActionAgent extends BaseSingleActionAgent {
     constructor(input) {
         super(input);

package/dist/agents/agent.d.ts

@@ -6,7 +6,14 @@ import { AgentAction, AgentFinish, AgentStep, BaseMessage, ChainValues } from ".
 import { Serializable } from "../load/serializable.js";
 import { StructuredTool, Tool } from "../tools/base.js";
 import { AgentActionOutputParser, AgentInput, SerializedAgent, StoppingMethod } from "./types.js";
+/**
+ * Record type for arguments passed to output parsers.
+ */
 export type OutputParserArgs = Record<string, any>;
+/**
+ * Abstract base class for agents in LangChain. Provides common
+ * functionality for agents, such as handling inputs and outputs.
+ */
 export declare abstract class BaseAgent extends Serializable {
     ToolType: StructuredTool;
     abstract get inputKeys(): string[];
@@ -29,6 +36,11 @@ export declare abstract class BaseAgent extends Serializable {
      */
     prepareForOutput(_returnValues: AgentFinish["returnValues"], _steps: AgentStep[]): Promise<AgentFinish["returnValues"]>;
 }
+/**
+ * Abstract base class for single action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * single action agents.
+ */
 export declare abstract class BaseSingleActionAgent extends BaseAgent {
     _agentActionType(): string;
     /**
@@ -42,6 +54,11 @@ export declare abstract class BaseSingleActionAgent extends BaseAgent {
      */
     abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction | AgentFinish>;
 }
+/**
+ * Abstract base class for multi-action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * multi-action agents.
+ */
 export declare abstract class BaseMultiActionAgent extends BaseAgent {
     _agentActionType(): string;
     /**
@@ -55,11 +72,19 @@ export declare abstract class BaseMultiActionAgent extends BaseAgent {
      */
     abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction[] | AgentFinish>;
 }
+/**
+ * Interface for input data for creating a LLMSingleActionAgent.
+ */
 export interface LLMSingleActionAgentInput {
     llmChain: LLMChain;
     outputParser: AgentActionOutputParser;
     stop?: string[];
 }
+/**
+ * Class representing a single action agent using a LLMChain in LangChain.
+ * Extends the BaseSingleActionAgent class and provides methods for
+ * planning agent actions based on LLMChain outputs.
+ */
 export declare class LLMSingleActionAgent extends BaseSingleActionAgent {
     lc_namespace: string[];
     llmChain: LLMChain;
@@ -78,6 +103,9 @@ export declare class LLMSingleActionAgent extends BaseSingleActionAgent {
      */
     plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction | AgentFinish>;
 }
+/**
+ * Interface for arguments used to create an agent in LangChain.
+ */
 export interface AgentArgs {
     outputParser?: AgentActionOutputParser;
     callbacks?: Callbacks;

package/dist/agents/agent.js

@@ -1,4 +1,8 @@
 import { Serializable } from "../load/serializable.js";
+/**
+ * Error class for parse errors in LangChain. Contains information about
+ * the error message and the output that caused the error.
+ */
 class ParseError extends Error {
     constructor(msg, output) {
         super(msg);
@@ -11,6 +15,10 @@ class ParseError extends Error {
         this.output = output;
     }
 }
+/**
+ * Abstract base class for agents in LangChain. Provides common
+ * functionality for agents, such as handling inputs and outputs.
+ */
 export class BaseAgent extends Serializable {
     get returnValues() {
         return ["output"];
@@ -43,16 +51,31 @@ export class BaseAgent extends Serializable {
         return {};
     }
 }
+/**
+ * Abstract base class for single action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * single action agents.
+ */
 export class BaseSingleActionAgent extends BaseAgent {
     _agentActionType() {
         return "single";
     }
 }
+/**
+ * Abstract base class for multi-action agents in LangChain. Extends the
+ * BaseAgent class and provides additional functionality specific to
+ * multi-action agents.
+ */
 export class BaseMultiActionAgent extends BaseAgent {
     _agentActionType() {
         return "multi";
     }
 }
+/**
+ * Class representing a single action agent using a LLMChain in LangChain.
+ * Extends the BaseSingleActionAgent class and provides methods for
+ * planning agent actions based on LLMChain outputs.
+ */
 export class LLMSingleActionAgent extends BaseSingleActionAgent {
     constructor(input) {
         super(input);

package/dist/agents/chat/index.cjs

@@ -37,6 +37,12 @@ class ChatAgent extends agent_js_1.Agent {
     _stop() {
         return ["Observation:"];
     }
+    /**
+     * Validates that all tools have descriptions. Throws an error if a tool
+     * without a description is found.
+     * @param tools Array of Tool instances to validate.
+     * @returns void
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -45,9 +51,20 @@ class ChatAgent extends agent_js_1.Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Returns a default output parser for the ChatAgent.
+     * @param _fields Optional OutputParserArgs to customize the output parser.
+     * @returns ChatAgentOutputParser instance
+     */
     static getDefaultOutputParser(_fields) {
         return new outputParser_js_1.ChatAgentOutputParser();
     }
+    /**
+     * Constructs the agent's scratchpad, which is a string representation of
+     * the agent's previous steps.
+     * @param steps Array of AgentStep instances representing the agent's previous steps.
+     * @returns Promise resolving to a string representing the agent's scratchpad.
+     */
     async constructScratchPad(steps) {
         const agentScratchpad = await super.constructScratchPad(steps);
         if (agentScratchpad) {
@@ -76,6 +93,14 @@ class ChatAgent extends agent_js_1.Agent {
         ];
         return chat_js_1.ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates a ChatAgent instance using a language model, tools, and
+     * optional arguments.
+     * @param llm BaseLanguageModel instance to use in the agent.
+     * @param tools Array of Tool instances to include in the agent.
+     * @param args Optional arguments to customize the agent and prompt.
+     * @returns ChatAgent instance
+     */
     static fromLLMAndTools(llm, tools, args) {
         ChatAgent.validateTools(tools);
         const prompt = ChatAgent.createPrompt(tools, args);

package/dist/agents/chat/index.d.ts

@@ -6,6 +6,9 @@ import { Optional } from "../../types/type-utils.js";
 import { Agent, AgentArgs, OutputParserArgs } from "../agent.js";
 import { AgentInput } from "../types.js";
 import { ChatAgentOutputParser } from "./outputParser.js";
+/**
+ * Interface for arguments used to create a chat prompt.
+ */
 export interface ChatCreatePromptArgs {
     /** String to put after the list of tools. */
     suffix?: string;
@@ -16,6 +19,10 @@ export interface ChatCreatePromptArgs {
     /** List of input variables the final prompt will expect. */
     inputVariables?: string[];
 }
+/**
+ * Type for input data for creating a ChatAgent, extending AgentInput with
+ * optional 'outputParser'.
+ */
 export type ChatAgentInput = Optional<AgentInput, "outputParser">;
 /**
  * Agent for the MRKL chain.
@@ -30,8 +37,25 @@ export declare class ChatAgent extends Agent {
     observationPrefix(): string;
     llmPrefix(): string;
     _stop(): string[];
+    /**
+     * Validates that all tools have descriptions. Throws an error if a tool
+     * without a description is found.
+     * @param tools Array of Tool instances to validate.
+     * @returns void
+     */
     static validateTools(tools: Tool[]): void;
+    /**
+     * Returns a default output parser for the ChatAgent.
+     * @param _fields Optional OutputParserArgs to customize the output parser.
+     * @returns ChatAgentOutputParser instance
+     */
     static getDefaultOutputParser(_fields?: OutputParserArgs): ChatAgentOutputParser;
+    /**
+     * Constructs the agent's scratchpad, which is a string representation of
+     * the agent's previous steps.
+     * @param steps Array of AgentStep instances representing the agent's previous steps.
+     * @returns Promise resolving to a string representing the agent's scratchpad.
+     */
     constructScratchPad(steps: AgentStep[]): Promise<string>;
     /**
      * Create prompt in the style of the zero shot agent.
@@ -43,5 +67,13 @@ export declare class ChatAgent extends Agent {
      * @param args.humanMessageTemplate - String to use directly as the human message template
      */
     static createPrompt(tools: Tool[], args?: ChatCreatePromptArgs): ChatPromptTemplate<any, any>;
+    /**
+     * Creates a ChatAgent instance using a language model, tools, and
+     * optional arguments.
+     * @param llm BaseLanguageModel instance to use in the agent.
+     * @param tools Array of Tool instances to include in the agent.
+     * @param args Optional arguments to customize the agent and prompt.
+     * @returns ChatAgent instance
+     */
     static fromLLMAndTools(llm: BaseLanguageModel, tools: Tool[], args?: ChatCreatePromptArgs & AgentArgs): ChatAgent;
 }

package/dist/agents/chat/index.js

@@ -34,6 +34,12 @@ export class ChatAgent extends Agent {
     _stop() {
         return ["Observation:"];
     }
+    /**
+     * Validates that all tools have descriptions. Throws an error if a tool
+     * without a description is found.
+     * @param tools Array of Tool instances to validate.
+     * @returns void
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -42,9 +48,20 @@ export class ChatAgent extends Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Returns a default output parser for the ChatAgent.
+     * @param _fields Optional OutputParserArgs to customize the output parser.
+     * @returns ChatAgentOutputParser instance
+     */
     static getDefaultOutputParser(_fields) {
         return new ChatAgentOutputParser();
     }
+    /**
+     * Constructs the agent's scratchpad, which is a string representation of
+     * the agent's previous steps.
+     * @param steps Array of AgentStep instances representing the agent's previous steps.
+     * @returns Promise resolving to a string representing the agent's scratchpad.
+     */
     async constructScratchPad(steps) {
         const agentScratchpad = await super.constructScratchPad(steps);
         if (agentScratchpad) {
@@ -73,6 +90,14 @@ export class ChatAgent extends Agent {
         ];
         return ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates a ChatAgent instance using a language model, tools, and
+     * optional arguments.
+     * @param llm BaseLanguageModel instance to use in the agent.
+     * @param tools Array of Tool instances to include in the agent.
+     * @param args Optional arguments to customize the agent and prompt.
+     * @returns ChatAgent instance
+     */
     static fromLLMAndTools(llm, tools, args) {
         ChatAgent.validateTools(tools);
         const prompt = ChatAgent.createPrompt(tools, args);

package/dist/agents/chat/outputParser.cjs

@@ -4,6 +4,11 @@ exports.ChatAgentOutputParser = exports.FINAL_ANSWER_ACTION = void 0;
 const types_js_1 = require("../types.cjs");
 const prompt_js_1 = require("./prompt.cjs");
 exports.FINAL_ANSWER_ACTION = "Final Answer:";
+/**
+ * A class that extends the AgentActionOutputParser to parse the output of
+ * the ChatAgent in LangChain. It checks if the output text contains the
+ * final answer action or a JSON response, and parses it accordingly.
+ */
 class ChatAgentOutputParser extends types_js_1.AgentActionOutputParser {
     constructor() {
         super(...arguments);
@@ -14,6 +19,15 @@ class ChatAgentOutputParser extends types_js_1.AgentActionOutputParser {
             value: ["langchain", "agents", "chat"]
         });
     }
+    /**
+     * Parses the output text from the MRKL chain into an agent action or
+     * agent finish. If the text contains the final answer action or does not
+     * contain an action, it returns an AgentFinish with the output and log.
+     * If the text contains a JSON response, it returns the tool, toolInput,
+     * and log.
+     * @param text The output text from the MRKL chain.
+     * @returns An object that satisfies the AgentFinish interface or an object with the tool, toolInput, and log.
+     */
     async parse(text) {
         if (text.includes(exports.FINAL_ANSWER_ACTION) || !text.includes(`"action":`)) {
             const parts = text.split(exports.FINAL_ANSWER_ACTION);
@@ -35,6 +49,11 @@ class ChatAgentOutputParser extends types_js_1.AgentActionOutputParser {
             throw new Error(`Unable to parse JSON response from chat agent.\n\n${text}`);
         }
     }
+    /**
+     * Returns the format instructions used in the output parser for the
+     * ChatAgent class.
+     * @returns The format instructions as a string.
+     */
     getFormatInstructions() {
         return prompt_js_1.FORMAT_INSTRUCTIONS;
     }

package/dist/agents/chat/outputParser.d.ts

@@ -1,7 +1,21 @@
 import { AgentActionOutputParser } from "../types.js";
 export declare const FINAL_ANSWER_ACTION = "Final Answer:";
+/**
+ * A class that extends the AgentActionOutputParser to parse the output of
+ * the ChatAgent in LangChain. It checks if the output text contains the
+ * final answer action or a JSON response, and parses it accordingly.
+ */
 export declare class ChatAgentOutputParser extends AgentActionOutputParser {
     lc_namespace: string[];
+    /**
+     * Parses the output text from the MRKL chain into an agent action or
+     * agent finish. If the text contains the final answer action or does not
+     * contain an action, it returns an AgentFinish with the output and log.
+     * If the text contains a JSON response, it returns the tool, toolInput,
+     * and log.
+     * @param text The output text from the MRKL chain.
+     * @returns An object that satisfies the AgentFinish interface or an object with the tool, toolInput, and log.
+     */
     parse(text: string): Promise<{
         returnValues: {
             output: string;
@@ -15,5 +29,10 @@ export declare class ChatAgentOutputParser extends AgentActionOutputParser {
         log: string;
         returnValues?: undefined;
     }>;
+    /**
+     * Returns the format instructions used in the output parser for the
+     * ChatAgent class.
+     * @returns The format instructions as a string.
+     */
     getFormatInstructions(): string;
 }

package/dist/agents/chat/outputParser.js

@@ -1,6 +1,11 @@
 import { AgentActionOutputParser } from "../types.js";
 import { FORMAT_INSTRUCTIONS } from "./prompt.js";
 export const FINAL_ANSWER_ACTION = "Final Answer:";
+/**
+ * A class that extends the AgentActionOutputParser to parse the output of
+ * the ChatAgent in LangChain. It checks if the output text contains the
+ * final answer action or a JSON response, and parses it accordingly.
+ */
 export class ChatAgentOutputParser extends AgentActionOutputParser {
     constructor() {
         super(...arguments);
@@ -11,6 +16,15 @@ export class ChatAgentOutputParser extends AgentActionOutputParser {
             value: ["langchain", "agents", "chat"]
         });
     }
+    /**
+     * Parses the output text from the MRKL chain into an agent action or
+     * agent finish. If the text contains the final answer action or does not
+     * contain an action, it returns an AgentFinish with the output and log.
+     * If the text contains a JSON response, it returns the tool, toolInput,
+     * and log.
+     * @param text The output text from the MRKL chain.
+     * @returns An object that satisfies the AgentFinish interface or an object with the tool, toolInput, and log.
+     */
     async parse(text) {
         if (text.includes(FINAL_ANSWER_ACTION) || !text.includes(`"action":`)) {
             const parts = text.split(FINAL_ANSWER_ACTION);
@@ -32,6 +46,11 @@ export class ChatAgentOutputParser extends AgentActionOutputParser {
             throw new Error(`Unable to parse JSON response from chat agent.\n\n${text}`);
         }
     }
+    /**
+     * Returns the format instructions used in the output parser for the
+     * ChatAgent class.
+     * @returns The format instructions as a string.
+     */
     getFormatInstructions() {
         return FORMAT_INSTRUCTIONS;
     }

package/dist/agents/chat_convo/index.cjs

@@ -46,6 +46,12 @@ class ChatConversationalAgent extends agent_js_1.Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Constructs the agent scratchpad based on the agent steps. It returns an
+     * array of base messages representing the thoughts of the agent.
+     * @param steps The agent steps to construct the scratchpad from.
+     * @returns An array of base messages representing the thoughts of the agent.
+     */
     async constructScratchPad(steps) {
         const thoughts = [];
         for (const step of steps) {
@@ -56,6 +62,13 @@ class ChatConversationalAgent extends agent_js_1.Agent {
         }
         return thoughts;
     }
+    /**
+     * Returns the default output parser for the ChatConversationalAgent
+     * class. It takes optional fields as arguments to customize the output
+     * parser.
+     * @param fields Optional fields to customize the output parser.
+     * @returns The default output parser for the ChatConversationalAgent class.
+     */
     static getDefaultOutputParser(fields) {
         if (fields?.llm) {
             return outputParser_js_1.ChatConversationalAgentOutputParserWithRetries.fromLLM(fields.llm, {
@@ -99,6 +112,15 @@ class ChatConversationalAgent extends agent_js_1.Agent {
         ];
         return chat_js_1.ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates an instance of the ChatConversationalAgent class from a
+     * BaseLanguageModel and a set of tools. It takes optional arguments to
+     * customize the agent.
+     * @param llm The BaseLanguageModel to create the agent from.
+     * @param tools The set of tools to create the agent from.
+     * @param args Optional arguments to customize the agent.
+     * @returns An instance of the ChatConversationalAgent class.
+     */
     static fromLLMAndTools(llm, tools, args) {
         ChatConversationalAgent.validateTools(tools);
         const outputParser = args?.outputParser ??

package/dist/agents/chat_convo/index.d.ts

@@ -5,6 +5,10 @@ import { Tool } from "../../tools/base.js";
 import { Optional } from "../../types/type-utils.js";
 import { Agent, AgentArgs, OutputParserArgs } from "../agent.js";
 import { AgentActionOutputParser, AgentInput } from "../types.js";
+/**
+ * Interface defining the structure of arguments used to create a prompt
+ * for the ChatConversationalAgent class.
+ */
 export interface ChatConversationalCreatePromptArgs {
     /** String to put after the list of tools. */
     systemMessage?: string;
@@ -15,6 +19,11 @@ export interface ChatConversationalCreatePromptArgs {
     /** Output parser to use for formatting. */
     outputParser?: AgentActionOutputParser;
 }
+/**
+ * Type that extends the AgentInput interface for the
+ * ChatConversationalAgent class, making the outputParser property
+ * optional.
+ */
 export type ChatConversationalAgentInput = Optional<AgentInput, "outputParser">;
 /**
  * Agent for the MRKL chain.
@@ -30,7 +39,20 @@ export declare class ChatConversationalAgent extends Agent {
     llmPrefix(): string;
     _stop(): string[];
     static validateTools(tools: Tool[]): void;
+    /**
+     * Constructs the agent scratchpad based on the agent steps. It returns an
+     * array of base messages representing the thoughts of the agent.
+     * @param steps The agent steps to construct the scratchpad from.
+     * @returns An array of base messages representing the thoughts of the agent.
+     */
     constructScratchPad(steps: AgentStep[]): Promise<BaseMessage[]>;
+    /**
+     * Returns the default output parser for the ChatConversationalAgent
+     * class. It takes optional fields as arguments to customize the output
+     * parser.
+     * @param fields Optional fields to customize the output parser.
+     * @returns The default output parser for the ChatConversationalAgent class.
+     */
     static getDefaultOutputParser(fields?: OutputParserArgs & {
         toolNames: string[];
     }): AgentActionOutputParser;
@@ -44,5 +66,14 @@ export declare class ChatConversationalAgent extends Agent {
      * @param args.outputParser - Output parser to use for formatting.
      */
     static createPrompt(tools: Tool[], args?: ChatConversationalCreatePromptArgs): ChatPromptTemplate<any, any>;
+    /**
+     * Creates an instance of the ChatConversationalAgent class from a
+     * BaseLanguageModel and a set of tools. It takes optional arguments to
+     * customize the agent.
+     * @param llm The BaseLanguageModel to create the agent from.
+     * @param tools The set of tools to create the agent from.
+     * @param args Optional arguments to customize the agent.
+     * @returns An instance of the ChatConversationalAgent class.
+     */
     static fromLLMAndTools(llm: BaseLanguageModel, tools: Tool[], args?: ChatConversationalCreatePromptArgs & AgentArgs): ChatConversationalAgent;
 }

package/dist/agents/chat_convo/index.js

@@ -43,6 +43,12 @@ export class ChatConversationalAgent extends Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Constructs the agent scratchpad based on the agent steps. It returns an
+     * array of base messages representing the thoughts of the agent.
+     * @param steps The agent steps to construct the scratchpad from.
+     * @returns An array of base messages representing the thoughts of the agent.
+     */
     async constructScratchPad(steps) {
         const thoughts = [];
         for (const step of steps) {
@@ -53,6 +59,13 @@ export class ChatConversationalAgent extends Agent {
         }
         return thoughts;
     }
+    /**
+     * Returns the default output parser for the ChatConversationalAgent
+     * class. It takes optional fields as arguments to customize the output
+     * parser.
+     * @param fields Optional fields to customize the output parser.
+     * @returns The default output parser for the ChatConversationalAgent class.
+     */
     static getDefaultOutputParser(fields) {
         if (fields?.llm) {
             return ChatConversationalAgentOutputParserWithRetries.fromLLM(fields.llm, {
@@ -96,6 +109,15 @@ export class ChatConversationalAgent extends Agent {
         ];
         return ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates an instance of the ChatConversationalAgent class from a
+     * BaseLanguageModel and a set of tools. It takes optional arguments to
+     * customize the agent.
+     * @param llm The BaseLanguageModel to create the agent from.
+     * @param tools The set of tools to create the agent from.
+     * @param args Optional arguments to customize the agent.
+     * @returns An instance of the ChatConversationalAgent class.
+     */
     static fromLLMAndTools(llm, tools, args) {
         ChatConversationalAgent.validateTools(tools);
         const outputParser = args?.outputParser ??

package/dist/agents/chat_convo/outputParser.cjs

@@ -6,6 +6,11 @@ const template_js_1 = require("../../prompts/template.cjs");
 const types_js_1 = require("../types.cjs");
 const prompt_js_1 = require("./prompt.cjs");
 const fix_js_1 = require("../../output_parsers/fix.cjs");
+/**
+ * Class that represents an output parser for the ChatConversationalAgent
+ * class. It extends the AgentActionOutputParser class and provides
+ * methods for parsing the output of the MRKL chain into agent actions.
+ */
 class ChatConversationalAgentOutputParser extends types_js_1.AgentActionOutputParser {
     constructor(fields) {
         super(...arguments);
@@ -23,6 +28,12 @@ class ChatConversationalAgentOutputParser extends types_js_1.AgentActionOutputPa
         });
         this.toolNames = fields.toolNames;
     }
+    /**
+     * Parses the given text into an AgentAction or AgentFinish object. If an
+     * output fixing parser is defined, uses it to parse the text.
+     * @param text Text to parse.
+     * @returns Promise that resolves to an AgentAction or AgentFinish object.
+     */
     async parse(text) {
         let jsonOutput = text.trim();
         if (jsonOutput.includes("```json")) {
@@ -48,6 +59,12 @@ class ChatConversationalAgentOutputParser extends types_js_1.AgentActionOutputPa
             throw new output_parser_js_1.OutputParserException(`Failed to parse. Text: "${text}". Error: ${e}`);
         }
     }
+    /**
+     * Returns the format instructions as a string. If the 'raw' option is
+     * true, returns the raw FORMAT_INSTRUCTIONS.
+     * @param options Options for getting the format instructions.
+     * @returns Format instructions as a string.
+     */
     getFormatInstructions() {
         return (0, template_js_1.renderTemplate)(prompt_js_1.FORMAT_INSTRUCTIONS, "f-string", {
             tool_names: this.toolNames.join(", "),
@@ -55,6 +72,12 @@ class ChatConversationalAgentOutputParser extends types_js_1.AgentActionOutputPa
     }
 }
 exports.ChatConversationalAgentOutputParser = ChatConversationalAgentOutputParser;
+/**
+ * Class that represents an output parser with retries for the
+ * ChatConversationalAgent class. It extends the AgentActionOutputParser
+ * class and provides methods for parsing the output of the MRKL chain
+ * into agent actions with retry functionality.
+ */
 class ChatConversationalAgentOutputParserWithRetries extends types_js_1.AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -88,6 +111,10 @@ class ChatConversationalAgentOutputParserWithRetries extends types_js_1.AgentAct
                 new ChatConversationalAgentOutputParser({ toolNames: this.toolNames });
         this.outputFixingParser = fields?.outputFixingParser;
     }
+    /**
+     * Returns the format instructions as a string.
+     * @returns Format instructions as a string.
+     */
     getFormatInstructions(options) {
         if (options.raw) {
             return prompt_js_1.FORMAT_INSTRUCTIONS;
@@ -96,12 +123,27 @@ class ChatConversationalAgentOutputParserWithRetries extends types_js_1.AgentAct
             tool_names: options.toolNames.join(", "),
         });
     }
+    /**
+     * Parses the given text into an AgentAction or AgentFinish object.
+     * @param text Text to parse.
+     * @returns Promise that resolves to an AgentAction or AgentFinish object.
+     */
     async parse(text) {
         if (this.outputFixingParser !== undefined) {
             return this.outputFixingParser.parse(text);
         }
         return this.baseParser.parse(text);
     }
+    /**
+     * Static method to create a new
+     * ChatConversationalAgentOutputParserWithRetries from a BaseLanguageModel
+     * and options. If no base parser is provided in the options, a new
+     * ChatConversationalAgentOutputParser is created. An OutputFixingParser
+     * is also created from the BaseLanguageModel and the base parser.
+     * @param llm BaseLanguageModel instance used to create the OutputFixingParser.
+     * @param options Options for creating the ChatConversationalAgentOutputParserWithRetries instance.
+     * @returns A new instance of ChatConversationalAgentOutputParserWithRetries.
+     */
     static fromLLM(llm, options) {
         const baseParser = options.baseParser ??
             new ChatConversationalAgentOutputParser({