langchain 0.0.131 → 0.0.132

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

@@ -7,13 +7,30 @@ export type ChatConversationalAgentOutputParserFormatInstructionsOptions = Forma
     toolNames: string[];
     raw?: boolean;
 };
+/**
+ * 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.
+ */
 export declare class ChatConversationalAgentOutputParser extends AgentActionOutputParser {
     lc_namespace: string[];
     private toolNames;
     constructor(fields: {
         toolNames: string[];
     });
+    /**
+     * 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.
+     */
     parse(text: string): Promise<AgentAction | AgentFinish>;
+    /**
+     * 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(): string;
 }
 export type ChatConversationalAgentOutputParserArgs = {
@@ -21,13 +38,38 @@ export type ChatConversationalAgentOutputParserArgs = {
     outputFixingParser?: OutputFixingParser<AgentAction | AgentFinish>;
     toolNames?: string[];
 };
+/**
+ * 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.
+ */
 export declare class ChatConversationalAgentOutputParserWithRetries extends AgentActionOutputParser {
     lc_namespace: string[];
     private baseParser;
     private outputFixingParser?;
     private toolNames;
     constructor(fields: ChatConversationalAgentOutputParserArgs);
+    /**
+     * Returns the format instructions as a string.
+     * @returns Format instructions as a string.
+     */
     getFormatInstructions(options: ChatConversationalAgentOutputParserFormatInstructionsOptions): string;
+    /**
+     * 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.
+     */
     parse(text: string): Promise<AgentAction | AgentFinish>;
+    /**
+     * 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: BaseLanguageModel, options: Omit<ChatConversationalAgentOutputParserArgs, "outputFixingParser">): ChatConversationalAgentOutputParserWithRetries;
 }

package/dist/agents/chat_convo/outputParser.js

@@ -3,6 +3,11 @@ import { renderTemplate } from "../../prompts/template.js";
 import { AgentActionOutputParser } from "../types.js";
 import { FORMAT_INSTRUCTIONS } from "./prompt.js";
 import { OutputFixingParser } from "../../output_parsers/fix.js";
+/**
+ * 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.
+ */
 export class ChatConversationalAgentOutputParser extends AgentActionOutputParser {
     constructor(fields) {
         super(...arguments);
@@ -20,6 +25,12 @@ export class ChatConversationalAgentOutputParser extends AgentActionOutputParser
         });
         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")) {
@@ -45,12 +56,24 @@ export class ChatConversationalAgentOutputParser extends AgentActionOutputParser
             throw new 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 renderTemplate(FORMAT_INSTRUCTIONS, "f-string", {
             tool_names: this.toolNames.join(", "),
         });
     }
 }
+/**
+ * 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.
+ */
 export class ChatConversationalAgentOutputParserWithRetries extends AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -84,6 +107,10 @@ export class ChatConversationalAgentOutputParserWithRetries extends AgentActionO
                 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 FORMAT_INSTRUCTIONS;
