langchain 0.0.130 → 0.0.132

package/dist/agents/openai/index.cjs

@@ -7,6 +7,12 @@ const prompt_js_1 = require("./prompt.cjs");
 const chat_js_1 = require("../../prompts/chat.cjs");
 const llm_chain_js_1 = require("../../chains/llm_chain.cjs");
 const output_parser_js_1 = require("../../schema/output_parser.cjs");
+/**
+ * Parses the output message into a FunctionsAgentAction or AgentFinish
+ * object.
+ * @param message The BaseMessage to parse.
+ * @returns A FunctionsAgentAction or AgentFinish object.
+ */
 function parseOutput(message) {
     if (message.additional_kwargs.function_call) {
         // eslint-disable-next-line prefer-destructuring
@@ -30,6 +36,11 @@ function parseOutput(message) {
         return { returnValues: { output: message.content }, log: message.content };
     }
 }
+/**
+ * Checks if the given action is a FunctionsAgentAction.
+ * @param action The action to check.
+ * @returns True if the action is a FunctionsAgentAction, false otherwise.
+ */
 function isFunctionsAgentAction(action) {
     return action.messageLog !== undefined;
 }
@@ -45,7 +56,15 @@ function _formatIntermediateSteps(intermediateSteps) {
     return intermediateSteps.flatMap(({ action, observation }) => _convertAgentStepToMessages(action, observation));
 }
 exports._formatIntermediateSteps = _formatIntermediateSteps;
+/**
+ * Class representing an agent for the OpenAI chat model in LangChain. It
+ * extends the Agent class and provides additional functionality specific
+ * to the OpenAIAgent type.
+ */
 class OpenAIAgent extends agent_js_1.Agent {
+    static lc_name() {
+        return "OpenAIAgent";
+    }
     _agentType() {
         return "openai-functions";
     }
@@ -74,6 +93,13 @@ class OpenAIAgent extends agent_js_1.Agent {
         });
         this.tools = input.tools;
     }
