langchain 0.0.130 → 0.0.132

package/dist/tools/bingserpapi.cjs

@@ -3,7 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BingSerpAPI = void 0;
 const env_js_1 = require("../util/env.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * A tool for web search functionality using Bing's search engine. It
+ * extends the base `Tool` class and implements the `_call` method to
+ * perform the search operation. Requires an API key for Bing's search
+ * engine, which can be set in the environment variables. Also accepts
+ * additional parameters for the search query.
+ */
 class BingSerpAPI extends base_js_1.Tool {
+    static lc_name() {
+        return "BingSerpAPI";
+    }
+    /**
+     * Not implemented. Will throw an error if called.
+     */
     toJSON() {
         return this.toJSONNotImplemented();
     }

package/dist/tools/bingserpapi.d.ts

@@ -1,5 +1,16 @@
 import { Tool } from "./base.js";
+/**
+ * A tool for web search functionality using Bing's search engine. It
+ * extends the base `Tool` class and implements the `_call` method to
+ * perform the search operation. Requires an API key for Bing's search
+ * engine, which can be set in the environment variables. Also accepts
+ * additional parameters for the search query.
+ */
 declare class BingSerpAPI extends Tool {
+    static lc_name(): string;
+    /**
+     * Not implemented. Will throw an error if called.
+     */
     toJSON(): import("../load/serializable.js").SerializedNotImplemented;
     name: string;
     description: string;

package/dist/tools/bingserpapi.js

@@ -1,6 +1,19 @@
 import { getEnvironmentVariable } from "../util/env.js";
 import { Tool } from "./base.js";
+/**
+ * A tool for web search functionality using Bing's search engine. It
+ * extends the base `Tool` class and implements the `_call` method to
+ * perform the search operation. Requires an API key for Bing's search
+ * engine, which can be set in the environment variables. Also accepts
+ * additional parameters for the search query.
+ */
 class BingSerpAPI extends Tool {
+    static lc_name() {
+        return "BingSerpAPI";
+    }
+    /**
+     * Not implemented. Will throw an error if called.
+     */
     toJSON() {
         return this.toJSONNotImplemented();
     }

package/dist/tools/brave_search.cjs

@@ -3,7 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BraveSearch = void 0;
 const env_js_1 = require("../util/env.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for interacting with the Brave Search engine. It extends the Tool
+ * class and requires an API key to function. The API key can be passed in
+ * during instantiation or set as an environment variable named
+ * 'BRAVE_SEARCH_API_KEY'.
+ */
 class BraveSearch extends base_js_1.Tool {
+    static lc_name() {
+        return "BraveSearch";
+    }
     constructor(fields = {
         apiKey: (0, env_js_1.getEnvironmentVariable)("BRAVE_SEARCH_API_KEY"),
     }) {

package/dist/tools/brave_search.d.ts

@@ -1,8 +1,19 @@
 import { Tool } from "./base.js";
+/**
+ * Interface for the parameters required to instantiate a BraveSearch
+ * instance.
+ */
 export interface BraveSearchParams {
     apiKey?: string;
 }
+/**
+ * Class for interacting with the Brave Search engine. It extends the Tool
+ * class and requires an API key to function. The API key can be passed in
+ * during instantiation or set as an environment variable named
+ * 'BRAVE_SEARCH_API_KEY'.
+ */
 export declare class BraveSearch extends Tool {
+    static lc_name(): string;
     name: string;
     description: string;
     apiKey: string;

package/dist/tools/brave_search.js

@@ -1,6 +1,15 @@
 import { getEnvironmentVariable } from "../util/env.js";
 import { Tool } from "./base.js";
+/**
+ * Class for interacting with the Brave Search engine. It extends the Tool
+ * class and requires an API key to function. The API key can be passed in
+ * during instantiation or set as an environment variable named
+ * 'BRAVE_SEARCH_API_KEY'.
+ */
 export class BraveSearch extends Tool {
+    static lc_name() {
+        return "BraveSearch";
+    }
     constructor(fields = {
         apiKey: getEnvironmentVariable("BRAVE_SEARCH_API_KEY"),
     }) {

package/dist/tools/calculator.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Calculator = void 0;
 const expr_eval_1 = require("expr-eval");
 const base_js_1 = require("./base.cjs");
+/**
+ * The Calculator class is a tool used to evaluate mathematical
+ * expressions. It extends the base Tool class.
+ */
 class Calculator extends base_js_1.Tool {
     constructor() {
         super(...arguments);
@@ -19,6 +23,9 @@ class Calculator extends base_js_1.Tool {
             value: `Useful for getting the result of a math expression. The input to this tool should be a valid mathematical expression that could be executed by a simple calculator.`
         });
     }
+    static lc_name() {
+        return "Calculator";
+    }
     get lc_namespace() {
         return [...super.lc_namespace, "calculator"];
     }

package/dist/tools/calculator.d.ts

@@ -1,5 +1,10 @@
 import { Tool } from "./base.js";
+/**
+ * The Calculator class is a tool used to evaluate mathematical
+ * expressions. It extends the base Tool class.
+ */
 export declare class Calculator extends Tool {
+    static lc_name(): string;
     get lc_namespace(): string[];
     name: string;
     /** @ignore */

package/dist/tools/calculator.js

@@ -1,5 +1,9 @@
 import { Parser } from "expr-eval";
 import { Tool } from "./base.js";
+/**
+ * The Calculator class is a tool used to evaluate mathematical
+ * expressions. It extends the base Tool class.
+ */
 export class Calculator extends Tool {
     constructor() {
         super(...arguments);
@@ -16,6 +20,9 @@ export class Calculator extends Tool {
             value: `Useful for getting the result of a math expression. The input to this tool should be a valid mathematical expression that could be executed by a simple calculator.`
         });
     }
+    static lc_name() {
+        return "Calculator";
+    }
     get lc_namespace() {
         return [...super.lc_namespace, "calculator"];
     }

package/dist/tools/chain.cjs

@@ -2,7 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChainTool = void 0;
 const dynamic_js_1 = require("./dynamic.cjs");
+/**
+ * Class that extends DynamicTool for creating tools that can run chains.
+ * Takes an instance of a class that extends BaseChain as a parameter in
+ * its constructor and uses it to run the chain when its 'func' method is
+ * called.
+ */
 class ChainTool extends dynamic_js_1.DynamicTool {
+    static lc_name() {
+        return "ChainTool";
+    }
     constructor({ chain, ...rest }) {
         super({
             ...rest,

package/dist/tools/chain.d.ts

@@ -1,9 +1,21 @@
 import { DynamicTool, DynamicToolInput } from "./dynamic.js";
 import { BaseChain } from "../chains/base.js";
+/**
+ * Interface for the input parameters of the ChainTool constructor.
+ * Extends the DynamicToolInput interface, replacing the 'func' property
+ * with a 'chain' property.
+ */
 export interface ChainToolInput extends Omit<DynamicToolInput, "func"> {
     chain: BaseChain;
 }
+/**
+ * Class that extends DynamicTool for creating tools that can run chains.
+ * Takes an instance of a class that extends BaseChain as a parameter in
+ * its constructor and uses it to run the chain when its 'func' method is
+ * called.
+ */
 export declare class ChainTool extends DynamicTool {
+    static lc_name(): string;
     chain: BaseChain;
     constructor({ chain, ...rest }: ChainToolInput);
 }

package/dist/tools/chain.js

@@ -1,5 +1,14 @@
 import { DynamicTool } from "./dynamic.js";
+/**
+ * Class that extends DynamicTool for creating tools that can run chains.
+ * Takes an instance of a class that extends BaseChain as a parameter in
+ * its constructor and uses it to run the chain when its 'func' method is
+ * called.
+ */
 export class ChainTool extends DynamicTool {
+    static lc_name() {
+        return "ChainTool";
+    }
     constructor({ chain, ...rest }) {
         super({
             ...rest,

package/dist/tools/convert_to_openai.cjs

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatToOpenAIFunction = void 0;
 const zod_to_json_schema_1 = require("zod-to-json-schema");
+/**
+ * Formats a `StructuredTool` instance into a format that is compatible
+ * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
+ * function to convert the schema of the `StructuredTool` into a JSON
+ * schema, which is then used as the parameters for the OpenAI function.
+ */
 function formatToOpenAIFunction(tool) {
     return {
         name: tool.name,

package/dist/tools/convert_to_openai.d.ts

@@ -1,3 +1,9 @@
 import { ChatCompletionFunctions } from "openai";
 import { StructuredTool } from "./base.js";
+/**
+ * Formats a `StructuredTool` instance into a format that is compatible
+ * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
+ * function to convert the schema of the `StructuredTool` into a JSON
+ * schema, which is then used as the parameters for the OpenAI function.
+ */
 export declare function formatToOpenAIFunction(tool: StructuredTool): ChatCompletionFunctions;

package/dist/tools/convert_to_openai.js

@@ -1,4 +1,10 @@
 import { zodToJsonSchema } from "zod-to-json-schema";
+/**
+ * Formats a `StructuredTool` instance into a format that is compatible
+ * with OpenAI's ChatCompletionFunctions. It uses the `zodToJsonSchema`
+ * function to convert the schema of the `StructuredTool` into a JSON
+ * schema, which is then used as the parameters for the OpenAI function.
+ */
 export function formatToOpenAIFunction(tool) {
     return {
         name: tool.name,

package/dist/tools/dadjokeapi.cjs

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DadJokeAPI = void 0;
 const base_js_1 = require("./base.cjs");
+/**
+ * The DadJokeAPI class is a tool for generating dad jokes based on a
+ * specific topic. It fetches jokes from an external API and returns a
+ * random joke from the results. If no jokes are found for the given
+ * search term, it returns a message indicating that no jokes were found.
+ */
 class DadJokeAPI extends base_js_1.Tool {
     constructor() {
         super(...arguments);
@@ -18,6 +24,9 @@ class DadJokeAPI extends base_js_1.Tool {
             value: "a dad joke generator. get a dad joke about a specific topic. input should be a search term."
         });
     }
+    static lc_name() {
+        return "DadJokeAPI";
+    }
     /** @ignore */
     async _call(input) {
         const headers = { Accept: "application/json" };

package/dist/tools/dadjokeapi.d.ts

@@ -1,5 +1,12 @@
 import { Tool } from "./base.js";
+/**
+ * The DadJokeAPI class is a tool for generating dad jokes based on a
+ * specific topic. It fetches jokes from an external API and returns a
+ * random joke from the results. If no jokes are found for the given
+ * search term, it returns a message indicating that no jokes were found.
+ */
 declare class DadJokeAPI extends Tool {
+    static lc_name(): string;
     name: string;
     description: string;
     /** @ignore */

package/dist/tools/dadjokeapi.js

@@ -1,4 +1,10 @@
 import { Tool } from "./base.js";
+/**
+ * The DadJokeAPI class is a tool for generating dad jokes based on a
+ * specific topic. It fetches jokes from an external API and returns a
+ * random joke from the results. If no jokes are found for the given
+ * search term, it returns a message indicating that no jokes were found.
+ */
 class DadJokeAPI extends Tool {
     constructor() {
         super(...arguments);
@@ -15,6 +21,9 @@ class DadJokeAPI extends Tool {
             value: "a dad joke generator. get a dad joke about a specific topic. input should be a search term."
         });
     }
+    static lc_name() {
+        return "DadJokeAPI";
+    }
     /** @ignore */
     async _call(input) {
         const headers = { Accept: "application/json" };

package/dist/tools/dataforseo_api_search.cjs

@@ -9,6 +9,9 @@ const base_js_1 = require("./base.cjs");
  * @description Represents a wrapper class to work with DataForSEO SERP API.
  */
 class DataForSeoAPISearch extends base_js_1.Tool {
+    static lc_name() {
+        return "DataForSeoAPISearch";
+    }
     /**
      * @constructor
      * @param {DataForSeoApiConfig} config

package/dist/tools/dataforseo_api_search.d.ts

@@ -47,6 +47,9 @@ export interface DataForSeoApiConfig {
      */
     topCount?: number;
 }
+/**
+ * Represents a task in the API response.
+ */
 type Task = {
     id: string;
     status_code: number;
@@ -54,6 +57,9 @@ type Task = {
     time: string;
     result: Result[];
 };
+/**
+ * Represents a result in the API response.
+ */
 type Result = {
     keyword: string;
     check_url: string;
@@ -64,6 +70,9 @@ type Result = {
     items_count: number;
     items: any[];
 };
+/**
+ * Represents the API response.
+ */
 type ApiResponse = {
     status_code: number;
     status_message: string;
@@ -75,6 +84,7 @@ type ApiResponse = {
  * @description Represents a wrapper class to work with DataForSEO SERP API.
  */
 export declare class DataForSeoAPISearch extends Tool {
+    static lc_name(): string;
     name: string;
     description: string;
     protected apiLogin: string;

package/dist/tools/dataforseo_api_search.js

@@ -6,6 +6,9 @@ import { Tool } from "./base.js";
  * @description Represents a wrapper class to work with DataForSEO SERP API.
  */
 export class DataForSeoAPISearch extends Tool {
+    static lc_name() {
+        return "DataForSeoAPISearch";
+    }
     /**
      * @constructor
      * @param {DataForSeoApiConfig} config

package/dist/tools/dynamic.cjs

@@ -6,6 +6,9 @@ const base_js_1 = require("./base.cjs");
  * A tool that can be created dynamically from a function, name, and description.
  */
 class DynamicTool extends base_js_1.Tool {
+    static lc_name() {
+        return "DynamicTool";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "name", {
@@ -37,7 +40,16 @@ class DynamicTool extends base_js_1.Tool {
     }
 }
 exports.DynamicTool = DynamicTool;
+/**
+ * A tool that can be created dynamically from a function, name, and
+ * description, designed to work with structured data. It extends the
+ * StructuredTool class and overrides the _call method to execute the
+ * provided function when the tool is called.
+ */
 class DynamicStructuredTool extends base_js_1.StructuredTool {
+    static lc_name() {
+        return "DynamicStructuredTool";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "name", {

package/dist/tools/dynamic.d.ts

@@ -6,9 +6,15 @@ export interface BaseDynamicToolInput extends ToolParams {
     description: string;
     returnDirect?: boolean;
 }
+/**
+ * Interface for the input parameters of the DynamicTool class.
+ */
 export interface DynamicToolInput extends BaseDynamicToolInput {
     func: (input: string, runManager?: CallbackManagerForToolRun) => Promise<string>;
 }
+/**
+ * Interface for the input parameters of the DynamicStructuredTool class.
+ */
 export interface DynamicStructuredToolInput<T extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>> extends BaseDynamicToolInput {
     func: (input: z.infer<T>, runManager?: CallbackManagerForToolRun) => Promise<string>;
     schema: T;
@@ -17,6 +23,7 @@ export interface DynamicStructuredToolInput<T extends z.ZodObject<any, any, any,
  * A tool that can be created dynamically from a function, name, and description.
  */
 export declare class DynamicTool extends Tool {
+    static lc_name(): string;
     name: string;
     description: string;
     func: DynamicToolInput["func"];
@@ -24,7 +31,14 @@ export declare class DynamicTool extends Tool {
     /** @ignore */
     _call(input: string, runManager?: CallbackManagerForToolRun): Promise<string>;
 }
+/**
+ * A tool that can be created dynamically from a function, name, and
+ * description, designed to work with structured data. It extends the
+ * StructuredTool class and overrides the _call method to execute the
+ * provided function when the tool is called.
+ */
 export declare class DynamicStructuredTool<T extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>> extends StructuredTool {
+    static lc_name(): string;
     name: string;
     description: string;
     func: DynamicStructuredToolInput["func"];

package/dist/tools/dynamic.js

@@ -3,6 +3,9 @@ import { StructuredTool, Tool } from "./base.js";
  * A tool that can be created dynamically from a function, name, and description.
  */
 export class DynamicTool extends Tool {
+    static lc_name() {
+        return "DynamicTool";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "name", {
@@ -33,7 +36,16 @@ export class DynamicTool extends Tool {
         return this.func(input, runManager);
     }
 }
+/**
+ * A tool that can be created dynamically from a function, name, and
+ * description, designed to work with structured data. It extends the
+ * StructuredTool class and overrides the _call method to execute the
+ * provided function when the tool is called.
+ */
 export class DynamicStructuredTool extends StructuredTool {
+    static lc_name() {
+        return "DynamicStructuredTool";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "name", {

package/dist/tools/fs.cjs

@@ -3,7 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WriteFileTool = exports.ReadFileTool = void 0;
 const zod_1 = require("zod");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for reading files from the disk. Extends the StructuredTool
+ * class.
+ */
 class ReadFileTool extends base_js_1.StructuredTool {
+    static lc_name() {
+        return "ReadFileTool";
+    }
     constructor({ store }) {
         super(...arguments);
         Object.defineProperty(this, "schema", {
@@ -39,7 +46,14 @@ class ReadFileTool extends base_js_1.StructuredTool {
     }
 }
 exports.ReadFileTool = ReadFileTool;
+/**
+ * Class for writing data to files on the disk. Extends the StructuredTool
+ * class.
+ */
 class WriteFileTool extends base_js_1.StructuredTool {
+    static lc_name() {
+        return "WriteFileTool";
+    }
     constructor({ store, ...rest }) {
         super(rest);
         Object.defineProperty(this, "schema", {

package/dist/tools/fs.d.ts

@@ -1,10 +1,18 @@
 import { z } from "zod";
 import { BaseFileStore } from "../schema/index.js";
 import { StructuredTool, ToolParams } from "./base.js";
+/**
+ * Interface for parameters required by the ReadFileTool class.
+ */
 interface ReadFileParams extends ToolParams {
     store: BaseFileStore;
 }
+/**
+ * Class for reading files from the disk. Extends the StructuredTool
+ * class.
+ */
 export declare class ReadFileTool extends StructuredTool {
+    static lc_name(): string;
     schema: z.ZodObject<{
         file_path: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -18,10 +26,18 @@ export declare class ReadFileTool extends StructuredTool {
     constructor({ store }: ReadFileParams);
     _call({ file_path }: z.infer<typeof this.schema>): Promise<string>;
 }
+/**
+ * Interface for parameters required by the WriteFileTool class.
+ */
 interface WriteFileParams extends ToolParams {
     store: BaseFileStore;
 }
+/**
+ * Class for writing data to files on the disk. Extends the StructuredTool
+ * class.
+ */
 export declare class WriteFileTool extends StructuredTool {
+    static lc_name(): string;
     schema: z.ZodObject<{
         file_path: z.ZodString;
         text: z.ZodString;

package/dist/tools/fs.js

@@ -1,6 +1,13 @@
 import { z } from "zod";
 import { StructuredTool } from "./base.js";
+/**
+ * Class for reading files from the disk. Extends the StructuredTool
+ * class.
+ */
 export class ReadFileTool extends StructuredTool {
+    static lc_name() {
+        return "ReadFileTool";
+    }
     constructor({ store }) {
         super(...arguments);
         Object.defineProperty(this, "schema", {
@@ -35,7 +42,14 @@ export class ReadFileTool extends StructuredTool {
         return await this.store.readFile(file_path);
     }
 }
+/**
+ * Class for writing data to files on the disk. Extends the StructuredTool
+ * class.
+ */
 export class WriteFileTool extends StructuredTool {
+    static lc_name() {
+        return "WriteFileTool";
+    }
     constructor({ store, ...rest }) {
         super(rest);
         Object.defineProperty(this, "schema", {

package/dist/tools/google_custom_search.cjs

@@ -3,7 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GoogleCustomSearch = void 0;
 const env_js_1 = require("../util/env.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class that uses the Google Search API to perform custom searches.
+ * Requires environment variables `GOOGLE_API_KEY` and `GOOGLE_CSE_ID` to
+ * be set.
+ */
 class GoogleCustomSearch extends base_js_1.Tool {
+    static lc_name() {
+        return "GoogleCustomSearch";
+    }
     get lc_secrets() {
         return {
             apiKey: "GOOGLE_API_KEY",

package/dist/tools/google_custom_search.d.ts

@@ -1,9 +1,18 @@
 import { Tool } from "./base.js";
+/**
+ * Interface for parameters required by GoogleCustomSearch class.
+ */
 export interface GoogleCustomSearchParams {
     apiKey?: string;
     googleCSEId?: string;
 }
+/**
+ * Class that uses the Google Search API to perform custom searches.
+ * Requires environment variables `GOOGLE_API_KEY` and `GOOGLE_CSE_ID` to
+ * be set.
+ */
 export declare class GoogleCustomSearch extends Tool {
+    static lc_name(): string;
     get lc_secrets(): {
         [key: string]: string;
     } | undefined;

package/dist/tools/google_custom_search.js

@@ -1,6 +1,14 @@
 import { getEnvironmentVariable } from "../util/env.js";
 import { Tool } from "./base.js";
+/**
+ * Class that uses the Google Search API to perform custom searches.
+ * Requires environment variables `GOOGLE_API_KEY` and `GOOGLE_CSE_ID` to
+ * be set.
+ */
 export class GoogleCustomSearch extends Tool {
+    static lc_name() {
+        return "GoogleCustomSearch";
+    }
     get lc_secrets() {
         return {
             apiKey: "GOOGLE_API_KEY",