langchain 0.0.130 → 0.0.132

package/dist/agents/structured_chat/outputParser.js

@@ -3,6 +3,12 @@ import { AGENT_ACTION_FORMAT_INSTRUCTIONS, FORMAT_INSTRUCTIONS, } from "./prompt
 import { OutputFixingParser } from "../../output_parsers/fix.js";
 import { OutputParserException } from "../../schema/output_parser.js";
 import { renderTemplate } from "../../prompts/index.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 class StructuredChatOutputParser extends AgentActionOutputParser {
     constructor(fields) {
         super(...arguments);
@@ -20,6 +26,14 @@ export class StructuredChatOutputParser extends 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;
@@ -38,12 +52,23 @@ export class StructuredChatOutputParser extends AgentActionOutputParser {
             throw new 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 renderTemplate(AGENT_ACTION_FORMAT_INSTRUCTIONS, "f-string", {
             tool_names: this.toolNames.join(", "),
         });
     }
 }
+/**
+ * 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 class StructuredChatOutputParserWithRetries extends AgentActionOutputParser {
     constructor(fields) {
         super(fields);
@@ -77,17 +102,36 @@ export class StructuredChatOutputParserWithRetries extends AgentActionOutputPars
                 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 renderTemplate(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/toolkits/aws_sfn.cjs

@@ -19,6 +19,11 @@ exports.SFN_SUFFIX = `Begin!
 Question: {input}
 Thought: I should look at state machines within AWS Step Functions to see what actions I can perform.
 {agent_scratchpad}`;
+/**
+ * Class representing a toolkit for interacting with AWS Step Functions.
+ * It initializes the AWS Step Functions tools and provides them as tools
+ * for the agent.
+ */
 class AWSSfnToolkit extends base_js_1.Toolkit {
     constructor(args) {
         super();

package/dist/agents/toolkits/aws_sfn.d.ts

@@ -8,6 +8,10 @@ export declare const SFN_PREFIX = "You are an agent designed to interact with AW
 export declare const SFN_SUFFIX = "Begin!\n\nQuestion: {input}\nThought: I should look at state machines within AWS Step Functions to see what actions I can perform.\n{agent_scratchpad}";
 export interface AWSSfnCreatePromptArgs extends ZeroShotCreatePromptArgs {
 }
+/**
+ * Interface for the arguments required to create an AWS Step Functions
+ * toolkit.
+ */
 export interface AWSSfnToolkitArgs {
     name: string;
     description: string;
@@ -15,6 +19,11 @@ export interface AWSSfnToolkitArgs {
     asl?: string;
     llm?: BaseLanguageModel;
 }
+/**
+ * Class representing a toolkit for interacting with AWS Step Functions.
+ * It initializes the AWS Step Functions tools and provides them as tools
+ * for the agent.
+ */
 export declare class AWSSfnToolkit extends Toolkit {
     tools: Tool[];
     stateMachineArn: string;

package/dist/agents/toolkits/aws_sfn.js

@@ -16,6 +16,11 @@ export const SFN_SUFFIX = `Begin!
 Question: {input}
 Thought: I should look at state machines within AWS Step Functions to see what actions I can perform.
 {agent_scratchpad}`;
+/**
+ * Class representing a toolkit for interacting with AWS Step Functions.
+ * It initializes the AWS Step Functions tools and provides them as tools
+ * for the agent.
+ */
 export class AWSSfnToolkit extends Toolkit {
     constructor(args) {
         super();

package/dist/agents/toolkits/base.cjs

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Toolkit = void 0;
+/**
+ * Abstract base class for toolkits in LangChain. Toolkits are collections
+ * of tools that agents can use. Subclasses must implement the `tools`
+ * property to provide the specific tools for the toolkit.
+ */
 class Toolkit {
 }
 exports.Toolkit = Toolkit;

package/dist/agents/toolkits/base.d.ts

@@ -1,4 +1,9 @@
 import { Tool } from "../../tools/base.js";
+/**
+ * Abstract base class for toolkits in LangChain. Toolkits are collections
+ * of tools that agents can use. Subclasses must implement the `tools`
+ * property to provide the specific tools for the toolkit.
+ */
 export declare abstract class Toolkit {
     abstract tools: Tool[];
 }

package/dist/agents/toolkits/base.js

@@ -1,2 +1,7 @@
+/**
+ * Abstract base class for toolkits in LangChain. Toolkits are collections
+ * of tools that agents can use. Subclasses must implement the `tools`
+ * property to provide the specific tools for the toolkit.
+ */
 export class Toolkit {
 }

package/dist/agents/toolkits/conversational_retrieval/openai_functions.cjs

@@ -4,6 +4,16 @@ exports.createConversationalRetrievalAgent = void 0;
 const summary_buffer_js_1 = require("../../../memory/summary_buffer.cjs");
 const initialize_js_1 = require("../../initialize.cjs");
 const token_buffer_memory_js_1 = require("./token_buffer_memory.cjs");
+/**
+ * Asynchronous function that creates a conversational retrieval agent
+ * using a language model, tools, and options. It initializes the buffer
+ * memory based on the provided options and initializes the AgentExecutor
+ * with the tools, language model, and memory.
+ * @param llm Instance of ChatOpenAI used as the language model for the agent.
+ * @param tools Array of StructuredTool instances used by the agent.
+ * @param options Optional ConversationalRetrievalAgentOptions to customize the agent.
+ * @returns A Promise that resolves to an initialized AgentExecutor.
+ */
 async function createConversationalRetrievalAgent(llm, tools, options) {
     const { rememberIntermediateSteps = true, memoryKey = "chat_history", outputKey = "output", prefix, verbose, } = options ?? {};
     let memory;

package/dist/agents/toolkits/conversational_retrieval/openai_functions.d.ts

@@ -7,4 +7,14 @@ export type ConversationalRetrievalAgentOptions = {
     prefix?: string;
     verbose?: boolean;
 };
+/**
+ * Asynchronous function that creates a conversational retrieval agent
+ * using a language model, tools, and options. It initializes the buffer
+ * memory based on the provided options and initializes the AgentExecutor
+ * with the tools, language model, and memory.
+ * @param llm Instance of ChatOpenAI used as the language model for the agent.
+ * @param tools Array of StructuredTool instances used by the agent.
+ * @param options Optional ConversationalRetrievalAgentOptions to customize the agent.
+ * @returns A Promise that resolves to an initialized AgentExecutor.
+ */
 export declare function createConversationalRetrievalAgent(llm: ChatOpenAI, tools: StructuredTool[], options?: ConversationalRetrievalAgentOptions): Promise<import("../../executor.js").AgentExecutor>;

package/dist/agents/toolkits/conversational_retrieval/openai_functions.js

@@ -1,6 +1,16 @@
 import { ConversationSummaryBufferMemory } from "../../../memory/summary_buffer.js";
 import { initializeAgentExecutorWithOptions } from "../../initialize.js";
 import { OpenAIAgentTokenBufferMemory } from "./token_buffer_memory.js";
+/**
+ * Asynchronous function that creates a conversational retrieval agent
+ * using a language model, tools, and options. It initializes the buffer
+ * memory based on the provided options and initializes the AgentExecutor
+ * with the tools, language model, and memory.
+ * @param llm Instance of ChatOpenAI used as the language model for the agent.
+ * @param tools Array of StructuredTool instances used by the agent.
+ * @param options Optional ConversationalRetrievalAgentOptions to customize the agent.
+ * @returns A Promise that resolves to an initialized AgentExecutor.
+ */
 export async function createConversationalRetrievalAgent(llm, tools, options) {
     const { rememberIntermediateSteps = true, memoryKey = "chat_history", outputKey = "output", prefix, verbose, } = options ?? {};
     let memory;

package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.cjs

@@ -71,9 +71,18 @@ class OpenAIAgentTokenBufferMemory extends chat_memory_js_1.BaseChatMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Retrieves the messages from the chat history.
+     * @returns Promise that resolves with the messages from the chat history.
+     */
     async getMessages() {
         return this.chatHistory.getMessages();
     }
+    /**
+     * Loads memory variables from the input values.
+     * @param _values Input values.
+     * @returns Promise that resolves with the loaded memory variables.
+     */
     async loadMemoryVariables(_values) {
         const buffer = await this.getMessages();
         if (this.returnMessages) {
@@ -84,6 +93,14 @@ class OpenAIAgentTokenBufferMemory extends chat_memory_js_1.BaseChatMemory {
             return { [this.memoryKey]: bufferString };
         }
     }
+    /**
+     * Saves the context of the chat, including user input, AI output, and
+     * intermediate steps. Prunes the chat history if the total token count
+     * exceeds the maximum limit.
+     * @param inputValues Input values.
+     * @param outputValues Output values.
+     * @returns Promise that resolves when the context has been saved.
+     */
     async saveContext(inputValues, outputValues) {
         const inputValue = (0, base_js_1.getInputValue)(inputValues, this.inputKey);
         const outputValue = (0, base_js_1.getOutputValue)(outputValues, this.outputKey);

package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.d.ts

@@ -1,6 +1,10 @@
 import { ChatOpenAI } from "../../../chat_models/openai.js";
 import { InputValues, MemoryVariables, OutputValues } from "../../../memory/base.js";
 import { BaseChatMemory, BaseChatMemoryInput } from "../../../memory/chat_memory.js";
+/**
+ * Type definition for the fields required to initialize an instance of
+ * OpenAIAgentTokenBufferMemory.
+ */
 export type OpenAIAgentTokenBufferMemoryFields = BaseChatMemoryInput & {
     llm: ChatOpenAI;
     humanPrefix?: string;
@@ -25,7 +29,24 @@ export declare class OpenAIAgentTokenBufferMemory extends BaseChatMemory {
     intermediateStepsKey: string;
     constructor(fields: OpenAIAgentTokenBufferMemoryFields);
     get memoryKeys(): string[];
+    /**
+     * Retrieves the messages from the chat history.
+     * @returns Promise that resolves with the messages from the chat history.
+     */
     getMessages(): Promise<import("../../../schema/index.js").BaseMessage[]>;
+    /**
+     * Loads memory variables from the input values.
+     * @param _values Input values.
+     * @returns Promise that resolves with the loaded memory variables.
+     */
     loadMemoryVariables(_values: InputValues): Promise<MemoryVariables>;
+    /**
+     * Saves the context of the chat, including user input, AI output, and
+     * intermediate steps. Prunes the chat history if the total token count
+     * exceeds the maximum limit.
+     * @param inputValues Input values.
+     * @param outputValues Output values.
+     * @returns Promise that resolves when the context has been saved.
+     */
     saveContext(inputValues: InputValues, outputValues: OutputValues): Promise<void>;
 }

package/dist/agents/toolkits/conversational_retrieval/token_buffer_memory.js

@@ -68,9 +68,18 @@ export class OpenAIAgentTokenBufferMemory extends BaseChatMemory {
     get memoryKeys() {
         return [this.memoryKey];
     }
+    /**
+     * Retrieves the messages from the chat history.
+     * @returns Promise that resolves with the messages from the chat history.
+     */
     async getMessages() {
         return this.chatHistory.getMessages();
     }
+    /**
+     * Loads memory variables from the input values.
+     * @param _values Input values.
+     * @returns Promise that resolves with the loaded memory variables.
+     */
     async loadMemoryVariables(_values) {
         const buffer = await this.getMessages();
         if (this.returnMessages) {
@@ -81,6 +90,14 @@ export class OpenAIAgentTokenBufferMemory extends BaseChatMemory {
             return { [this.memoryKey]: bufferString };
         }
     }
+    /**
+     * Saves the context of the chat, including user input, AI output, and
+     * intermediate steps. Prunes the chat history if the total token count
+     * exceeds the maximum limit.
+     * @param inputValues Input values.
+     * @param outputValues Output values.
+     * @returns Promise that resolves when the context has been saved.
+     */
     async saveContext(inputValues, outputValues) {
         const inputValue = getInputValue(inputValues, this.inputKey);
         const outputValue = getOutputValue(outputValues, this.outputKey);

package/dist/agents/toolkits/json/json.cjs

@@ -7,6 +7,10 @@ const llm_chain_js_1 = require("../../../chains/llm_chain.cjs");
 const index_js_1 = require("../../mrkl/index.cjs");
 const base_js_1 = require("../base.cjs");
 const executor_js_1 = require("../../executor.cjs");
+/**
+ * Represents a toolkit for working with JSON data. It initializes the
+ * JSON tools based on the provided JSON specification.
+ */
 class JsonToolkit extends base_js_1.Toolkit {
     constructor(jsonSpec) {
         super();
@@ -29,6 +33,17 @@ class JsonToolkit extends base_js_1.Toolkit {
     }
 }
 exports.JsonToolkit = JsonToolkit;
+/**
+ * Creates a JSON agent using a language model, a JSON toolkit, and
+ * optional prompt arguments. It creates a prompt for the agent using the
+ * JSON tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the JSON tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model used to create the JSON agent.
+ * @param toolkit The JSON toolkit used to create the JSON agent.
+ * @param args Optional prompt arguments used to create the JSON agent.
+ * @returns An AgentExecutor for executing the created JSON agent with the tools.
+ */
 function createJsonAgent(llm, toolkit, args) {
     const { prefix = prompt_js_1.JSON_PREFIX, suffix = prompt_js_1.JSON_SUFFIX, inputVariables = ["input", "agent_scratchpad"], } = args ?? {};
     const { tools } = toolkit;

package/dist/agents/toolkits/json/json.d.ts

@@ -4,9 +4,24 @@ import { JsonSpec } from "../../../tools/json.js";
 import { ZeroShotCreatePromptArgs } from "../../mrkl/index.js";
 import { Toolkit } from "../base.js";
 import { AgentExecutor } from "../../executor.js";
+/**
+ * Represents a toolkit for working with JSON data. It initializes the
+ * JSON tools based on the provided JSON specification.
+ */
 export declare class JsonToolkit extends Toolkit {
     jsonSpec: JsonSpec;
     tools: Tool[];
     constructor(jsonSpec: JsonSpec);
 }
+/**
+ * Creates a JSON agent using a language model, a JSON toolkit, and
+ * optional prompt arguments. It creates a prompt for the agent using the
+ * JSON tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the JSON tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model used to create the JSON agent.
+ * @param toolkit The JSON toolkit used to create the JSON agent.
+ * @param args Optional prompt arguments used to create the JSON agent.
+ * @returns An AgentExecutor for executing the created JSON agent with the tools.
+ */
 export declare function createJsonAgent(llm: BaseLanguageModel, toolkit: JsonToolkit, args?: ZeroShotCreatePromptArgs): AgentExecutor;

package/dist/agents/toolkits/json/json.js

@@ -4,6 +4,10 @@ import { LLMChain } from "../../../chains/llm_chain.js";
 import { ZeroShotAgent } from "../../mrkl/index.js";
 import { Toolkit } from "../base.js";
 import { AgentExecutor } from "../../executor.js";
+/**
+ * Represents a toolkit for working with JSON data. It initializes the
+ * JSON tools based on the provided JSON specification.
+ */
 export class JsonToolkit extends Toolkit {
     constructor(jsonSpec) {
         super();
@@ -25,6 +29,17 @@ export class JsonToolkit extends Toolkit {
         ];
     }
 }
+/**
+ * Creates a JSON agent using a language model, a JSON toolkit, and
+ * optional prompt arguments. It creates a prompt for the agent using the
+ * JSON tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the JSON tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model used to create the JSON agent.
+ * @param toolkit The JSON toolkit used to create the JSON agent.
+ * @param args Optional prompt arguments used to create the JSON agent.
+ * @returns An AgentExecutor for executing the created JSON agent with the tools.
+ */
 export function createJsonAgent(llm, toolkit, args) {
     const { prefix = JSON_PREFIX, suffix = JSON_SUFFIX, inputVariables = ["input", "agent_scratchpad"], } = args ?? {};
     const { tools } = toolkit;

package/dist/agents/toolkits/openapi/openapi.cjs

@@ -9,6 +9,10 @@ const index_js_1 = require("../../mrkl/index.cjs");
 const base_js_1 = require("../base.cjs");
 const requests_js_1 = require("../../../tools/requests.cjs");
 const json_js_1 = require("../json/json.cjs");
+/**
+ * Represents a toolkit for making HTTP requests. It initializes the
+ * request tools based on the provided headers.
+ */
 class RequestsToolkit extends base_js_1.Toolkit {
     constructor(headers) {
         super();
@@ -22,6 +26,12 @@ class RequestsToolkit extends base_js_1.Toolkit {
     }
 }
 exports.RequestsToolkit = RequestsToolkit;
+/**
+ * Extends the `RequestsToolkit` class and adds a dynamic tool for
+ * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
+ * and the provided language model, and adds the JSON explorer tool to the
+ * toolkit.
+ */
 class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec, llm, headers) {
         super(headers);
@@ -40,6 +50,17 @@ class OpenApiToolkit extends RequestsToolkit {
     }
 }
 exports.OpenApiToolkit = OpenApiToolkit;
+/**
+ * Creates an OpenAPI agent using a language model, an OpenAPI toolkit,
+ * and optional prompt arguments. It creates a prompt for the agent using
+ * the OpenAPI tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the OpenAPI tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model to use.
+ * @param openApiToolkit The OpenAPI toolkit to use.
+ * @param args Optional arguments for creating the prompt.
+ * @returns An AgentExecutor for executing the agent with the tools.
+ */
 function createOpenApiAgent(llm, openApiToolkit, args) {
     const { prefix = prompt_js_1.OPENAPI_PREFIX, suffix = prompt_js_1.OPENAPI_SUFFIX, inputVariables = ["input", "agent_scratchpad"], } = args ?? {};
     const { tools } = openApiToolkit;

package/dist/agents/toolkits/openapi/openapi.d.ts

@@ -5,11 +5,32 @@ import { AgentExecutor } from "../../executor.js";
 import { ZeroShotCreatePromptArgs } from "../../mrkl/index.js";
 import { Toolkit } from "../base.js";
 import { Headers } from "../../../tools/requests.js";
+/**
+ * Represents a toolkit for making HTTP requests. It initializes the
+ * request tools based on the provided headers.
+ */
 export declare class RequestsToolkit extends Toolkit {
     tools: Tool[];
     constructor(headers?: Headers);
 }
+/**
+ * Extends the `RequestsToolkit` class and adds a dynamic tool for
+ * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
+ * and the provided language model, and adds the JSON explorer tool to the
+ * toolkit.
+ */
 export declare class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec: JsonSpec, llm: BaseLanguageModel, headers?: Headers);
 }
+/**
+ * Creates an OpenAPI agent using a language model, an OpenAPI toolkit,
+ * and optional prompt arguments. It creates a prompt for the agent using
+ * the OpenAPI tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the OpenAPI tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model to use.
+ * @param openApiToolkit The OpenAPI toolkit to use.
+ * @param args Optional arguments for creating the prompt.
+ * @returns An AgentExecutor for executing the agent with the tools.
+ */
 export declare function createOpenApiAgent(llm: BaseLanguageModel, openApiToolkit: OpenApiToolkit, args?: ZeroShotCreatePromptArgs): AgentExecutor;

package/dist/agents/toolkits/openapi/openapi.js

@@ -6,6 +6,10 @@ import { ZeroShotAgent } from "../../mrkl/index.js";
 import { Toolkit } from "../base.js";
 import { RequestsGetTool, RequestsPostTool, } from "../../../tools/requests.js";
 import { createJsonAgent, JsonToolkit } from "../json/json.js";
+/**
+ * Represents a toolkit for making HTTP requests. It initializes the
+ * request tools based on the provided headers.
+ */
 export class RequestsToolkit extends Toolkit {
     constructor(headers) {
         super();
@@ -18,6 +22,12 @@ export class RequestsToolkit extends Toolkit {
         this.tools = [new RequestsGetTool(headers), new RequestsPostTool(headers)];
     }
 }
+/**
+ * Extends the `RequestsToolkit` class and adds a dynamic tool for
+ * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
+ * and the provided language model, and adds the JSON explorer tool to the
+ * toolkit.
+ */
 export class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec, llm, headers) {
         super(headers);
@@ -35,6 +45,17 @@ export class OpenApiToolkit extends RequestsToolkit {
         ];
     }
 }
+/**
+ * Creates an OpenAPI agent using a language model, an OpenAPI toolkit,
+ * and optional prompt arguments. It creates a prompt for the agent using
+ * the OpenAPI tools and the provided prefix and suffix. It then creates a
+ * ZeroShotAgent with the prompt and the OpenAPI tools, and returns an
+ * AgentExecutor for executing the agent with the tools.
+ * @param llm The language model to use.
+ * @param openApiToolkit The OpenAPI toolkit to use.
+ * @param args Optional arguments for creating the prompt.
+ * @returns An AgentExecutor for executing the agent with the tools.
+ */
 export function createOpenApiAgent(llm, openApiToolkit, args) {
     const { prefix = OPENAPI_PREFIX, suffix = OPENAPI_SUFFIX, inputVariables = ["input", "agent_scratchpad"], } = args ?? {};
     const { tools } = openApiToolkit;

package/dist/agents/toolkits/sql/sql.cjs

@@ -8,6 +8,10 @@ const template_js_1 = require("../../../prompts/template.cjs");
 const llm_chain_js_1 = require("../../../chains/llm_chain.cjs");
 const index_js_1 = require("../../mrkl/index.cjs");
 const executor_js_1 = require("../../executor.cjs");
+/**
+ * Class that represents a toolkit for working with SQL databases. It
+ * initializes SQL tools based on the provided SQL database.
+ */
 class SqlToolkit extends base_js_1.Toolkit {
     constructor(db, llm) {
         super();

package/dist/agents/toolkits/sql/sql.d.ts

@@ -4,10 +4,18 @@ import { BaseLanguageModel } from "../../../base_language/index.js";
 import { ZeroShotCreatePromptArgs } from "../../mrkl/index.js";
 import { AgentExecutor } from "../../executor.js";
 import { SqlDatabase } from "../../../sql_db.js";
+/**
+ * Interface that extends ZeroShotCreatePromptArgs and adds an optional
+ * topK parameter for specifying the number of results to return.
+ */
 export interface SqlCreatePromptArgs extends ZeroShotCreatePromptArgs {
     /** Number of results to return. */
     topK?: number;
 }
+/**
+ * Class that represents a toolkit for working with SQL databases. It
+ * initializes SQL tools based on the provided SQL database.
+ */
 export declare class SqlToolkit extends Toolkit {
     tools: Tool[];
     db: SqlDatabase;

package/dist/agents/toolkits/sql/sql.js

@@ -5,6 +5,10 @@ import { renderTemplate } from "../../../prompts/template.js";
 import { LLMChain } from "../../../chains/llm_chain.js";
 import { ZeroShotAgent } from "../../mrkl/index.js";
 import { AgentExecutor } from "../../executor.js";
+/**
+ * Class that represents a toolkit for working with SQL databases. It
+ * initializes SQL tools based on the provided SQL database.
+ */
 export class SqlToolkit extends Toolkit {
     constructor(db, llm) {
         super();

package/dist/agents/toolkits/vectorstore/vectorstore.cjs

@@ -8,6 +8,11 @@ const prompt_js_1 = require("./prompt.cjs");
 const prompt_js_2 = require("../../mrkl/prompt.cjs");
 const llm_chain_js_1 = require("../../../chains/llm_chain.cjs");
 const executor_js_1 = require("../../executor.cjs");
+/**
+ * Class representing a toolkit for working with a single vector store. It
+ * initializes the vector store QA tool based on the provided vector store
+ * information and language model.
+ */
 class VectorStoreToolkit extends base_js_1.Toolkit {
     constructor(vectorStoreInfo, llm) {
         super();
@@ -34,6 +39,11 @@ class VectorStoreToolkit extends base_js_1.Toolkit {
     }
 }
 exports.VectorStoreToolkit = VectorStoreToolkit;
+/**
+ * Class representing a toolkit for working with multiple vector stores.
+ * It initializes multiple vector store QA tools based on the provided
+ * vector store information and language model.
+ */
 class VectorStoreRouterToolkit extends base_js_1.Toolkit {
     constructor(vectorStoreInfos, llm) {
         super();

package/dist/agents/toolkits/vectorstore/vectorstore.d.ts

@@ -4,16 +4,30 @@ import { Toolkit } from "../base.js";
 import { BaseLanguageModel } from "../../../base_language/index.js";
 import { ZeroShotCreatePromptArgs } from "../../mrkl/index.js";
 import { AgentExecutor } from "../../executor.js";
+/**
+ * Interface that defines the information about a vector store, including
+ * the vector store itself, its name, and description.
+ */
 export interface VectorStoreInfo {
     vectorStore: VectorStore;
     name: string;
     description: string;
 }
+/**
+ * Class representing a toolkit for working with a single vector store. It
+ * initializes the vector store QA tool based on the provided vector store
+ * information and language model.
+ */
 export declare class VectorStoreToolkit extends Toolkit {
     tools: Tool[];
     llm: BaseLanguageModel;
     constructor(vectorStoreInfo: VectorStoreInfo, llm: BaseLanguageModel);
 }
+/**
+ * Class representing a toolkit for working with multiple vector stores.
+ * It initializes multiple vector store QA tools based on the provided
+ * vector store information and language model.
+ */
 export declare class VectorStoreRouterToolkit extends Toolkit {
     tools: Tool[];
     vectorStoreInfos: VectorStoreInfo[];

package/dist/agents/toolkits/vectorstore/vectorstore.js

@@ -5,6 +5,11 @@ import { VECTOR_PREFIX, VECTOR_ROUTER_PREFIX } from "./prompt.js";
 import { SUFFIX } from "../../mrkl/prompt.js";
 import { LLMChain } from "../../../chains/llm_chain.js";
 import { AgentExecutor } from "../../executor.js";
+/**
+ * Class representing a toolkit for working with a single vector store. It
+ * initializes the vector store QA tool based on the provided vector store
+ * information and language model.
+ */
 export class VectorStoreToolkit extends Toolkit {
     constructor(vectorStoreInfo, llm) {
         super();
@@ -30,6 +35,11 @@ export class VectorStoreToolkit extends Toolkit {
         ];
     }
 }
+/**
+ * Class representing a toolkit for working with multiple vector stores.
+ * It initializes multiple vector store QA tools based on the provided
+ * vector store information and language model.
+ */
 export class VectorStoreRouterToolkit extends Toolkit {
     constructor(vectorStoreInfos, llm) {
         super();