+    /**
+     * Creates a prompt for the OpenAIAgent using the provided tools and
+     * fields.
+     * @param _tools The tools to be used in the prompt.
+     * @param fields Optional fields for creating the prompt.
+     * @returns A BasePromptTemplate object representing the created prompt.
+     */
     static createPrompt(_tools, fields) {
         const { prefix = prompt_js_1.PREFIX } = fields || {};
         return chat_js_1.ChatPromptTemplate.fromPromptMessages([
@@ -83,6 +109,13 @@ class OpenAIAgent extends agent_js_1.Agent {
             new chat_js_1.MessagesPlaceholder("agent_scratchpad"),
         ]);
     }
+    /**
+     * Creates an OpenAIAgent from a BaseLanguageModel and a list of tools.
+     * @param llm The BaseLanguageModel to use.
+     * @param tools The tools to be used by the agent.
+     * @param args Optional arguments for creating the agent.
+     * @returns An instance of OpenAIAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         OpenAIAgent.validateTools(tools);
         if (llm._modelType() !== "base_chat_model" || llm._llmType() !== "openai") {
@@ -100,9 +133,22 @@ class OpenAIAgent extends agent_js_1.Agent {
             tools,
         });
     }
+    /**
+     * Constructs a scratch pad from a list of agent steps.
+     * @param steps The steps to include in the scratch pad.
+     * @returns A string or a list of BaseMessages representing the constructed scratch pad.
+     */
     async constructScratchPad(steps) {
         return _formatIntermediateSteps(steps);
     }
+    /**
+     * Plans the next action or finish state of the agent based on the
+     * provided steps, inputs, and optional callback manager.
+     * @param steps The steps to consider in planning.
+     * @param inputs The inputs to consider in planning.
+     * @param callbackManager Optional CallbackManager to use in planning.
+     * @returns A Promise that resolves to an AgentAction or AgentFinish object representing the planned action or finish state.
+     */
     async plan(steps, inputs, callbackManager) {
         // Add scratchpad and stop to inputs
         const thoughts = await this.constructScratchPad(steps);

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

@@ -6,14 +6,27 @@ import { Agent, AgentArgs } from "../agent.js";
 import { AgentInput } from "../types.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 export declare function _formatIntermediateSteps(intermediateSteps: AgentStep[]): BaseMessage[];
+/**
+ * Interface for the input data required to create an OpenAIAgent.
+ */
 export interface OpenAIAgentInput extends AgentInput {
     tools: StructuredTool[];
 }
+/**
+ * Interface for the arguments required to create a prompt for an
+ * OpenAIAgent.
+ */
 export interface OpenAIAgentCreatePromptArgs {
     prefix?: string;
     systemMessage?: SystemMessage;
 }
+/**
+ * Class representing an agent for the OpenAI chat model in LangChain. It
+ * extends the Agent class and provides additional functionality specific
+ * to the OpenAIAgent type.
+ */
 export declare class OpenAIAgent extends Agent {
+    static lc_name(): string;
     lc_namespace: string[];
     _agentType(): "openai-functions";
     observationPrefix(): string;
@@ -21,8 +34,35 @@ export declare class OpenAIAgent extends Agent {
     _stop(): string[];
     tools: StructuredTool[];
     constructor(input: Omit<OpenAIAgentInput, "outputParser">);
+    /**
+     * Creates a prompt for the OpenAIAgent using the provided tools and
+     * fields.
+     * @param _tools The tools to be used in the prompt.
+     * @param fields Optional fields for creating the prompt.
+     * @returns A BasePromptTemplate object representing the created prompt.
+     */
     static createPrompt(_tools: StructuredTool[], fields?: OpenAIAgentCreatePromptArgs): BasePromptTemplate;
+    /**
+     * Creates an OpenAIAgent from a BaseLanguageModel and a list of tools.
+     * @param llm The BaseLanguageModel to use.
+     * @param tools The tools to be used by the agent.
+     * @param args Optional arguments for creating the agent.
+     * @returns An instance of OpenAIAgent.
+     */
     static fromLLMAndTools(llm: BaseLanguageModel, tools: StructuredTool[], args?: OpenAIAgentCreatePromptArgs & Pick<AgentArgs, "callbacks">): OpenAIAgent;
+    /**
+     * Constructs a scratch pad from a list of agent steps.
+     * @param steps The steps to include in the scratch pad.
+     * @returns A string or a list of BaseMessages representing the constructed scratch pad.
+     */
     constructScratchPad(steps: AgentStep[]): Promise<string | BaseMessage[]>;
+    /**
+     * Plans the next action or finish state of the agent based on the
+     * provided steps, inputs, and optional callback manager.
+     * @param steps The steps to consider in planning.
+     * @param inputs The inputs to consider in planning.
+     * @param callbackManager Optional CallbackManager to use in planning.
+     * @returns A Promise that resolves to an AgentAction or AgentFinish object representing the planned action or finish state.
+     */
     plan(steps: Array<AgentStep>, inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction | AgentFinish>;
 }

package/dist/agents/openai/index.js

@@ -4,6 +4,12 @@ import { PREFIX } from "./prompt.js";
 import { ChatPromptTemplate, HumanMessagePromptTemplate, MessagesPlaceholder, SystemMessagePromptTemplate, } from "../../prompts/chat.js";
 import { LLMChain } from "../../chains/llm_chain.js";
 import { OutputParserException } from "../../schema/output_parser.js";
+/**
+ * Parses the output message into a FunctionsAgentAction or AgentFinish
+ * object.
+ * @param message The BaseMessage to parse.
+ * @returns A FunctionsAgentAction or AgentFinish object.
+ */
 function parseOutput(message) {
     if (message.additional_kwargs.function_call) {
         // eslint-disable-next-line prefer-destructuring
@@ -27,6 +33,11 @@ function parseOutput(message) {
         return { returnValues: { output: message.content }, log: message.content };
     }
 }
+/**
+ * Checks if the given action is a FunctionsAgentAction.
+ * @param action The action to check.
+ * @returns True if the action is a FunctionsAgentAction, false otherwise.
+ */
 function isFunctionsAgentAction(action) {
     return action.messageLog !== undefined;
 }
@@ -41,7 +52,15 @@ function _convertAgentStepToMessages(action, observation) {
 export function _formatIntermediateSteps(intermediateSteps) {
     return intermediateSteps.flatMap(({ action, observation }) => _convertAgentStepToMessages(action, observation));
 }
+/**
+ * Class representing an agent for the OpenAI chat model in LangChain. It
+ * extends the Agent class and provides additional functionality specific
+ * to the OpenAIAgent type.
+ */
 export class OpenAIAgent extends Agent {
+    static lc_name() {
+        return "OpenAIAgent";
+    }
     _agentType() {
         return "openai-functions";
     }
@@ -70,6 +89,13 @@ export class OpenAIAgent extends Agent {
         });
         this.tools = input.tools;
     }
+    /**
+     * Creates a prompt for the OpenAIAgent using the provided tools and
+     * fields.
+     * @param _tools The tools to be used in the prompt.
+     * @param fields Optional fields for creating the prompt.
+     * @returns A BasePromptTemplate object representing the created prompt.
+     */
     static createPrompt(_tools, fields) {
         const { prefix = PREFIX } = fields || {};
         return ChatPromptTemplate.fromPromptMessages([
@@ -79,6 +105,13 @@ export class OpenAIAgent extends Agent {
             new MessagesPlaceholder("agent_scratchpad"),
         ]);
     }
+    /**
+     * Creates an OpenAIAgent from a BaseLanguageModel and a list of tools.
+     * @param llm The BaseLanguageModel to use.
+     * @param tools The tools to be used by the agent.
+     * @param args Optional arguments for creating the agent.
+     * @returns An instance of OpenAIAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         OpenAIAgent.validateTools(tools);
         if (llm._modelType() !== "base_chat_model" || llm._llmType() !== "openai") {
@@ -96,9 +129,22 @@ export class OpenAIAgent extends Agent {
             tools,
         });
     }
+    /**
+     * Constructs a scratch pad from a list of agent steps.
+     * @param steps The steps to include in the scratch pad.
+     * @returns A string or a list of BaseMessages representing the constructed scratch pad.
+     */
     async constructScratchPad(steps) {
         return _formatIntermediateSteps(steps);
     }
+    /**
+     * Plans the next action or finish state of the agent based on the
+     * provided steps, inputs, and optional callback manager.
+     * @param steps The steps to consider in planning.
+     * @param inputs The inputs to consider in planning.
+     * @param callbackManager Optional CallbackManager to use in planning.
+     * @returns A Promise that resolves to an AgentAction or AgentFinish object representing the planned action or finish state.
+     */
     async plan(steps, inputs, callbackManager) {
         // Add scratchpad and stop to inputs
         const thoughts = await this.constructScratchPad(steps);

package/dist/agents/structured_chat/index.cjs

@@ -13,6 +13,9 @@ const prompt_js_2 = require("./prompt.cjs");
  * @augments Agent
  */
 class StructuredChatAgent extends agent_js_1.Agent {
+    static lc_name() {
+        return "StructuredChatAgent";
+    }
     constructor(input) {
         const outputParser = input?.outputParser ?? StructuredChatAgent.getDefaultOutputParser();
         super({ ...input, outputParser });
@@ -35,6 +38,11 @@ class StructuredChatAgent extends agent_js_1.Agent {
     _stop() {
         return ["Observation:"];
     }
+    /**
+     * Validates that all provided tools have a description. Throws an error
+     * if any tool lacks a description.
+     * @param tools Array of StructuredTool instances to validate.
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -43,6 +51,12 @@ class StructuredChatAgent extends agent_js_1.Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Returns a default output parser for the StructuredChatAgent. If an LLM
+     * is provided, it creates an output parser with retry logic from the LLM.
+     * @param fields Optional fields to customize the output parser. Can include an LLM and a list of tool names.
+     * @returns An instance of StructuredChatOutputParserWithRetries.
+     */
     static getDefaultOutputParser(fields) {
         if (fields?.llm) {
             return outputParser_js_1.StructuredChatOutputParserWithRetries.fromLLM(fields.llm, {
@@ -53,6 +67,13 @@ class StructuredChatAgent extends agent_js_1.Agent {
             toolNames: fields?.toolNames,
         });
     }
+    /**
+     * Constructs the agent's scratchpad from a list of steps. If the agent's
+     * scratchpad is not empty, it prepends a message indicating that the
+     * agent has not seen any previous work.
+     * @param steps Array of AgentStep instances to construct the scratchpad from.
+     * @returns A Promise that resolves to a string representing the agent's scratchpad.
+     */
     async constructScratchPad(steps) {
         const agentScratchpad = await super.constructScratchPad(steps);
         if (agentScratchpad) {
@@ -60,6 +81,11 @@ class StructuredChatAgent extends agent_js_1.Agent {
         }
         return agentScratchpad;
     }
+    /**
+     * Creates a string representation of the schemas of the provided tools.
+     * @param tools Array of StructuredTool instances to create the schemas string from.
+     * @returns A string representing the schemas of the provided tools.
+     */
     static createToolSchemasString(tools) {
         return tools
             .map((tool) => `${tool.name}: ${tool.description}, args: ${JSON.stringify((0, zod_to_json_schema_1.zodToJsonSchema)(tool.schema).properties)}`)
@@ -96,6 +122,15 @@ class StructuredChatAgent extends agent_js_1.Agent {
         ];
         return chat_js_1.ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates a StructuredChatAgent from an LLM and a list of tools.
+     * Validates the tools, creates a prompt, and sets up an LLM chain for the
+     * agent.
+     * @param llm BaseLanguageModel instance to create the agent from.
+     * @param tools Array of StructuredTool instances to create the agent from.
+     * @param args Optional arguments to customize the creation of the agent. Can include arguments for creating the prompt and AgentArgs.
+     * @returns A new instance of StructuredChatAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         StructuredChatAgent.validateTools(tools);
         const prompt = StructuredChatAgent.createPrompt(tools, args);

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

@@ -6,6 +6,10 @@ import { Optional } from "../../types/type-utils.js";
 import { Agent, AgentArgs, OutputParserArgs } from "../agent.js";
 import { AgentInput } from "../types.js";
 import { StructuredChatOutputParserWithRetries } from "./outputParser.js";
+/**
+ * Interface for arguments used to create a prompt for a
+ * StructuredChatAgent.
+ */
 export interface StructuredChatCreatePromptArgs {
     /** String to put after the list of tools. */
     suffix?: string;
@@ -16,23 +20,51 @@ export interface StructuredChatCreatePromptArgs {
     /** List of historical prompts from memory.  */
     memoryPrompts?: BaseMessagePromptTemplate[];
 }
+/**
+ * Type for input data for creating a StructuredChatAgent, with the
+ * 'outputParser' property made optional.
+ */
 export type StructuredChatAgentInput = Optional<AgentInput, "outputParser">;
 /**
  * Agent that interoperates with Structured Tools using React logic.
  * @augments Agent
  */
 export declare class StructuredChatAgent extends Agent {
+    static lc_name(): string;
     lc_namespace: string[];
     constructor(input: StructuredChatAgentInput);
     _agentType(): "structured-chat-zero-shot-react-description";
     observationPrefix(): string;
     llmPrefix(): string;
     _stop(): string[];
+    /**
+     * Validates that all provided tools have a description. Throws an error
+     * if any tool lacks a description.
+     * @param tools Array of StructuredTool instances to validate.
+     */
     static validateTools(tools: StructuredTool[]): void;
+    /**
+     * Returns a default output parser for the StructuredChatAgent. If an LLM
+     * is provided, it creates an output parser with retry logic from the LLM.
+     * @param fields Optional fields to customize the output parser. Can include an LLM and a list of tool names.
+     * @returns An instance of StructuredChatOutputParserWithRetries.
+     */
     static getDefaultOutputParser(fields?: OutputParserArgs & {
         toolNames: string[];
     }): StructuredChatOutputParserWithRetries;
+    /**
+     * Constructs the agent's scratchpad from a list of steps. If the agent's
+     * scratchpad is not empty, it prepends a message indicating that the
+     * agent has not seen any previous work.
+     * @param steps Array of AgentStep instances to construct the scratchpad from.
+     * @returns A Promise that resolves to a string representing the agent's scratchpad.
+     */
     constructScratchPad(steps: AgentStep[]): Promise<string>;
+    /**
+     * Creates a string representation of the schemas of the provided tools.
+     * @param tools Array of StructuredTool instances to create the schemas string from.
+     * @returns A string representing the schemas of the provided tools.
+     */
     static createToolSchemasString(tools: StructuredTool[]): string;
     /**
      * Create prompt in the style of the agent.
@@ -45,5 +77,14 @@ export declare class StructuredChatAgent extends Agent {
      * @param args.memoryPrompts List of historical prompts from memory.
      */
     static createPrompt(tools: StructuredTool[], args?: StructuredChatCreatePromptArgs): ChatPromptTemplate<any, any>;
+    /**
+     * Creates a StructuredChatAgent from an LLM and a list of tools.
+     * Validates the tools, creates a prompt, and sets up an LLM chain for the
+     * agent.
+     * @param llm BaseLanguageModel instance to create the agent from.
+     * @param tools Array of StructuredTool instances to create the agent from.
+     * @param args Optional arguments to customize the creation of the agent. Can include arguments for creating the prompt and AgentArgs.
+     * @returns A new instance of StructuredChatAgent.
+     */
     static fromLLMAndTools(llm: BaseLanguageModel, tools: StructuredTool[], args?: StructuredChatCreatePromptArgs & AgentArgs): StructuredChatAgent;
 }

package/dist/agents/structured_chat/index.js

@@ -10,6 +10,9 @@ import { FORMAT_INSTRUCTIONS, PREFIX, SUFFIX } from "./prompt.js";
  * @augments Agent
  */
 export class StructuredChatAgent extends Agent {
+    static lc_name() {
+        return "StructuredChatAgent";
+    }
     constructor(input) {
         const outputParser = input?.outputParser ?? StructuredChatAgent.getDefaultOutputParser();
         super({ ...input, outputParser });
@@ -32,6 +35,11 @@ export class StructuredChatAgent extends Agent {
     _stop() {
         return ["Observation:"];
     }
+    /**
+     * Validates that all provided tools have a description. Throws an error
+     * if any tool lacks a description.
+     * @param tools Array of StructuredTool instances to validate.
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -40,6 +48,12 @@ export class StructuredChatAgent extends Agent {
             throw new Error(msg);
         }
     }
+    /**
+     * Returns a default output parser for the StructuredChatAgent. If an LLM
+     * is provided, it creates an output parser with retry logic from the LLM.
+     * @param fields Optional fields to customize the output parser. Can include an LLM and a list of tool names.
+     * @returns An instance of StructuredChatOutputParserWithRetries.
+     */
     static getDefaultOutputParser(fields) {
         if (fields?.llm) {
             return StructuredChatOutputParserWithRetries.fromLLM(fields.llm, {
@@ -50,6 +64,13 @@ export class StructuredChatAgent extends Agent {
             toolNames: fields?.toolNames,
         });
     }
+    /**
+     * Constructs the agent's scratchpad from a list of steps. If the agent's
+     * scratchpad is not empty, it prepends a message indicating that the
+     * agent has not seen any previous work.
+     * @param steps Array of AgentStep instances to construct the scratchpad from.
+     * @returns A Promise that resolves to a string representing the agent's scratchpad.
+     */
     async constructScratchPad(steps) {
         const agentScratchpad = await super.constructScratchPad(steps);
         if (agentScratchpad) {
@@ -57,6 +78,11 @@ export class StructuredChatAgent extends Agent {
         }
         return agentScratchpad;
     }
+    /**
+     * Creates a string representation of the schemas of the provided tools.
+     * @param tools Array of StructuredTool instances to create the schemas string from.
+     * @returns A string representing the schemas of the provided tools.
+     */
     static createToolSchemasString(tools) {
         return tools
             .map((tool) => `${tool.name}: ${tool.description}, args: ${JSON.stringify(zodToJsonSchema(tool.schema).properties)}`)
@@ -93,6 +119,15 @@ export class StructuredChatAgent extends Agent {
         ];
         return ChatPromptTemplate.fromPromptMessages(messages);
     }
+    /**
+     * Creates a StructuredChatAgent from an LLM and a list of tools.
+     * Validates the tools, creates a prompt, and sets up an LLM chain for the
+     * agent.
+     * @param llm BaseLanguageModel instance to create the agent from.
+     * @param tools Array of StructuredTool instances to create the agent from.
+     * @param args Optional arguments to customize the creation of the agent. Can include arguments for creating the prompt and AgentArgs.
+     * @returns A new instance of StructuredChatAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         StructuredChatAgent.validateTools(tools);
         const prompt = StructuredChatAgent.createPrompt(tools, args);

package/dist/agents/structured_chat/outputParser.cjs

@@ -6,6 +6,12 @@ const prompt_js_1 = require("./prompt.cjs");
 const fix_js_1 = require("../../output_parsers/fix.cjs");
 const output_parser_js_1 = require("../../schema/output_parser.cjs");
 const index_js_1 = require("../../prompts/index.cjs");
+/**
+ * A class that provides a custom implementation for parsing the output of
+ * a StructuredChatAgent action. It extends the `AgentActionOutputParser`
+ * class and extracts the action and action input from the text output,
+ * returning an `AgentAction` or `AgentFinish` object.
+ */
 class StructuredChatOutputParser extends types_js_1.AgentActionOutputParser {
     constructor(fields) {
         super(...arguments);
@@ -23,6 +29,14 @@ class StructuredChatOutputParser extends types_js_1.AgentActionOutputParser {
         });
         this.toolNames = fields.toolNames;
     }
+    /**
+     * Parses the given text and returns an `AgentAction` or `AgentFinish`
+     * object. If an `OutputFixingParser` is provided, it is used for parsing;
+     * otherwise, the base parser is used.
+     * @param text The text to parse.
+     * @param callbacks Optional callbacks for asynchronous operations.
+     * @returns A Promise that resolves to an `AgentAction` or `AgentFinish` object.
+     */
     async parse(text) {
         try {
             const regex = /```(?:json)?(.*)(```)/gs;
@@ -41,6 +55,11 @@ class StructuredChatOutputParser extends types_js_1.AgentActionOutputParser {
             throw new output_parser_js_1.OutputParserException(`Failed to parse. Text: "${text}". Error: ${e}`);
         }
     }
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the StructuredChatAgent.
+     * @returns A string representing the format instructions.
+     */
     getFormatInstructions() {
         return (0, index_js_1.renderTemplate)(prompt_js_1.AGENT_ACTION_FORMAT_INSTRUCTIONS, "f-string", {
             tool_names: this.toolNames.join(", "),
@@ -48,6 +67,12 @@ class StructuredChatOutputParser extends types_js_1.AgentActionOutputParser {
     }
 }
 exports.StructuredChatOutputParser = StructuredChatOutputParser;
+/**
+ * A class that provides a wrapper around the `StructuredChatOutputParser`
+ * and `OutputFixingParser` classes. It extends the
+ * `AgentActionOutputParser` class and allows for retrying the output
+ * parsing using the `OutputFixingParser` if it is provided.
+ */
 class StructuredChatOutputParserWithRetries extends types_js_1.AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -81,17 +106,36 @@ class StructuredChatOutputParserWithRetries extends types_js_1.AgentActionOutput
                 new StructuredChatOutputParser({ toolNames: this.toolNames });
         this.outputFixingParser = fields?.outputFixingParser;
     }
+    /**
+     * Parses the given text and returns an `AgentAction` or `AgentFinish`
+     * object. Throws an `OutputParserException` if the parsing fails.
+     * @param text The text to parse.
+     * @returns A Promise that resolves to an `AgentAction` or `AgentFinish` object.
+     */
     async parse(text, callbacks) {
         if (this.outputFixingParser !== undefined) {
             return this.outputFixingParser.parse(text, callbacks);
         }
         return this.baseParser.parse(text);
     }
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the StructuredChatAgent.
+     * @returns A string representing the format instructions.
+     */
     getFormatInstructions() {
         return (0, index_js_1.renderTemplate)(prompt_js_1.FORMAT_INSTRUCTIONS, "f-string", {
             tool_names: this.toolNames.join(", "),
         });
     }
+    /**
+     * Creates a new `StructuredChatOutputParserWithRetries` instance from a
+     * `BaseLanguageModel` and options. The options can include a base parser
+     * and tool names.
+     * @param llm A `BaseLanguageModel` instance.
+     * @param options Options for creating a `StructuredChatOutputParserWithRetries` instance.
+     * @returns A new `StructuredChatOutputParserWithRetries` instance.
+     */
     static fromLLM(llm, options) {
         const baseParser = options.baseParser ??
             new StructuredChatOutputParser({ toolNames: options.toolNames ?? [] });

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

@@ -3,27 +3,75 @@ import { OutputFixingParser } from "../../output_parsers/fix.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 import { AgentAction, AgentFinish } from "../../schema/index.js";
 import { Callbacks } from "../../callbacks/manager.js";
+/**
+ * A class that provides a custom implementation for parsing the output of
+ * a StructuredChatAgent action. It extends the `AgentActionOutputParser`
+ * class and extracts the action and action input from the text output,
+ * returning an `AgentAction` or `AgentFinish` object.
+ */
 export declare class StructuredChatOutputParser extends AgentActionOutputParser {
     lc_namespace: string[];
     private toolNames;
     constructor(fields: {
         toolNames: string[];
     });
+    /**
+     * Parses the given text and returns an `AgentAction` or `AgentFinish`
+     * object. If an `OutputFixingParser` is provided, it is used for parsing;
+     * otherwise, the base parser is used.
+     * @param text The text to parse.
+     * @param callbacks Optional callbacks for asynchronous operations.
+     * @returns A Promise that resolves to an `AgentAction` or `AgentFinish` object.
+     */
     parse(text: string): Promise<AgentAction | AgentFinish>;
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the StructuredChatAgent.
+     * @returns A string representing the format instructions.
+     */
     getFormatInstructions(): string;
 }
+/**
+ * An interface for the arguments used to construct a
+ * `StructuredChatOutputParserWithRetries` instance.
+ */
 export interface StructuredChatOutputParserArgs {
     baseParser?: StructuredChatOutputParser;
     outputFixingParser?: OutputFixingParser<AgentAction | AgentFinish>;
     toolNames?: string[];
 }
+/**
+ * A class that provides a wrapper around the `StructuredChatOutputParser`
+ * and `OutputFixingParser` classes. It extends the
+ * `AgentActionOutputParser` class and allows for retrying the output
+ * parsing using the `OutputFixingParser` if it is provided.
+ */
 export declare class StructuredChatOutputParserWithRetries extends AgentActionOutputParser {
     lc_namespace: string[];
     private baseParser;
     private outputFixingParser?;
     private toolNames;
     constructor(fields: StructuredChatOutputParserArgs);
+    /**
+     * Parses the given text and returns an `AgentAction` or `AgentFinish`
+     * object. Throws an `OutputParserException` if the parsing fails.
+     * @param text The text to parse.
+     * @returns A Promise that resolves to an `AgentAction` or `AgentFinish` object.
+     */
     parse(text: string, callbacks?: Callbacks): Promise<AgentAction | AgentFinish>;
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the StructuredChatAgent.
+     * @returns A string representing the format instructions.
+     */
     getFormatInstructions(): string;
+    /**
+     * Creates a new `StructuredChatOutputParserWithRetries` instance from a
+     * `BaseLanguageModel` and options. The options can include a base parser
+     * and tool names.
+     * @param llm A `BaseLanguageModel` instance.
+     * @param options Options for creating a `StructuredChatOutputParserWithRetries` instance.
+     * @returns A new `StructuredChatOutputParserWithRetries` instance.
+     */
     static fromLLM(llm: BaseLanguageModel, options: Omit<StructuredChatOutputParserArgs, "outputFixingParser">): StructuredChatOutputParserWithRetries;
 }