langchain 0.0.131 → 0.0.132

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;
@@ -25,6 +31,12 @@ 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;

package/dist/tools/dynamic.js

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

package/dist/tools/fs.cjs

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

package/dist/tools/fs.d.ts

@@ -1,9 +1,16 @@
 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<{
@@ -19,9 +26,16 @@ 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<{

package/dist/tools/fs.js

@@ -1,5 +1,9 @@
 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";
@@ -38,6 +42,10 @@ 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";

package/dist/tools/google_custom_search.cjs

@@ -3,6 +3,11 @@ 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";

package/dist/tools/google_custom_search.d.ts

@@ -1,8 +1,16 @@
 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(): {

package/dist/tools/google_custom_search.js

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

package/dist/tools/json.cjs

@@ -7,6 +7,10 @@ exports.JsonGetValueTool = exports.JsonListKeysTool = exports.JsonSpec = void 0;
 const jsonpointer_1 = __importDefault(require("jsonpointer"));
 const base_js_1 = require("./base.cjs");
 const serializable_js_1 = require("../load/serializable.cjs");
+/**
+ * Represents a JSON object in the LangChain framework. Provides methods
+ * to get keys and values from the JSON object.
+ */
 class JsonSpec extends serializable_js_1.Serializable {
     constructor(obj, max_value_length = 4000) {
         super(...arguments);
@@ -31,6 +35,11 @@ class JsonSpec extends serializable_js_1.Serializable {
         this.obj = obj;
         this.maxValueLength = max_value_length;
     }
+    /**
+     * Retrieves all keys at a given path in the JSON object.
+     * @param input The path to the keys in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns A string containing all keys at the given path, separated by commas.
+     */
     getKeys(input) {
         const pointer = jsonpointer_1.default.compile(input);
         const res = pointer.get(this.obj);
@@ -41,6 +50,11 @@ class JsonSpec extends serializable_js_1.Serializable {
         }
         throw new Error(`Value at ${input} is not a dictionary, get the value directly instead.`);
     }
+    /**
+     * Retrieves the value at a given path in the JSON object.
+     * @param input The path to the value in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns The value at the given path in the JSON object, as a string. If the value is a large dictionary or exceeds the maximum length, a message is returned instead.
+     */
     getValue(input) {
         const pointer = jsonpointer_1.default.compile(input);
         const res = pointer.get(this.obj);
@@ -60,6 +74,10 @@ class JsonSpec extends serializable_js_1.Serializable {
     }
 }
 exports.JsonSpec = JsonSpec;
+/**
+ * A tool in the LangChain framework that lists all keys at a given path
+ * in a JSON object.
+ */
 class JsonListKeysTool extends base_js_1.Tool {
     static lc_name() {
         return "JsonListKeysTool";
@@ -103,6 +121,10 @@ class JsonListKeysTool extends base_js_1.Tool {
     }
 }
 exports.JsonListKeysTool = JsonListKeysTool;
+/**
+ * A tool in the LangChain framework that retrieves the value at a given
+ * path in a JSON object.
+ */
 class JsonGetValueTool extends base_js_1.Tool {
     static lc_name() {
         return "JsonGetValueTool";

package/dist/tools/json.d.ts

@@ -6,17 +6,35 @@ export type Json = string | number | boolean | null | {
 export type JsonObject = {
     [key: string]: Json;
 };
+/**
+ * Represents a JSON object in the LangChain framework. Provides methods
+ * to get keys and values from the JSON object.
+ */
 export declare class JsonSpec extends Serializable {
     lc_namespace: string[];
     obj: JsonObject;
     maxValueLength: number;
     constructor(obj: JsonObject, max_value_length?: number);
+    /**
+     * Retrieves all keys at a given path in the JSON object.
+     * @param input The path to the keys in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns A string containing all keys at the given path, separated by commas.
+     */
     getKeys(input: string): string;
+    /**
+     * Retrieves the value at a given path in the JSON object.
+     * @param input The path to the value in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns The value at the given path in the JSON object, as a string. If the value is a large dictionary or exceeds the maximum length, a message is returned instead.
+     */
     getValue(input: string): string;
 }
 export interface JsonToolFields extends ToolParams {
     jsonSpec: JsonSpec;
 }
+/**
+ * A tool in the LangChain framework that lists all keys at a given path
+ * in a JSON object.
+ */
 export declare class JsonListKeysTool extends Tool {
     static lc_name(): string;
     name: string;
@@ -27,6 +45,10 @@ export declare class JsonListKeysTool extends Tool {
     _call(input: string): Promise<string>;
     description: string;
 }
+/**
+ * A tool in the LangChain framework that retrieves the value at a given
+ * path in a JSON object.
+ */
 export declare class JsonGetValueTool extends Tool {
     jsonSpec: JsonSpec;
     static lc_name(): string;

package/dist/tools/json.js

@@ -1,6 +1,10 @@
 import jsonpointer from "jsonpointer";
 import { Tool } from "./base.js";
 import { Serializable } from "../load/serializable.js";
+/**
+ * Represents a JSON object in the LangChain framework. Provides methods
+ * to get keys and values from the JSON object.
+ */
 export class JsonSpec extends Serializable {
     constructor(obj, max_value_length = 4000) {
         super(...arguments);
@@ -25,6 +29,11 @@ export class JsonSpec extends Serializable {
         this.obj = obj;
         this.maxValueLength = max_value_length;
     }
+    /**
+     * Retrieves all keys at a given path in the JSON object.
+     * @param input The path to the keys in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns A string containing all keys at the given path, separated by commas.
+     */
     getKeys(input) {
         const pointer = jsonpointer.compile(input);
         const res = pointer.get(this.obj);
@@ -35,6 +44,11 @@ export class JsonSpec extends Serializable {
         }
         throw new Error(`Value at ${input} is not a dictionary, get the value directly instead.`);
     }
+    /**
+     * Retrieves the value at a given path in the JSON object.
+     * @param input The path to the value in the JSON object, provided as a string in JSON pointer syntax.
+     * @returns The value at the given path in the JSON object, as a string. If the value is a large dictionary or exceeds the maximum length, a message is returned instead.
+     */
     getValue(input) {
         const pointer = jsonpointer.compile(input);
         const res = pointer.get(this.obj);
@@ -53,6 +67,10 @@ export class JsonSpec extends Serializable {
         return str;
     }
 }
+/**
+ * A tool in the LangChain framework that lists all keys at a given path
+ * in a JSON object.
+ */
 export class JsonListKeysTool extends Tool {
     static lc_name() {
         return "JsonListKeysTool";
@@ -95,6 +113,10 @@ export class JsonListKeysTool extends Tool {
         }
     }
 }
+/**
+ * A tool in the LangChain framework that retrieves the value at a given
+ * path in a JSON object.
+ */
 export class JsonGetValueTool extends Tool {
     static lc_name() {
         return "JsonGetValueTool";

package/dist/tools/requests.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestsPostTool = exports.RequestsGetTool = void 0;
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for making GET requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a URL string, and the
+ * output will be the text response of the GET request.
+ */
 class RequestsGetTool extends base_js_1.Tool {
     static lc_name() {
         return "RequestsGetTool";
@@ -45,6 +50,12 @@ class RequestsGetTool extends base_js_1.Tool {
     }
 }
 exports.RequestsGetTool = RequestsGetTool;
+/**
+ * Class for making POST requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a JSON string with two
+ * keys: 'url' and 'data'. The output will be the text response of the
+ * POST request.
+ */
 class RequestsPostTool extends base_js_1.Tool {
     static lc_name() {
         return "RequestsPostTool";

package/dist/tools/requests.d.ts

@@ -2,10 +2,19 @@ import { Tool } from "./base.js";
 export interface Headers {
     [key: string]: string;
 }
+/**
+ * Interface for HTTP request tools. Contains properties for headers and
+ * maximum output length.
+ */
 export interface RequestTool {
     headers: Headers;
     maxOutputLength: number;
 }
+/**
+ * Class for making GET requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a URL string, and the
+ * output will be the text response of the GET request.
+ */
 export declare class RequestsGetTool extends Tool implements RequestTool {
     headers: Headers;
     static lc_name(): string;
@@ -18,6 +27,12 @@ export declare class RequestsGetTool extends Tool implements RequestTool {
     _call(input: string): Promise<string>;
     description: string;
 }
+/**
+ * Class for making POST requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a JSON string with two
+ * keys: 'url' and 'data'. The output will be the text response of the
+ * POST request.
+ */
 export declare class RequestsPostTool extends Tool implements RequestTool {
     headers: Headers;
     static lc_name(): string;

package/dist/tools/requests.js

@@ -1,4 +1,9 @@
 import { Tool } from "./base.js";
+/**
+ * Class for making GET requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a URL string, and the
+ * output will be the text response of the GET request.
+ */
 export class RequestsGetTool extends Tool {
     static lc_name() {
         return "RequestsGetTool";
@@ -41,6 +46,12 @@ export class RequestsGetTool extends Tool {
         return text.slice(0, this.maxOutputLength);
     }
 }
+/**
+ * Class for making POST requests. Extends the Tool class and implements
+ * the RequestTool interface. The input should be a JSON string with two
+ * keys: 'url' and 'data'. The output will be the text response of the
+ * POST request.
+ */
 export class RequestsPostTool extends Tool {
     static lc_name() {
         return "RequestsPostTool";

package/dist/tools/searxng_search.cjs

@@ -72,6 +72,13 @@ class SearxngSearch extends base_js_1.Tool {
             this.params = { ...this.params, ...params };
         }
     }
+    /**
+     * Builds the URL for the Searxng search.
+     * @param path The path for the URL.
+     * @param parameters The parameters for the URL.
+     * @param baseUrl The base URL.
+     * @returns The complete URL as a string.
+     */
     buildUrl(path, parameters, baseUrl) {
         const nonUndefinedParams = Object.entries(parameters)
             .filter(([_, value]) => value !== undefined)

package/dist/tools/searxng_search.d.ts

@@ -1,4 +1,7 @@
 import { Tool } from "./base.js";
+/**
+ * Interface for custom headers used in the Searxng search.
+ */
 interface SearxngCustomHeaders {
     [key: string]: string;
 }
@@ -79,6 +82,13 @@ export declare class SearxngSearch extends Tool {
          */
         headers?: SearxngCustomHeaders;
     });
+    /**
+     * Builds the URL for the Searxng search.
+     * @param path The path for the URL.
+     * @param parameters The parameters for the URL.
+     * @param baseUrl The base URL.
+     * @returns The complete URL as a string.
+     */
     protected buildUrl<P extends SearxngSearchParams>(path: string, parameters: P, baseUrl: string): string;
     _call(input: string): Promise<string>;
 }

package/dist/tools/searxng_search.js

@@ -69,6 +69,13 @@ export class SearxngSearch extends Tool {
             this.params = { ...this.params, ...params };
         }
     }
+    /**
+     * Builds the URL for the Searxng search.
+     * @param path The path for the URL.
+     * @param parameters The parameters for the URL.
+     * @param baseUrl The base URL.
+     * @returns The complete URL as a string.
+     */
     buildUrl(path, parameters, baseUrl) {
         const nonUndefinedParams = Object.entries(parameters)
             .filter(([_, value]) => value !== undefined)

package/dist/tools/serpapi.cjs

@@ -54,6 +54,13 @@ class SerpAPI extends base_js_1.Tool {
         this.params = params;
         this.baseUrl = baseUrl;
     }
+    /**
+     * Builds a URL for the SerpAPI request.
+     * @param path The path for the request.
+     * @param parameters The parameters for the request.
+     * @param baseUrl The base URL for the request.
+     * @returns A string representing the built URL.
+     */
     buildUrl(path, parameters, baseUrl) {
         const nonUndefinedParams = Object.entries(parameters)
             .filter(([_, value]) => value !== undefined)

package/dist/tools/serpapi.d.ts

@@ -287,6 +287,13 @@ export declare class SerpAPI extends Tool {
     protected baseUrl: string;
     constructor(apiKey?: string | undefined, params?: Partial<SerpAPIParameters>, baseUrl?: string);
     name: string;
+    /**
+     * Builds a URL for the SerpAPI request.
+     * @param path The path for the request.
+     * @param parameters The parameters for the request.
+     * @param baseUrl The base URL for the request.
+     * @returns A string representing the built URL.
+     */
     protected buildUrl<P extends UrlParameters>(path: string, parameters: P, baseUrl: string): string;
     /** @ignore */
     _call(input: string): Promise<any>;

package/dist/tools/serpapi.js

@@ -51,6 +51,13 @@ export class SerpAPI extends Tool {
         this.params = params;
         this.baseUrl = baseUrl;
     }
+    /**
+     * Builds a URL for the SerpAPI request.
+     * @param path The path for the request.
+     * @param parameters The parameters for the request.
+     * @param baseUrl The base URL for the request.
+     * @returns A string representing the built URL.
+     */
     buildUrl(path, parameters, baseUrl) {
         const nonUndefinedParams = Object.entries(parameters)
             .filter(([_, value]) => value !== undefined)

package/dist/tools/serper.cjs

@@ -14,6 +14,11 @@ class Serper extends base_js_1.Tool {
     static lc_name() {
         return "Serper";
     }
+    /**
+     * Converts the Serper instance to JSON. This method is not implemented
+     * and will throw an error if called.
+     * @returns Throws an error.
+     */
     toJSON() {
         return this.toJSONNotImplemented();
     }

package/dist/tools/serper.d.ts

@@ -1,4 +1,8 @@
 import { Tool } from "./base.js";
+/**
+ * Defines the parameters that can be passed to the Serper class during
+ * instantiation. It includes `gl` and `hl` which are optional.
+ */
 export type SerperParameters = {
     gl?: string;
     hl?: string;
@@ -12,6 +16,11 @@ export type SerperParameters = {
  */
 export declare class Serper extends Tool {
     static lc_name(): string;
+    /**
+     * Converts the Serper instance to JSON. This method is not implemented
+     * and will throw an error if called.
+     * @returns Throws an error.
+     */
     toJSON(): import("../load/serializable.js").SerializedNotImplemented;
     protected key: string;
     protected params: Partial<SerperParameters>;

package/dist/tools/serper.js

@@ -11,6 +11,11 @@ export class Serper extends Tool {
     static lc_name() {
         return "Serper";
     }
+    /**
+     * Converts the Serper instance to JSON. This method is not implemented
+     * and will throw an error if called.
+     * @returns Throws an error.
+     */
     toJSON() {
         return this.toJSONNotImplemented();
     }

package/dist/tools/sql.cjs

@@ -5,6 +5,12 @@ const base_js_1 = require("./base.cjs");
 const openai_js_1 = require("../llms/openai.cjs");
 const llm_chain_js_1 = require("../chains/llm_chain.cjs");
 const prompt_js_1 = require("../prompts/prompt.cjs");
+/**
+ * A tool for executing SQL queries. It takes a SQL database as a
+ * parameter and assigns it to the `db` property. The `_call` method is
+ * used to run the SQL query and return the result. If the query is
+ * incorrect, an error message is returned.
+ */
 class QuerySqlTool extends base_js_1.Tool {
     static lc_name() {
         return "QuerySqlTool";
@@ -44,6 +50,13 @@ class QuerySqlTool extends base_js_1.Tool {
     }
 }
 exports.QuerySqlTool = QuerySqlTool;
+/**
+ * A tool for retrieving information about SQL tables. It takes a SQL
+ * database as a parameter and assigns it to the `db` property. The
+ * `_call` method is used to retrieve the schema and sample rows for the
+ * specified tables. If the tables do not exist, an error message is
+ * returned.
+ */
 class InfoSqlTool extends base_js_1.Tool {
     static lc_name() {
         return "InfoSqlTool";
@@ -85,6 +98,12 @@ class InfoSqlTool extends base_js_1.Tool {
     }
 }
 exports.InfoSqlTool = InfoSqlTool;
+/**
+ * A tool for listing all tables in a SQL database. It takes a SQL
+ * database as a parameter and assigns it to the `db` property. The
+ * `_call` method is used to return a comma-separated list of all tables
+ * in the database.
+ */
 class ListTablesSqlTool extends base_js_1.Tool {
     static lc_name() {
         return "ListTablesSqlTool";
@@ -123,6 +142,12 @@ class ListTablesSqlTool extends base_js_1.Tool {
     }
 }
 exports.ListTablesSqlTool = ListTablesSqlTool;
+/**
+ * A tool for checking SQL queries for common mistakes. It takes a
+ * LLMChain or QueryCheckerToolArgs as a parameter. The `_call` method is
+ * used to check the input query for common mistakes and returns a
+ * prediction.
+ */
 class QueryCheckerTool extends base_js_1.Tool {
     static lc_name() {
         return "QueryCheckerTool";

package/dist/tools/sql.d.ts

@@ -2,9 +2,19 @@ import { Tool } from "./base.js";
 import { LLMChain } from "../chains/llm_chain.js";
 import type { SqlDatabase } from "../sql_db.js";
 import { BaseLanguageModel } from "../base_language/index.js";
+/**
+ * Interface for SQL tools. It has a `db` property which is a SQL
+ * database.
+ */
 interface SqlTool {
     db: SqlDatabase;
 }
+/**
+ * A tool for executing SQL queries. It takes a SQL database as a
+ * parameter and assigns it to the `db` property. The `_call` method is
+ * used to run the SQL query and return the result. If the query is
+ * incorrect, an error message is returned.
+ */
 export declare class QuerySqlTool extends Tool implements SqlTool {
     static lc_name(): string;
     name: string;
@@ -14,6 +24,13 @@ export declare class QuerySqlTool extends Tool implements SqlTool {
     _call(input: string): Promise<string>;
     description: string;
 }
+/**
+ * A tool for retrieving information about SQL tables. It takes a SQL
+ * database as a parameter and assigns it to the `db` property. The
+ * `_call` method is used to retrieve the schema and sample rows for the
+ * specified tables. If the tables do not exist, an error message is
+ * returned.
+ */
 export declare class InfoSqlTool extends Tool implements SqlTool {
     static lc_name(): string;
     name: string;
@@ -23,6 +40,12 @@ export declare class InfoSqlTool extends Tool implements SqlTool {
     _call(input: string): Promise<string>;
     description: string;
 }
+/**
+ * A tool for listing all tables in a SQL database. It takes a SQL
+ * database as a parameter and assigns it to the `db` property. The
+ * `_call` method is used to return a comma-separated list of all tables
+ * in the database.
+ */
 export declare class ListTablesSqlTool extends Tool implements SqlTool {
     static lc_name(): string;
     name: string;
@@ -32,11 +55,20 @@ export declare class ListTablesSqlTool extends Tool implements SqlTool {
     _call(_: string): Promise<string>;
     description: string;
 }
+/**
+ * Arguments for the QueryCheckerTool class.
+ */
 type QueryCheckerToolArgs = {
     llmChain?: LLMChain;
     llm?: BaseLanguageModel;
     _chainType?: never;
 };
+/**
+ * A tool for checking SQL queries for common mistakes. It takes a
+ * LLMChain or QueryCheckerToolArgs as a parameter. The `_call` method is
+ * used to check the input query for common mistakes and returns a
+ * prediction.
+ */
 export declare class QueryCheckerTool extends Tool {
     static lc_name(): string;
     name: string;