langchain 0.0.131 → 0.0.132

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();

package/dist/agents/toolkits/zapier/zapier.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZapierToolKit = void 0;
 const base_js_1 = require("../base.cjs");
 const zapier_js_1 = require("../../../tools/zapier.cjs");
+/**
+ * Represents a toolkit for working with Zapier actions. It extends the
+ * Toolkit class and provides functionality for managing Zapier tools.
+ */
 class ZapierToolKit extends base_js_1.Toolkit {
     constructor() {
         super(...arguments);
@@ -13,6 +17,14 @@ class ZapierToolKit extends base_js_1.Toolkit {
             value: []
         });
     }
+    /**
+     * Creates a ZapierToolKit instance based on a ZapierNLAWrapper instance.
+     * It retrieves the list of available actions from the ZapierNLAWrapper
+     * and creates a ZapierNLARunAction tool for each action. The created
+     * tools are added to the tools property of the ZapierToolKit instance.
+     * @param zapierNLAWrapper The ZapierNLAWrapper instance to create the ZapierToolKit from.
+     * @returns A Promise that resolves to a ZapierToolKit instance.
+     */
     static async fromZapierNLAWrapper(zapierNLAWrapper) {
         const toolkit = new ZapierToolKit();
         const actions = await zapierNLAWrapper.listActions();

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

@@ -1,7 +1,19 @@
 import { Toolkit } from "../base.js";
 import { Tool } from "../../../tools/base.js";
 import { ZapierNLAWrapper } from "../../../tools/zapier.js";
+/**
+ * Represents a toolkit for working with Zapier actions. It extends the
+ * Toolkit class and provides functionality for managing Zapier tools.
+ */
 export declare class ZapierToolKit extends Toolkit {
     tools: Tool[];
+    /**
+     * Creates a ZapierToolKit instance based on a ZapierNLAWrapper instance.
+     * It retrieves the list of available actions from the ZapierNLAWrapper
+     * and creates a ZapierNLARunAction tool for each action. The created
+     * tools are added to the tools property of the ZapierToolKit instance.
+     * @param zapierNLAWrapper The ZapierNLAWrapper instance to create the ZapierToolKit from.
+     * @returns A Promise that resolves to a ZapierToolKit instance.
+     */
     static fromZapierNLAWrapper(zapierNLAWrapper: ZapierNLAWrapper): Promise<ZapierToolKit>;
 }

package/dist/agents/toolkits/zapier/zapier.js

@@ -1,5 +1,9 @@
 import { Toolkit } from "../base.js";
 import { ZapierNLARunAction } from "../../../tools/zapier.js";
+/**
+ * Represents a toolkit for working with Zapier actions. It extends the
+ * Toolkit class and provides functionality for managing Zapier tools.
+ */
 export class ZapierToolKit extends Toolkit {
     constructor() {
         super(...arguments);
@@ -10,6 +14,14 @@ export class ZapierToolKit extends Toolkit {
             value: []
         });
     }
+    /**
+     * Creates a ZapierToolKit instance based on a ZapierNLAWrapper instance.
+     * It retrieves the list of available actions from the ZapierNLAWrapper
+     * and creates a ZapierNLARunAction tool for each action. The created
+     * tools are added to the tools property of the ZapierToolKit instance.
+     * @param zapierNLAWrapper The ZapierNLAWrapper instance to create the ZapierToolKit from.
+     * @returns A Promise that resolves to a ZapierToolKit instance.
+     */
     static async fromZapierNLAWrapper(zapierNLAWrapper) {
         const toolkit = new ZapierToolKit();
         const actions = await zapierNLAWrapper.listActions();

package/dist/agents/types.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentActionOutputParser = void 0;
 const output_parser_js_1 = require("../schema/output_parser.cjs");
+/**
+ * Abstract class representing an output parser specifically for agent
+ * actions and finishes in LangChain. It extends the `BaseOutputParser`
+ * class.
+ */
 class AgentActionOutputParser extends output_parser_js_1.BaseOutputParser {
 }
 exports.AgentActionOutputParser = AgentActionOutputParser;

package/dist/agents/types.d.ts

@@ -2,14 +2,33 @@ import { LLMChain } from "../chains/llm_chain.js";
 import { SerializedLLMChain } from "../chains/serde.js";
 import { AgentAction, AgentFinish } from "../schema/index.js";
 import { BaseOutputParser } from "../schema/output_parser.js";
+/**
+ * Interface defining the input for creating an agent. It includes the
+ * LLMChain instance, an optional output parser, and an optional list of
+ * allowed tools.
+ */
 export interface AgentInput {
     llmChain: LLMChain;
     outputParser: AgentActionOutputParser | undefined;
     allowedTools?: string[];
 }
+/**
+ * Abstract class representing an output parser specifically for agent
+ * actions and finishes in LangChain. It extends the `BaseOutputParser`
+ * class.
+ */
 export declare abstract class AgentActionOutputParser extends BaseOutputParser<AgentAction | AgentFinish> {
 }
+/**
+ * Type representing the stopping method for an agent. It can be either
+ * 'force' or 'generate'.
+ */
 export type StoppingMethod = "force" | "generate";
+/**
+ * Generic type representing a serialized agent in LangChain. It includes
+ * the type of the agent, the serialized form of the LLMChain, and
+ * additional properties specific to the agent type.
+ */
 export type SerializedAgentT<TType extends string = string, FromLLMInput extends Record<string, unknown> = Record<string, unknown>, ConstructorInput extends AgentInput = AgentInput> = {
     _type: TType;
     llm_chain?: SerializedLLMChain;
@@ -23,5 +42,14 @@ export type SerializedFromLLMAndTools = {
     prefix?: string;
     input_variables?: string[];
 };
+/**
+ * Type representing a serialized ZeroShotAgent in LangChain. It extends
+ * the `SerializedAgentT` type and includes additional properties specific
+ * to the ZeroShotAgent.
+ */
 export type SerializedZeroShotAgent = SerializedAgentT<"zero-shot-react-description", SerializedFromLLMAndTools, AgentInput>;
+/**
+ * Type representing a serialized agent in LangChain. It is currently
+ * synonymous with `SerializedZeroShotAgent`.
+ */
 export type SerializedAgent = SerializedZeroShotAgent;

package/dist/agents/types.js

@@ -1,3 +1,8 @@
 import { BaseOutputParser } from "../schema/output_parser.js";
+/**
+ * Abstract class representing an output parser specifically for agent
+ * actions and finishes in LangChain. It extends the `BaseOutputParser`
+ * class.
+ */
 export class AgentActionOutputParser extends BaseOutputParser {
 }

package/dist/cache/index.cjs

@@ -4,6 +4,9 @@ exports.InMemoryCache = void 0;
 const base_js_1 = require("./base.cjs");
 const index_js_1 = require("../schema/index.cjs");
 const GLOBAL_MAP = new Map();
+/**
+ * A cache for storing LLM generations that stores data in memory.
+ */
 class InMemoryCache extends index_js_1.BaseCache {
     constructor(map) {
         super();
@@ -15,12 +18,30 @@ class InMemoryCache extends index_js_1.BaseCache {
         });
         this.cache = map ?? new Map();
     }
+    /**
+     * Retrieves data from the cache using a prompt and an LLM key. If the
+     * data is not found, it returns null.
+     * @param prompt The prompt used to find the data.
+     * @param llmKey The LLM key used to find the data.
+     * @returns The data corresponding to the prompt and LLM key, or null if not found.
+     */
     lookup(prompt, llmKey) {
         return Promise.resolve(this.cache.get((0, base_js_1.getCacheKey)(prompt, llmKey)) ?? null);
     }
+    /**
+     * Updates the cache with new data using a prompt and an LLM key.
+     * @param prompt The prompt used to store the data.
+     * @param llmKey The LLM key used to store the data.
+     * @param value The data to be stored.
+     */
     async update(prompt, llmKey, value) {
         this.cache.set((0, base_js_1.getCacheKey)(prompt, llmKey), value);
     }
+    /**
+     * Returns a global instance of InMemoryCache using a predefined global
+     * map as the initial cache.
+     * @returns A global instance of InMemoryCache.
+     */
     static global() {
         return new InMemoryCache(GLOBAL_MAP);
     }