@@ -92,12 +119,27 @@ export class ChatConversationalAgentOutputParserWithRetries extends AgentActionO
             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({

package/dist/agents/executor.cjs

@@ -70,6 +70,12 @@ class AgentExecutor extends base_js_1.BaseChain {
     static fromAgentAndTools(fields) {
         return new AgentExecutor(fields);
     }
+    /**
+     * Method that checks if the agent execution should continue based on the
+     * number of iterations.
+     * @param iterations The current number of iterations.
+     * @returns A boolean indicating whether the agent execution should continue.
+     */
     shouldContinue(iterations) {
         return this.maxIterations === undefined || iterations < this.maxIterations;
     }

package/dist/agents/executor.d.ts

@@ -4,6 +4,11 @@ import { StoppingMethod } from "./types.js";
 import { SerializedLLMChain } from "../chains/serde.js";
 import { ChainValues } from "../schema/index.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
+/**
+ * Interface defining the structure of input data for creating an
+ * AgentExecutor. It extends ChainInputs and includes additional
+ * properties specific to agent execution.
+ */
 export interface AgentExecutorInput extends ChainInputs {
     agent: BaseSingleActionAgent | BaseMultiActionAgent;
     tools: this["agent"]["ToolType"][];
@@ -28,6 +33,12 @@ export declare class AgentExecutor extends BaseChain {
     constructor(input: AgentExecutorInput);
     /** Create from agent and a list of tools. */
     static fromAgentAndTools(fields: AgentExecutorInput): AgentExecutor;
+    /**
+     * Method that checks if the agent execution should continue based on the
+     * number of iterations.
+     * @param iterations The current number of iterations.
+     * @returns A boolean indicating whether the agent execution should continue.
+     */
     private shouldContinue;
     /** @ignore */
     _call(inputs: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;

package/dist/agents/executor.js

@@ -67,6 +67,12 @@ export class AgentExecutor extends BaseChain {
     static fromAgentAndTools(fields) {
         return new AgentExecutor(fields);
     }
+    /**
+     * Method that checks if the agent execution should continue based on the
+     * number of iterations.
+     * @param iterations The current number of iterations.
+     * @returns A boolean indicating whether the agent execution should continue.
+     */
     shouldContinue(iterations) {
         return this.maxIterations === undefined || iterations < this.maxIterations;
     }

package/dist/agents/initialize.d.ts

@@ -7,6 +7,11 @@ import { StructuredChatAgent } from "./structured_chat/index.js";
 import { AgentExecutor, AgentExecutorInput } from "./executor.js";
 import { ZeroShotAgent } from "./mrkl/index.js";
 import { OpenAIAgent } from "./openai/index.js";
+/**
+ * Represents the type of an agent in LangChain. It can be
+ * "zero-shot-react-description", "chat-zero-shot-react-description", or
+ * "chat-conversational-react-description".
+ */
 type AgentType = "zero-shot-react-description" | "chat-zero-shot-react-description" | "chat-conversational-react-description";
 /**
  * @deprecated use initializeAgentExecutorWithOptions instead

package/dist/agents/mrkl/index.cjs

@@ -35,9 +35,19 @@ class ZeroShotAgent extends agent_js_1.Agent {
     llmPrefix() {
         return "Thought:";
     }
+    /**
+     * Returns the default output parser for the ZeroShotAgent.
+     * @param fields Optional arguments for the output parser.
+     * @returns An instance of ZeroShotAgentOutputParser.
+     */
     static getDefaultOutputParser(fields) {
         return new outputParser_js_1.ZeroShotAgentOutputParser(fields);
     }
+    /**
+     * Validates the tools for the ZeroShotAgent. Throws an error if any tool
+     * does not have a description.
+     * @param tools List of tools to validate.
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -70,6 +80,13 @@ class ZeroShotAgent extends agent_js_1.Agent {
             inputVariables,
         });
     }
+    /**
+     * Creates a ZeroShotAgent from a Large Language Model and a set of tools.
+     * @param llm The Large Language Model to use.
+     * @param tools The tools for the agent to use.
+     * @param args Optional arguments for creating the agent.
+     * @returns A new instance of ZeroShotAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         ZeroShotAgent.validateTools(tools);
         const prompt = ZeroShotAgent.createPrompt(tools, args);

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

@@ -5,6 +5,9 @@ import { Optional } from "../../types/type-utils.js";
 import { Agent, AgentArgs, OutputParserArgs } from "../agent.js";
 import { AgentInput, SerializedZeroShotAgent } from "../types.js";
 import { ZeroShotAgentOutputParser } from "./outputParser.js";
+/**
+ * Interface for creating a prompt for the ZeroShotAgent.
+ */
 export interface ZeroShotCreatePromptArgs {
     /** String to put after the list of tools. */
     suffix?: string;
@@ -13,6 +16,10 @@ export interface ZeroShotCreatePromptArgs {
     /** List of input variables the final prompt will expect. */
     inputVariables?: string[];
 }
+/**
+ * Type for the input to the ZeroShotAgent, with the 'outputParser'
+ * property made optional.
+ */
 export type ZeroShotAgentInput = Optional<AgentInput, "outputParser">;
 /**
  * Agent for the MRKL chain.
@@ -26,7 +33,17 @@ export declare class ZeroShotAgent extends Agent {
     _agentType(): "zero-shot-react-description";
     observationPrefix(): string;
     llmPrefix(): string;
+    /**
+     * Returns the default output parser for the ZeroShotAgent.
+     * @param fields Optional arguments for the output parser.
+     * @returns An instance of ZeroShotAgentOutputParser.
+     */
     static getDefaultOutputParser(fields?: OutputParserArgs): ZeroShotAgentOutputParser;
+    /**
+     * Validates the tools for the ZeroShotAgent. Throws an error if any tool
+     * does not have a description.
+     * @param tools List of tools to validate.
+     */
     static validateTools(tools: Tool[]): void;
     /**
      * Create prompt in the style of the zero shot agent.
@@ -38,6 +55,13 @@ export declare class ZeroShotAgent extends Agent {
      * @param args.inputVariables - List of input variables the final prompt will expect.
      */
     static createPrompt(tools: Tool[], args?: ZeroShotCreatePromptArgs): PromptTemplate<any, any>;
+    /**
+     * Creates a ZeroShotAgent from a Large Language Model and a set of tools.
+     * @param llm The Large Language Model to use.
+     * @param tools The tools for the agent to use.
+     * @param args Optional arguments for creating the agent.
+     * @returns A new instance of ZeroShotAgent.
+     */
     static fromLLMAndTools(llm: BaseLanguageModel, tools: Tool[], args?: ZeroShotCreatePromptArgs & AgentArgs): ZeroShotAgent;
     static deserialize(data: SerializedZeroShotAgent & {
         llm?: BaseLanguageModel;

package/dist/agents/mrkl/index.js

@@ -32,9 +32,19 @@ export class ZeroShotAgent extends Agent {
     llmPrefix() {
         return "Thought:";
     }
+    /**
+     * Returns the default output parser for the ZeroShotAgent.
+     * @param fields Optional arguments for the output parser.
+     * @returns An instance of ZeroShotAgentOutputParser.
+     */
     static getDefaultOutputParser(fields) {
         return new ZeroShotAgentOutputParser(fields);
     }
+    /**
+     * Validates the tools for the ZeroShotAgent. Throws an error if any tool
+     * does not have a description.
+     * @param tools List of tools to validate.
+     */
     static validateTools(tools) {
         const descriptionlessTool = tools.find((tool) => !tool.description);
         if (descriptionlessTool) {
@@ -67,6 +77,13 @@ export class ZeroShotAgent extends Agent {
             inputVariables,
         });
     }
+    /**
+     * Creates a ZeroShotAgent from a Large Language Model and a set of tools.
+     * @param llm The Large Language Model to use.
+     * @param tools The tools for the agent to use.
+     * @param args Optional arguments for creating the agent.
+     * @returns A new instance of ZeroShotAgent.
+     */
     static fromLLMAndTools(llm, tools, args) {
         ZeroShotAgent.validateTools(tools);
         const prompt = ZeroShotAgent.createPrompt(tools, args);

package/dist/agents/mrkl/outputParser.cjs

@@ -4,6 +4,10 @@ exports.ZeroShotAgentOutputParser = 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 `AgentActionOutputParser` to provide a custom
+ * implementation for parsing the output of a ZeroShotAgent action.
+ */
 class ZeroShotAgentOutputParser extends types_js_1.AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -21,6 +25,12 @@ class ZeroShotAgentOutputParser extends types_js_1.AgentActionOutputParser {
         });
         this.finishToolName = fields?.finishToolName || exports.FINAL_ANSWER_ACTION;
     }
+    /**
+     * Parses the text output of an agent action, extracting the tool, tool
+     * input, and output.
+     * @param text The text output of an agent action.
+     * @returns An object containing the tool, tool input, and output extracted from the text, along with the original text as a log.
+     */
     async parse(text) {
         if (text.includes(this.finishToolName)) {
             const parts = text.split(this.finishToolName);
@@ -42,6 +52,11 @@ class ZeroShotAgentOutputParser extends types_js_1.AgentActionOutputParser {
             log: text,
         };
     }
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the ZeroShotAgent.
+     * @returns The format instructions for parsing the output.
+     */
     getFormatInstructions() {
         return prompt_js_1.FORMAT_INSTRUCTIONS;
     }

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

@@ -1,10 +1,20 @@
 import { OutputParserArgs } from "../agent.js";
 import { AgentActionOutputParser } from "../types.js";
 export declare const FINAL_ANSWER_ACTION = "Final Answer:";
+/**
+ * A class that extends `AgentActionOutputParser` to provide a custom
+ * implementation for parsing the output of a ZeroShotAgent action.
+ */
 export declare class ZeroShotAgentOutputParser extends AgentActionOutputParser {
     lc_namespace: string[];
     finishToolName: string;
     constructor(fields?: OutputParserArgs);
+    /**
+     * Parses the text output of an agent action, extracting the tool, tool
+     * input, and output.
+     * @param text The text output of an agent action.
+     * @returns An object containing the tool, tool input, and output extracted from the text, along with the original text as a log.
+     */
     parse(text: string): Promise<{
         returnValues: {
             output: string;
@@ -18,5 +28,10 @@ export declare class ZeroShotAgentOutputParser extends AgentActionOutputParser {
         log: string;
         returnValues?: undefined;
     }>;
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the ZeroShotAgent.
+     * @returns The format instructions for parsing the output.
+     */
     getFormatInstructions(): string;
 }

package/dist/agents/mrkl/outputParser.js

@@ -1,6 +1,10 @@
 import { AgentActionOutputParser } from "../types.js";
 import { FORMAT_INSTRUCTIONS } from "./prompt.js";
 export const FINAL_ANSWER_ACTION = "Final Answer:";
+/**
+ * A class that extends `AgentActionOutputParser` to provide a custom
+ * implementation for parsing the output of a ZeroShotAgent action.
+ */
 export class ZeroShotAgentOutputParser extends AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -18,6 +22,12 @@ export class ZeroShotAgentOutputParser extends AgentActionOutputParser {
         });
         this.finishToolName = fields?.finishToolName || FINAL_ANSWER_ACTION;
     }
+    /**
+     * Parses the text output of an agent action, extracting the tool, tool
+     * input, and output.
+     * @param text The text output of an agent action.
+     * @returns An object containing the tool, tool input, and output extracted from the text, along with the original text as a log.
+     */
     async parse(text) {
         if (text.includes(this.finishToolName)) {
             const parts = text.split(this.finishToolName);
@@ -39,6 +49,11 @@ export class ZeroShotAgentOutputParser extends AgentActionOutputParser {
             log: text,
         };
     }
+    /**
+     * Returns the format instructions for parsing the output of an agent
+     * action in the style of the ZeroShotAgent.
+     * @returns The format instructions for parsing the output.
+     */
     getFormatInstructions() {
         return FORMAT_INSTRUCTIONS;
     }

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,6 +56,11 @@ 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";
@@ -77,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([
@@ -86,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") {
@@ -103,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,13 +6,25 @@ 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[];
@@ -22,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>;
 }