langchain 0.0.130 → 0.0.132

package/dist/document_loaders/web/cheerio.cjs

@@ -4,6 +4,11 @@ exports.CheerioWebBaseLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
 const async_caller_js_1 = require("../../util/async_caller.cjs");
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader for loading
+ * web-based documents using Cheerio.
+ */
 class CheerioWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, fields) {
         super();
@@ -52,15 +57,31 @@ class CheerioWebBaseLoader extends base_js_1.BaseDocumentLoader {
             (await response.text());
         return load(html);
     }
+    /**
+     * Fetches the web document from the webPath and loads it using Cheerio.
+     * It returns a CheerioAPI instance.
+     * @returns A Promise that resolves to a CheerioAPI instance.
+     */
     async scrape() {
         return CheerioWebBaseLoader._scrape(this.webPath, this.caller, this.timeout, this.textDecoder);
     }
+    /**
+     * Extracts the text content from the loaded document using the selector
+     * and creates a Document instance with the extracted text and metadata.
+     * It returns an array of Document instances.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     async load() {
         const $ = await this.scrape();
         const text = $(this.selector).text();
         const metadata = { source: this.webPath };
         return [new document_js_1.Document({ pageContent: text, metadata })];
     }
+    /**
+     * A static method that dynamically imports the Cheerio library and
+     * returns the load function. If the import fails, it throws an error.
+     * @returns A Promise that resolves to an object containing the load function from the Cheerio library.
+     */
     static async imports() {
         try {
             const { load } = await import("cheerio");

package/dist/document_loaders/web/cheerio.d.ts

@@ -3,6 +3,11 @@ import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 import type { DocumentLoader } from "../base.js";
 import { AsyncCaller, AsyncCallerParams } from "../../util/async_caller.js";
+/**
+ * Represents the parameters for configuring the CheerioWebBaseLoader. It
+ * extends the AsyncCallerParams interface and adds additional parameters
+ * specific to web-based loaders.
+ */
 export interface WebBaseLoaderParams extends AsyncCallerParams {
     /**
      * The timeout in milliseconds for the fetch request. Defaults to 10s.
@@ -18,6 +23,11 @@ export interface WebBaseLoaderParams extends AsyncCallerParams {
      */
     textDecoder?: TextDecoder;
 }
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader for loading
+ * web-based documents using Cheerio.
+ */
 export declare class CheerioWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;
     timeout: number;
@@ -26,8 +36,24 @@ export declare class CheerioWebBaseLoader extends BaseDocumentLoader implements
     textDecoder?: TextDecoder;
     constructor(webPath: string, fields?: WebBaseLoaderParams);
     static _scrape(url: string, caller: AsyncCaller, timeout: number | undefined, textDecoder?: TextDecoder): Promise<CheerioAPI>;
+    /**
+     * Fetches the web document from the webPath and loads it using Cheerio.
+     * It returns a CheerioAPI instance.
+     * @returns A Promise that resolves to a CheerioAPI instance.
+     */
     scrape(): Promise<CheerioAPI>;
+    /**
+     * Extracts the text content from the loaded document using the selector
+     * and creates a Document instance with the extracted text and metadata.
+     * It returns an array of Document instances.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     load(): Promise<Document[]>;
+    /**
+     * A static method that dynamically imports the Cheerio library and
+     * returns the load function. If the import fails, it throws an error.
+     * @returns A Promise that resolves to an object containing the load function from the Cheerio library.
+     */
     static imports(): Promise<{
         load: typeof LoadT;
     }>;

package/dist/document_loaders/web/cheerio.js

@@ -1,6 +1,11 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 import { AsyncCaller } from "../../util/async_caller.js";
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader for loading
+ * web-based documents using Cheerio.
+ */
 export class CheerioWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, fields) {
         super();
@@ -49,15 +54,31 @@ export class CheerioWebBaseLoader extends BaseDocumentLoader {
             (await response.text());
         return load(html);
     }
+    /**
+     * Fetches the web document from the webPath and loads it using Cheerio.
+     * It returns a CheerioAPI instance.
+     * @returns A Promise that resolves to a CheerioAPI instance.
+     */
     async scrape() {
         return CheerioWebBaseLoader._scrape(this.webPath, this.caller, this.timeout, this.textDecoder);
     }
+    /**
+     * Extracts the text content from the loaded document using the selector
+     * and creates a Document instance with the extracted text and metadata.
+     * It returns an array of Document instances.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     async load() {
         const $ = await this.scrape();
         const text = $(this.selector).text();
         const metadata = { source: this.webPath };
         return [new Document({ pageContent: text, metadata })];
     }
+    /**
+     * A static method that dynamically imports the Cheerio library and
+     * returns the load function. If the import fails, it throws an error.
+     * @returns A Promise that resolves to an object containing the load function from the Cheerio library.
+     */
     static async imports() {
         try {
             const { load } = await import("cheerio");

package/dist/document_loaders/web/college_confidential.cjs

@@ -3,10 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CollegeConfidentialLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const cheerio_js_1 = require("./cheerio.cjs");
+/**
+ * A document loader specifically designed for loading documents from the
+ * College Confidential website. It extends the CheerioWebBaseLoader.
+ */
 class CollegeConfidentialLoader extends cheerio_js_1.CheerioWebBaseLoader {
     constructor(webPath) {
         super(webPath);
     }
+    /**
+     * Overrides the base load() method to extract the text content from the
+     * loaded document using a specific selector for the College Confidential
+     * website. It creates a Document instance with the extracted text and
+     * metadata, and returns an array containing the Document instance.
+     * @returns An array containing a Document instance with the extracted text and metadata from the loaded College Confidential web document.
+     */
     async load() {
         const $ = await this.scrape();
         const text = $("main[class='skin-handler']").text();

package/dist/document_loaders/web/college_confidential.d.ts

@@ -1,6 +1,17 @@
 import { Document } from "../../document.js";
 import { CheerioWebBaseLoader } from "./cheerio.js";
+/**
+ * A document loader specifically designed for loading documents from the
+ * College Confidential website. It extends the CheerioWebBaseLoader.
+ */
 export declare class CollegeConfidentialLoader extends CheerioWebBaseLoader {
     constructor(webPath: string);
+    /**
+     * Overrides the base load() method to extract the text content from the
+     * loaded document using a specific selector for the College Confidential
+     * website. It creates a Document instance with the extracted text and
+     * metadata, and returns an array containing the Document instance.
+     * @returns An array containing a Document instance with the extracted text and metadata from the loaded College Confidential web document.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/college_confidential.js

@@ -1,9 +1,20 @@
 import { Document } from "../../document.js";
 import { CheerioWebBaseLoader } from "./cheerio.js";
+/**
+ * A document loader specifically designed for loading documents from the
+ * College Confidential website. It extends the CheerioWebBaseLoader.
+ */
 export class CollegeConfidentialLoader extends CheerioWebBaseLoader {
     constructor(webPath) {
         super(webPath);
     }
+    /**
+     * Overrides the base load() method to extract the text content from the
+     * loaded document using a specific selector for the College Confidential
+     * website. It creates a Document instance with the extracted text and
+     * metadata, and returns an array containing the Document instance.
+     * @returns An array containing a Document instance with the extracted text and metadata from the loaded College Confidential web document.
+     */
     async load() {
         const $ = await this.scrape();
         const text = $("main[class='skin-handler']").text();

package/dist/document_loaders/web/confluence.cjs

@@ -4,6 +4,9 @@ exports.ConfluencePagesLoader = void 0;
 const html_to_text_1 = require("html-to-text");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for loading pages from Confluence.
+ */
 class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
     constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {
         super();
@@ -43,6 +46,11 @@ class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
         this.accessToken = accessToken;
         this.limit = limit;
     }
+    /**
+     * Fetches all the pages in the specified space and converts each page to
+     * a Document instance.
+     * @returns Promise resolving to an array of Document instances.
+     */
     async load() {
         try {
             const pages = await this.fetchAllPagesInSpace();
@@ -53,6 +61,11 @@ class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
             return [];
         }
     }
+    /**
+     * Fetches data from the Confluence API using the provided URL.
+     * @param url The URL to fetch data from.
+     * @returns Promise resolving to the JSON response from the API.
+     */
     async fetchConfluenceData(url) {
         try {
             const authToken = Buffer.from(`${this.username}:${this.accessToken}`).toString("base64");
@@ -72,6 +85,11 @@ class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
             throw new Error(`Failed to fetch ${url} from Confluence: ${error}`);
         }
     }
+    /**
+     * Recursively fetches all the pages in the specified space.
+     * @param start The start parameter to paginate through the results.
+     * @returns Promise resolving to an array of ConfluencePage objects.
+     */
     async fetchAllPagesInSpace(start = 0) {
         const url = `${this.baseUrl}/rest/api/content?spaceKey=${this.spaceKey}&limit=${this.limit}&start=${start}&expand=body.storage`;
         const data = await this.fetchConfluenceData(url);
@@ -82,6 +100,11 @@ class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
         const nextPageResults = await this.fetchAllPagesInSpace(nextPageStart);
         return data.results.concat(nextPageResults);
     }
+    /**
+     * Creates a Document instance from a ConfluencePage object.
+     * @param page The ConfluencePage object to convert.
+     * @returns A Document instance.
+     */
     createDocumentFromPage(page) {
         // Convert the HTML content to plain text
         const plainTextContent = (0, html_to_text_1.htmlToText)(page.body.storage.value, {

package/dist/document_loaders/web/confluence.d.ts

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Interface representing the parameters for configuring the
+ * ConfluencePagesLoader.
+ */
 export interface ConfluencePagesLoaderParams {
     baseUrl: string;
     spaceKey: string;
@@ -7,6 +11,9 @@ export interface ConfluencePagesLoaderParams {
     accessToken: string;
     limit?: number;
 }
+/**
+ * Interface representing a Confluence page.
+ */
 export interface ConfluencePage {
     id: string;
     title: string;
@@ -16,10 +23,16 @@ export interface ConfluencePage {
         };
     };
 }
+/**
+ * Interface representing the response from the Confluence API.
+ */
 export interface ConfluenceAPIResponse {
     size: number;
     results: ConfluencePage[];
 }
+/**
+ * Class representing a document loader for loading pages from Confluence.
+ */
 export declare class ConfluencePagesLoader extends BaseDocumentLoader {
     readonly baseUrl: string;
     readonly spaceKey: string;
@@ -27,8 +40,28 @@ export declare class ConfluencePagesLoader extends BaseDocumentLoader {
     readonly accessToken: string;
     readonly limit: number;
     constructor({ baseUrl, spaceKey, username, accessToken, limit, }: ConfluencePagesLoaderParams);
+    /**
+     * Fetches all the pages in the specified space and converts each page to
+     * a Document instance.
+     * @returns Promise resolving to an array of Document instances.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Fetches data from the Confluence API using the provided URL.
+     * @param url The URL to fetch data from.
+     * @returns Promise resolving to the JSON response from the API.
+     */
     protected fetchConfluenceData(url: string): Promise<ConfluenceAPIResponse>;
+    /**
+     * Recursively fetches all the pages in the specified space.
+     * @param start The start parameter to paginate through the results.
+     * @returns Promise resolving to an array of ConfluencePage objects.
+     */
     private fetchAllPagesInSpace;
+    /**
+     * Creates a Document instance from a ConfluencePage object.
+     * @param page The ConfluencePage object to convert.
+     * @returns A Document instance.
+     */
     private createDocumentFromPage;
 }

package/dist/document_loaders/web/confluence.js

@@ -1,6 +1,9 @@
 import { htmlToText } from "html-to-text";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading pages from Confluence.
+ */
 export class ConfluencePagesLoader extends BaseDocumentLoader {
     constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {
         super();
@@ -40,6 +43,11 @@ export class ConfluencePagesLoader extends BaseDocumentLoader {
         this.accessToken = accessToken;
         this.limit = limit;
     }
+    /**
+     * Fetches all the pages in the specified space and converts each page to
+     * a Document instance.
+     * @returns Promise resolving to an array of Document instances.
+     */
     async load() {
         try {
             const pages = await this.fetchAllPagesInSpace();
@@ -50,6 +58,11 @@ export class ConfluencePagesLoader extends BaseDocumentLoader {
             return [];
         }
     }
+    /**
+     * Fetches data from the Confluence API using the provided URL.
+     * @param url The URL to fetch data from.
+     * @returns Promise resolving to the JSON response from the API.
+     */
     async fetchConfluenceData(url) {
         try {
             const authToken = Buffer.from(`${this.username}:${this.accessToken}`).toString("base64");
@@ -69,6 +82,11 @@ export class ConfluencePagesLoader extends BaseDocumentLoader {
             throw new Error(`Failed to fetch ${url} from Confluence: ${error}`);
         }
     }
+    /**
+     * Recursively fetches all the pages in the specified space.
+     * @param start The start parameter to paginate through the results.
+     * @returns Promise resolving to an array of ConfluencePage objects.
+     */
     async fetchAllPagesInSpace(start = 0) {
         const url = `${this.baseUrl}/rest/api/content?spaceKey=${this.spaceKey}&limit=${this.limit}&start=${start}&expand=body.storage`;
         const data = await this.fetchConfluenceData(url);
@@ -79,6 +97,11 @@ export class ConfluencePagesLoader extends BaseDocumentLoader {
         const nextPageResults = await this.fetchAllPagesInSpace(nextPageStart);
         return data.results.concat(nextPageResults);
     }
+    /**
+     * Creates a Document instance from a ConfluencePage object.
+     * @param page The ConfluencePage object to convert.
+     * @returns A Document instance.
+     */
     createDocumentFromPage(page) {
         // Convert the HTML content to plain text
         const plainTextContent = htmlToText(page.body.storage.value, {

package/dist/document_loaders/web/figma.cjs

@@ -4,6 +4,12 @@ exports.FigmaFileLoader = void 0;
 const base_js_1 = require("../base.cjs");
 const document_js_1 = require("../../document.cjs");
 const env_js_1 = require("../../util/env.cjs");
+/**
+ * Class representing a document loader for loading Figma files. It
+ * extends the BaseDocumentLoader and implements the FigmaLoaderParams
+ * interface. The constructor takes a config object as a parameter, which
+ * contains the access token, an array of node IDs, and the file key.
+ */
 class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
     constructor({ accessToken = (0, env_js_1.getEnvironmentVariable)("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
         super();
@@ -40,9 +46,18 @@ class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
             };
         }
     }
+    /**
+     * Constructs the URL for the Figma API call.
+     * @returns The constructed URL as a string.
+     */
     constructFigmaApiURL() {
         return `https://api.figma.com/v1/files/${this.fileKey}/nodes?ids=${this.nodeIds.join(",")}`;
     }
+    /**
+     * Fetches the Figma file using the Figma API and returns it as a
+     * FigmaFile object.
+     * @returns A Promise that resolves to a FigmaFile object.
+     */
     async getFigmaFile() {
         const url = this.constructFigmaApiURL();
         const response = await fetch(url, { headers: this.headers });
@@ -55,6 +70,12 @@ class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
         }
         return data;
     }
+    /**
+     * Fetches the Figma file using the Figma API, creates a Document instance
+     * with the JSON representation of the file as the page content and the
+     * API URL as the metadata, and returns it.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     async load() {
         const data = await this.getFigmaFile();
         const text = JSON.stringify(data);

package/dist/document_loaders/web/figma.d.ts

@@ -1,5 +1,11 @@
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
+/**
+ * Interface representing a Figma file. It includes properties for the
+ * file name, role, last modified date, editor type, thumbnail URL,
+ * version, document node, schema version, main file key, and an array of
+ * branches.
+ */
 export interface FigmaFile {
     name: string;
     role: string;
@@ -18,18 +24,44 @@ export interface FigmaFile {
         link_access: string;
     }>;
 }
+/**
+ * Interface representing the parameters for configuring the FigmaLoader.
+ * It includes optional properties for the access token, an array of node
+ * IDs, and the file key.
+ */
 export interface FigmaLoaderParams {
     accessToken?: string;
     nodeIds: string[];
     fileKey: string;
 }
+/**
+ * Class representing a document loader for loading Figma files. It
+ * extends the BaseDocumentLoader and implements the FigmaLoaderParams
+ * interface. The constructor takes a config object as a parameter, which
+ * contains the access token, an array of node IDs, and the file key.
+ */
 export declare class FigmaFileLoader extends BaseDocumentLoader implements FigmaLoaderParams {
     accessToken?: string;
     nodeIds: string[];
     fileKey: string;
     private headers;
     constructor({ accessToken, nodeIds, fileKey, }: FigmaLoaderParams);
+    /**
+     * Constructs the URL for the Figma API call.
+     * @returns The constructed URL as a string.
+     */
     private constructFigmaApiURL;
+    /**
+     * Fetches the Figma file using the Figma API and returns it as a
+     * FigmaFile object.
+     * @returns A Promise that resolves to a FigmaFile object.
+     */
     private getFigmaFile;
+    /**
+     * Fetches the Figma file using the Figma API, creates a Document instance
+     * with the JSON representation of the file as the page content and the
+     * API URL as the metadata, and returns it.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/figma.js

@@ -1,6 +1,12 @@
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
 import { getEnvironmentVariable } from "../../util/env.js";
+/**
+ * Class representing a document loader for loading Figma files. It
+ * extends the BaseDocumentLoader and implements the FigmaLoaderParams
+ * interface. The constructor takes a config object as a parameter, which
+ * contains the access token, an array of node IDs, and the file key.
+ */
 export class FigmaFileLoader extends BaseDocumentLoader {
     constructor({ accessToken = getEnvironmentVariable("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
         super();
@@ -37,9 +43,18 @@ export class FigmaFileLoader extends BaseDocumentLoader {
             };
         }
     }
+    /**
+     * Constructs the URL for the Figma API call.
+     * @returns The constructed URL as a string.
+     */
     constructFigmaApiURL() {
         return `https://api.figma.com/v1/files/${this.fileKey}/nodes?ids=${this.nodeIds.join(",")}`;
     }
+    /**
+     * Fetches the Figma file using the Figma API and returns it as a
+     * FigmaFile object.
+     * @returns A Promise that resolves to a FigmaFile object.
+     */
     async getFigmaFile() {
         const url = this.constructFigmaApiURL();
         const response = await fetch(url, { headers: this.headers });
@@ -52,6 +67,12 @@ export class FigmaFileLoader extends BaseDocumentLoader {
         }
         return data;
     }
+    /**
+     * Fetches the Figma file using the Figma API, creates a Document instance
+     * with the JSON representation of the file as the page content and the
+     * API URL as the metadata, and returns it.
+     * @returns A Promise that resolves to an array of Document instances.
+     */
     async load() {
         const data = await this.getFigmaFile();
         const text = JSON.stringify(data);

package/dist/document_loaders/web/gitbook.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GitbookLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const cheerio_js_1 = require("./cheerio.cjs");
+/**
+ * Class representing a document loader specifically designed for loading
+ * documents from Gitbook. It extends the CheerioWebBaseLoader.
+ */
 class GitbookLoader extends cheerio_js_1.CheerioWebBaseLoader {
     constructor(webPath, params = {}) {
         const path = params.shouldLoadAllPaths === true ? `${webPath}/sitemap.xml` : webPath;
@@ -23,6 +27,13 @@ class GitbookLoader extends cheerio_js_1.CheerioWebBaseLoader {
         this.shouldLoadAllPaths =
             params.shouldLoadAllPaths ?? this.shouldLoadAllPaths;
     }
+    /**
+     * Method that scrapes the web document using Cheerio and loads the
+     * content based on the value of shouldLoadAllPaths. If shouldLoadAllPaths
+     * is true, it calls the loadAllPaths() method to load all paths.
+     * Otherwise, it calls the loadPath() method to load a single path.
+     * @returns Promise resolving to an array of Document instances.
+     */
     async load() {
         const $ = await this.scrape();
         if (this.shouldLoadAllPaths === true) {
@@ -30,6 +41,18 @@ class GitbookLoader extends cheerio_js_1.CheerioWebBaseLoader {
         }
         return this.loadPath($);
     }
+    /**
+     * Private method that loads the content of a single path from the Gitbook
+     * web document. It extracts the page content by selecting all elements
+     * inside the "main" element, filters out empty text nodes, and joins the
+     * remaining text nodes with line breaks. It extracts the title by
+     * selecting the first "h1" element inside the "main" element. It creates
+     * a Document instance with the extracted page content and metadata
+     * containing the source URL and title.
+     * @param $ CheerioAPI instance representing the loaded web document.
+     * @param url Optional string representing the URL of the web document.
+     * @returns Array of Document instances.
+     */
     loadPath($, url) {
         const pageContent = $("main *")
             .contents()
@@ -45,6 +68,16 @@ class GitbookLoader extends cheerio_js_1.CheerioWebBaseLoader {
             }),
         ];
     }
+    /**
+     * Private method that loads the content of all paths from the Gitbook web
+     * document. It extracts the URLs of all paths from the "loc" elements in
+     * the sitemap.xml. It iterates over each URL, scrapes the web document
+     * using the _scrape() method, and calls the loadPath() method to load the
+     * content of each path. It collects all the loaded documents and returns
+     * them as an array.
+     * @param $ CheerioAPI instance representing the loaded web document.
+     * @returns Promise resolving to an array of Document instances.
+     */
     async loadAllPaths($) {
         const urls = $("loc")
             .toArray()

package/dist/document_loaders/web/gitbook.d.ts

@@ -1,14 +1,52 @@
 import { Document } from "../../document.js";
 import { CheerioWebBaseLoader } from "./cheerio.js";
+/**
+ * Interface representing the parameters for configuring the
+ * GitbookLoader. It has an optional property shouldLoadAllPaths, which
+ * indicates whether all paths should be loaded.
+ */
 interface GitbookLoaderParams {
     shouldLoadAllPaths?: boolean;
 }
+/**
+ * Class representing a document loader specifically designed for loading
+ * documents from Gitbook. It extends the CheerioWebBaseLoader.
+ */
 export declare class GitbookLoader extends CheerioWebBaseLoader {
     webPath: string;
     shouldLoadAllPaths: boolean;
     constructor(webPath: string, params?: GitbookLoaderParams);
+    /**
+     * Method that scrapes the web document using Cheerio and loads the
+     * content based on the value of shouldLoadAllPaths. If shouldLoadAllPaths
+     * is true, it calls the loadAllPaths() method to load all paths.
+     * Otherwise, it calls the loadPath() method to load a single path.
+     * @returns Promise resolving to an array of Document instances.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Private method that loads the content of a single path from the Gitbook
+     * web document. It extracts the page content by selecting all elements
+     * inside the "main" element, filters out empty text nodes, and joins the
+     * remaining text nodes with line breaks. It extracts the title by
+     * selecting the first "h1" element inside the "main" element. It creates
+     * a Document instance with the extracted page content and metadata
+     * containing the source URL and title.
+     * @param $ CheerioAPI instance representing the loaded web document.
+     * @param url Optional string representing the URL of the web document.
+     * @returns Array of Document instances.
+     */
     private loadPath;
+    /**
+     * Private method that loads the content of all paths from the Gitbook web
+     * document. It extracts the URLs of all paths from the "loc" elements in
+     * the sitemap.xml. It iterates over each URL, scrapes the web document
+     * using the _scrape() method, and calls the loadPath() method to load the
+     * content of each path. It collects all the loaded documents and returns
+     * them as an array.
+     * @param $ CheerioAPI instance representing the loaded web document.
+     * @returns Promise resolving to an array of Document instances.
+     */
     private loadAllPaths;
 }
 export {};