langchain 0.0.131 → 0.0.132

package/dist/tools/aiplugin.js

@@ -1,4 +1,8 @@
 import { Tool } from "./base.js";
+/**
+ * Class for creating instances of AI tools from plugins. It extends the
+ * Tool class and implements the AIPluginToolParams interface.
+ */
 export class AIPluginTool extends Tool {
     static lc_name() {
         return "AIPluginTool";
@@ -37,6 +41,14 @@ export class AIPluginTool extends Tool {
     async _call(_input) {
         return this.apiSpec;
     }
+    /**
+     * Static method that creates an instance of AIPluginTool from a given
+     * plugin URL. It fetches the plugin and its API specification from the
+     * provided URL and returns a new instance of AIPluginTool with the
+     * fetched data.
+     * @param url The URL of the AI plugin.
+     * @returns A new instance of AIPluginTool.
+     */
     static async fromPluginUrl(url) {
         const aiPluginRes = await fetch(url);
         if (!aiPluginRes.ok) {

package/dist/tools/aws_lambda.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AWSLambda = void 0;
 const dynamic_js_1 = require("./dynamic.cjs");
+/**
+ * Class for invoking AWS Lambda functions within the LangChain framework.
+ * Extends the DynamicTool class.
+ */
 class AWSLambda extends dynamic_js_1.DynamicTool {
     get lc_namespace() {
         return [...super.lc_namespace, "aws_lambda"];
@@ -61,6 +65,11 @@ class AWSLambda extends dynamic_js_1.DynamicTool {
     }
 }
 exports.AWSLambda = AWSLambda;
+/**
+ * Helper function that imports the necessary AWS SDK modules for invoking
+ * the Lambda function. Returns an object that includes the LambdaClient
+ * and InvokeCommand classes from the AWS SDK.
+ */
 async function LambdaImports() {
     try {
         const { LambdaClient, InvokeCommand } = await import("@aws-sdk/client-lambda");

package/dist/tools/aws_lambda.d.ts

@@ -1,10 +1,17 @@
 import { DynamicTool, DynamicToolInput } from "./dynamic.js";
+/**
+ * Interface for the configuration of the AWS Lambda function.
+ */
 interface LambdaConfig {
     functionName: string;
     region?: string;
     accessKeyId?: string;
     secretAccessKey?: string;
 }
+/**
+ * Class for invoking AWS Lambda functions within the LangChain framework.
+ * Extends the DynamicTool class.
+ */
 declare class AWSLambda extends DynamicTool {
     get lc_namespace(): string[];
     get lc_secrets(): {

package/dist/tools/aws_lambda.js

@@ -1,4 +1,8 @@
 import { DynamicTool } from "./dynamic.js";
+/**
+ * Class for invoking AWS Lambda functions within the LangChain framework.
+ * Extends the DynamicTool class.
+ */
 class AWSLambda extends DynamicTool {
     get lc_namespace() {
         return [...super.lc_namespace, "aws_lambda"];
@@ -57,6 +61,11 @@ class AWSLambda extends DynamicTool {
         });
     }
 }
+/**
+ * Helper function that imports the necessary AWS SDK modules for invoking
+ * the Lambda function. Returns an object that includes the LambdaClient
+ * and InvokeCommand classes from the AWS SDK.
+ */
 async function LambdaImports() {
     try {
         const { LambdaClient, InvokeCommand } = await import("@aws-sdk/client-lambda");

package/dist/tools/aws_sfn.cjs

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SendTaskSuccessAWSSfnTool = exports.DescribeExecutionAWSSfnTool = exports.StartExecutionAWSSfnTool = void 0;
 const client_sfn_1 = require("@aws-sdk/client-sfn");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for starting the execution of an AWS Step Function.
+ */
 class StartExecutionAWSSfnTool extends base_js_1.Tool {
     static lc_name() {
         return "StartExecutionAWSSfnTool";
@@ -31,6 +34,12 @@ class StartExecutionAWSSfnTool extends base_js_1.Tool {
         this.description = description;
         this.sfnConfig = rest;
     }
+    /**
+     * Generates a formatted description for the StartExecutionAWSSfnTool.
+     * @param name Name of the state machine.
+     * @param description Description of the state machine.
+     * @returns A formatted description string.
+     */
     static formatDescription(name, description) {
         return `Use to start executing the ${name} state machine. Use to run ${name} workflows. Whenever you need to start (or execute) an asynchronous workflow (or state machine) about ${description} you should ALWAYS use this. Input should be a valid JSON string.`;
     }
@@ -62,6 +71,9 @@ class StartExecutionAWSSfnTool extends base_js_1.Tool {
     }
 }
 exports.StartExecutionAWSSfnTool = StartExecutionAWSSfnTool;
+/**
+ * Class for checking the status of an AWS Step Function execution.
+ */
 class DescribeExecutionAWSSfnTool extends base_js_1.Tool {
     static lc_name() {
         return "DescribeExecutionAWSSfnTool";
@@ -117,6 +129,10 @@ class DescribeExecutionAWSSfnTool extends base_js_1.Tool {
     }
 }
 exports.DescribeExecutionAWSSfnTool = DescribeExecutionAWSSfnTool;
+/**
+ * Class for sending a task success signal to an AWS Step Function
+ * execution.
+ */
 class SendTaskSuccessAWSSfnTool extends base_js_1.Tool {
     static lc_name() {
         return "SendTaskSuccessAWSSfnTool";
@@ -169,6 +185,9 @@ class SendTaskSuccessAWSSfnTool extends base_js_1.Tool {
     }
 }
 exports.SendTaskSuccessAWSSfnTool = SendTaskSuccessAWSSfnTool;
+/**
+ * Helper function to construct the AWS SFN client.
+ */
 function getClientConstructorArgs(config) {
     const clientConstructorArgs = {};
     if (config.region) {

package/dist/tools/aws_sfn.d.ts

@@ -1,10 +1,16 @@
 import { Tool, ToolParams } from "./base.js";
+/**
+ * Interface for AWS Step Functions configuration.
+ */
 export interface SfnConfig {
     stateMachineArn: string;
     region?: string;
     accessKeyId?: string;
     secretAccessKey?: string;
 }
+/**
+ * Class for starting the execution of an AWS Step Function.
+ */
 export declare class StartExecutionAWSSfnTool extends Tool {
     static lc_name(): string;
     private sfnConfig;
@@ -14,10 +20,19 @@ export declare class StartExecutionAWSSfnTool extends Tool {
         name: string;
         description: string;
     });
+    /**
+     * Generates a formatted description for the StartExecutionAWSSfnTool.
+     * @param name Name of the state machine.
+     * @param description Description of the state machine.
+     * @returns A formatted description string.
+     */
     static formatDescription(name: string, description: string): string;
     /** @ignore */
     _call(input: string): Promise<string>;
 }
+/**
+ * Class for checking the status of an AWS Step Function execution.
+ */
 export declare class DescribeExecutionAWSSfnTool extends Tool {
     static lc_name(): string;
     name: string;
@@ -27,6 +42,10 @@ export declare class DescribeExecutionAWSSfnTool extends Tool {
     /** @ignore */
     _call(input: string): Promise<string>;
 }
+/**
+ * Class for sending a task success signal to an AWS Step Function
+ * execution.
+ */
 export declare class SendTaskSuccessAWSSfnTool extends Tool {
     static lc_name(): string;
     name: string;

package/dist/tools/aws_sfn.js

@@ -1,5 +1,8 @@
 import { SFNClient as Client, StartExecutionCommand as Invoker, DescribeExecutionCommand as Describer, SendTaskSuccessCommand as TaskSuccessSender, } from "@aws-sdk/client-sfn";
 import { Tool } from "./base.js";
+/**
+ * Class for starting the execution of an AWS Step Function.
+ */
 export class StartExecutionAWSSfnTool extends Tool {
     static lc_name() {
         return "StartExecutionAWSSfnTool";
@@ -28,6 +31,12 @@ export class StartExecutionAWSSfnTool extends Tool {
         this.description = description;
         this.sfnConfig = rest;
     }
+    /**
+     * Generates a formatted description for the StartExecutionAWSSfnTool.
+     * @param name Name of the state machine.
+     * @param description Description of the state machine.
+     * @returns A formatted description string.
+     */
     static formatDescription(name, description) {
         return `Use to start executing the ${name} state machine. Use to run ${name} workflows. Whenever you need to start (or execute) an asynchronous workflow (or state machine) about ${description} you should ALWAYS use this. Input should be a valid JSON string.`;
     }
@@ -58,6 +67,9 @@ export class StartExecutionAWSSfnTool extends Tool {
         });
     }
 }
+/**
+ * Class for checking the status of an AWS Step Function execution.
+ */
 export class DescribeExecutionAWSSfnTool extends Tool {
     static lc_name() {
         return "DescribeExecutionAWSSfnTool";
@@ -112,6 +124,10 @@ export class DescribeExecutionAWSSfnTool extends Tool {
         });
     }
 }
+/**
+ * Class for sending a task success signal to an AWS Step Function
+ * execution.
+ */
 export class SendTaskSuccessAWSSfnTool extends Tool {
     static lc_name() {
         return "SendTaskSuccessAWSSfnTool";
@@ -163,6 +179,9 @@ export class SendTaskSuccessAWSSfnTool extends Tool {
         });
     }
 }
+/**
+ * Helper function to construct the AWS SFN client.
+ */
 function getClientConstructorArgs(config) {
     const clientConstructorArgs = {};
     if (config.region) {

package/dist/tools/base.cjs

@@ -20,9 +20,24 @@ class StructuredTool extends index_js_1.BaseLangChain {
             value: false
         });
     }
+    /**
+     * Invokes the tool with the provided input and configuration.
+     * @param input The input for the tool.
+     * @param config Optional configuration for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     async invoke(input, config) {
         return this.call(input, config);
     }
+    /**
+     * Calls the tool with the provided argument, configuration, and tags. It
+     * parses the input according to the schema, handles any errors, and
+     * manages callbacks.
+     * @param arg The input argument for the tool.
+     * @param configArg Optional configuration or callbacks for the tool.
+     * @param tags Optional tags for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     async call(arg, configArg, 
     /** @deprecated */
     tags) {
@@ -58,6 +73,13 @@ class Tool extends StructuredTool {
                 .transform((obj) => obj.input)
         });
     }
+    /**
+     * Calls the tool with the provided argument and callbacks. It handles
+     * string inputs specifically.
+     * @param arg The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
+     * @param callbacks Optional callbacks for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     call(arg, callbacks) {
         return super.call(typeof arg === "string" || !arg ? { input: arg } : arg, callbacks);
     }

package/dist/tools/base.d.ts

@@ -2,6 +2,9 @@ import { z } from "zod";
 import { CallbackManagerForToolRun, Callbacks } from "../callbacks/manager.js";
 import { BaseLangChain, BaseLangChainParams } from "../base_language/index.js";
 import { RunnableConfig } from "../schema/runnable.js";
+/**
+ * Parameters for the Tool classes.
+ */
 export interface ToolParams extends BaseLangChainParams {
 }
 /**
@@ -12,7 +15,22 @@ export declare abstract class StructuredTool<T extends z.ZodObject<any, any, any
     get lc_namespace(): string[];
     constructor(fields?: ToolParams);
     protected abstract _call(arg: z.output<T>, runManager?: CallbackManagerForToolRun): Promise<string>;
+    /**
+     * Invokes the tool with the provided input and configuration.
+     * @param input The input for the tool.
+     * @param config Optional configuration for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     invoke(input: (z.output<T> extends string ? string : never) | z.input<T>, config?: RunnableConfig): Promise<string>;
+    /**
+     * Calls the tool with the provided argument, configuration, and tags. It
+     * parses the input according to the schema, handles any errors, and
+     * manages callbacks.
+     * @param arg The input argument for the tool.
+     * @param configArg Optional configuration or callbacks for the tool.
+     * @param tags Optional tags for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     call(arg: (z.output<T> extends string ? string : never) | z.input<T>, configArg?: Callbacks | RunnableConfig, 
     /** @deprecated */
     tags?: string[]): Promise<string>;
@@ -34,5 +52,12 @@ export declare abstract class Tool extends StructuredTool {
         input?: string | undefined;
     }>;
     constructor(fields?: ToolParams);
+    /**
+     * Calls the tool with the provided argument and callbacks. It handles
+     * string inputs specifically.
+     * @param arg The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
+     * @param callbacks Optional callbacks for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     call(arg: string | undefined | z.input<this["schema"]>, callbacks?: Callbacks): Promise<string>;
 }

package/dist/tools/base.js

@@ -17,9 +17,24 @@ export class StructuredTool extends BaseLangChain {
             value: false
         });
     }
+    /**
+     * Invokes the tool with the provided input and configuration.
+     * @param input The input for the tool.
+     * @param config Optional configuration for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     async invoke(input, config) {
         return this.call(input, config);
     }
+    /**
+     * Calls the tool with the provided argument, configuration, and tags. It
+     * parses the input according to the schema, handles any errors, and
+     * manages callbacks.
+     * @param arg The input argument for the tool.
+     * @param configArg Optional configuration or callbacks for the tool.
+     * @param tags Optional tags for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     async call(arg, configArg, 
     /** @deprecated */
     tags) {
@@ -54,6 +69,13 @@ export class Tool extends StructuredTool {
                 .transform((obj) => obj.input)
         });
     }
+    /**
+     * Calls the tool with the provided argument and callbacks. It handles
+     * string inputs specifically.
+     * @param arg The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
+     * @param callbacks Optional callbacks for the tool.
+     * @returns A Promise that resolves with a string.
+     */
     call(arg, callbacks) {
         return super.call(typeof arg === "string" || !arg ? { input: arg } : arg, callbacks);
     }

package/dist/tools/bingserpapi.cjs

@@ -3,10 +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,6 +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,9 +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,6 +3,12 @@ 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";

package/dist/tools/brave_search.d.ts

@@ -1,7 +1,17 @@
 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;

package/dist/tools/brave_search.js

@@ -1,5 +1,11 @@
 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";

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

package/dist/tools/calculator.d.ts

@@ -1,4 +1,8 @@
 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[];

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

package/dist/tools/chain.cjs

@@ -2,6 +2,12 @@
 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";

package/dist/tools/chain.d.ts

@@ -1,8 +1,19 @@
 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;

package/dist/tools/chain.js

@@ -1,4 +1,10 @@
 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";

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

package/dist/tools/dadjokeapi.d.ts

@@ -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.
+ */
 declare class DadJokeAPI extends Tool {
     static lc_name(): string;
     name: string;

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

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;

package/dist/tools/dynamic.cjs

@@ -40,6 +40,12 @@ 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";