langchain 0.0.131 → 0.0.132

package/dist/document_loaders/web/notiondb.js

@@ -48,6 +48,10 @@ export class NotionDBLoader extends BaseDocumentLoader {
             "Notion-Version": notionApiVersion,
         };
     }
+    /**
+     * Loads the documents from Notion based on the specified options.
+     * @returns An array of Document objects.
+     */
     async load() {
         const pageIds = await this.retrievePageIds();
         const documents = [];
@@ -56,6 +60,10 @@ export class NotionDBLoader extends BaseDocumentLoader {
         }
         return documents;
     }
+    /**
+     * Retrieves the IDs of the pages in the Notion database.
+     * @returns An array of page IDs.
+     */
     async retrievePageIds() {
         const url = `${NOTION_BASE_URL}/databases/${this.databaseId}/query`;
         const pageIds = [];
@@ -80,6 +88,11 @@ export class NotionDBLoader extends BaseDocumentLoader {
         }
         return pageIds;
     }
+    /**
+     * Loads a Notion page and returns it as a Document object.
+     * @param pageId The ID of the Notion page to load.
+     * @returns A Document object representing the loaded Notion page.
+     */
     async loadPage(pageId) {
         const url = `${NOTION_BASE_URL}/pages/${pageId}`;
         const response = await fetch(url, { method: "GET", headers: this.headers });
@@ -129,6 +142,12 @@ export class NotionDBLoader extends BaseDocumentLoader {
             metadata,
         };
     }
+    /**
+     * Loads the blocks of a Notion page and returns them as a string.
+     * @param blockId The ID of the block to load.
+     * @param numberOfTabs The number of tabs to use for indentation.
+     * @returns A string representing the loaded blocks.
+     */
     async loadBlocks(blockId, numberOfTabs = 0) {
         const resultLinesArr = [];
         let currentBlockId = blockId;

package/dist/document_loaders/web/playwright.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightWebBaseLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 class PlaywrightWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -38,14 +43,31 @@ class PlaywrightWebBaseLoader extends base_js_1.BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PlaywrightWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new document_js_1.Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static async imports() {
         try {
             const { chromium } = await import("playwright");

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

@@ -8,19 +8,46 @@ export type PlaywrightGotoOptions = {
     timeout?: number;
     waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit";
 };
+/**
+ * Type representing a function for evaluating JavaScript code on a web
+ * page using Playwright. Takes a Page, Browser, and Response object as
+ * parameters and returns a Promise that resolves to a string.
+ */
 export type PlaywrightEvaluate = (page: Page, browser: Browser, response: Response | null) => Promise<string>;
 export type PlaywrightWebBaseLoaderOptions = {
     launchOptions?: LaunchOptions;
     gotoOptions?: PlaywrightGotoOptions;
     evaluate?: PlaywrightEvaluate;
 };
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 export declare class PlaywrightWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;
     options: PlaywrightWebBaseLoaderOptions | undefined;
     constructor(webPath: string, options?: PlaywrightWebBaseLoaderOptions);
     static _scrape(url: string, options?: PlaywrightWebBaseLoaderOptions): Promise<string>;
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     scrape(): Promise<string>;
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static imports(): Promise<{
         chromium: typeof import("playwright").chromium;
     }>;

package/dist/document_loaders/web/playwright.js

@@ -1,5 +1,10 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for scraping web pages using
+ * Playwright. Extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface.
+ */
 export class PlaywrightWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -35,14 +40,31 @@ export class PlaywrightWebBaseLoader extends BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property. Returns a Promise that resolves
+     * to the scraped HTML content of the web page.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PlaywrightWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object. Returns a Promise that resolves to an
+     * array of Document objects.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Playwright modules. Returns a
+     * Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported modules.
+     */
     static async imports() {
         try {
             const { chromium } = await import("playwright");

package/dist/document_loaders/web/puppeteer.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PuppeteerWebBaseLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -40,14 +45,29 @@ class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PuppeteerWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new document_js_1.Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static async imports() {
         try {
             // eslint-disable-next-line import/no-extraneous-dependencies

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

@@ -7,19 +7,44 @@ export type PuppeteerGotoOptions = WaitForOptions & {
     referer?: string;
     referrerPolicy?: string;
 };
+/**
+ * Type representing a function for evaluating JavaScript code on a web
+ * page using Puppeteer. It takes a Page and Browser object as parameters
+ * and returns a Promise that resolves to a string.
+ */
 export type PuppeteerEvaluate = (page: Page, browser: Browser) => Promise<string>;
 export type PuppeteerWebBaseLoaderOptions = {
     launchOptions?: PuppeteerLaunchOptions;
     gotoOptions?: PuppeteerGotoOptions;
     evaluate?: PuppeteerEvaluate;
 };
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 export declare class PuppeteerWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;
     options: PuppeteerWebBaseLoaderOptions | undefined;
     constructor(webPath: string, options?: PuppeteerWebBaseLoaderOptions);
     static _scrape(url: string, options?: PuppeteerWebBaseLoaderOptions): Promise<string>;
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     scrape(): Promise<string>;
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static imports(): Promise<{
         launch: typeof launch;
     }>;

package/dist/document_loaders/web/puppeteer.js

@@ -1,5 +1,10 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class that extends the BaseDocumentLoader class and implements the
+ * DocumentLoader interface. It represents a document loader for scraping
+ * web pages using Puppeteer.
+ */
 export class PuppeteerWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, options) {
         super();
@@ -37,14 +42,29 @@ export class PuppeteerWebBaseLoader extends BaseDocumentLoader {
         await browser.close();
         return bodyHTML;
     }
+    /**
+     * Method that calls the _scrape method to perform the scraping of the web
+     * page specified by the webPath property.
+     * @returns Promise that resolves to the scraped HTML content of the web page.
+     */
     async scrape() {
         return PuppeteerWebBaseLoader._scrape(this.webPath, this.options);
     }
+    /**
+     * Method that calls the scrape method and returns the scraped HTML
+     * content as a Document object.
+     * @returns Promise that resolves to an array of Document objects.
+     */
     async load() {
         const text = await this.scrape();
         const metadata = { source: this.webPath };
         return [new Document({ pageContent: text, metadata })];
     }
+    /**
+     * Static method that imports the necessary Puppeteer modules. It returns
+     * a Promise that resolves to an object containing the imported modules.
+     * @returns Promise that resolves to an object containing the imported Puppeteer modules.
+     */
     static async imports() {
         try {
             // eslint-disable-next-line import/no-extraneous-dependencies

package/dist/document_loaders/web/s3.cjs

@@ -31,6 +31,10 @@ const node_stream_1 = require("node:stream");
 const client_s3_1 = require("@aws-sdk/client-s3");
 const base_js_1 = require("../base.cjs");
 const unstructured_js_1 = require("../fs/unstructured.cjs");
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 class S3Loader extends base_js_1.BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = unstructured_js_1.UnstructuredLoader, }) {
         super();
@@ -84,6 +88,11 @@ class S3Loader extends base_js_1.BaseDocumentLoader {
         this._fs = fs;
         this._UnstructuredLoader = UnstructuredLoader;
     }
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     async load() {
         const tempDir = this._fs.mkdtempSync(path.join(os.tmpdir(), "s3fileloader-"));
         const filePath = path.join(tempDir, this.key);

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

@@ -3,12 +3,24 @@ import * as fsDefault from "node:fs";
 import { S3ClientConfig } from "@aws-sdk/client-s3";
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoader as UnstructuredLoaderDefault } from "../fs/unstructured.js";
+/**
+ * Represents the configuration options for the S3 client. It extends the
+ * S3ClientConfig interface from the "@aws-sdk/client-s3" package and
+ * includes additional deprecated properties for access key ID and secret
+ * access key.
+ */
 export type S3Config = S3ClientConfig & {
     /** @deprecated Use the credentials object instead */
     accessKeyId?: string;
     /** @deprecated Use the credentials object instead */
     secretAccessKey?: string;
 };
+/**
+ * Represents the parameters for the S3Loader class. It includes
+ * properties such as the S3 bucket, key, unstructured API URL,
+ * unstructured API key, S3 configuration, file system module, and
+ * UnstructuredLoader module.
+ */
 export interface S3LoaderParams {
     bucket: string;
     key: string;
@@ -23,6 +35,10 @@ export interface S3LoaderParams {
     fs?: typeof fsDefault;
     UnstructuredLoader?: typeof UnstructuredLoaderDefault;
 }
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 export declare class S3Loader extends BaseDocumentLoader {
     private bucket;
     private key;
@@ -32,5 +48,10 @@ export declare class S3Loader extends BaseDocumentLoader {
     private _fs;
     private _UnstructuredLoader;
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config, fs, UnstructuredLoader, }: S3LoaderParams);
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     load(): Promise<import("../../document.js").Document<Record<string, any>>[]>;
 }

package/dist/document_loaders/web/s3.js

@@ -5,6 +5,10 @@ import { Readable } from "node:stream";
 import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3";
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoader as UnstructuredLoaderDefault } from "../fs/unstructured.js";
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 export class S3Loader extends BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = UnstructuredLoaderDefault, }) {
         super();
@@ -58,6 +62,11 @@ export class S3Loader extends BaseDocumentLoader {
         this._fs = fs;
         this._UnstructuredLoader = UnstructuredLoader;
     }
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     async load() {
         const tempDir = this._fs.mkdtempSync(path.join(os.tmpdir(), "s3fileloader-"));
         const filePath = path.join(tempDir, this.key);

package/dist/document_loaders/web/serpapi.cjs

@@ -4,6 +4,10 @@ exports.SerpAPILoader = void 0;
 const env_js_1 = require("../../util/env.cjs");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 class SerpAPILoader extends base_js_1.BaseDocumentLoader {
     constructor(params) {
         super();

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

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Interface representing the parameters for the SerpAPI loader. It
+ * includes properties such as the search query and the API key.
+ */
 interface SerpAPIParameters {
     /**
      * Search Query
@@ -7,6 +11,10 @@ interface SerpAPIParameters {
     q: string;
     apiKey?: string;
 }
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 export declare class SerpAPILoader extends BaseDocumentLoader {
     private apiKey;
     private searchQuery;

package/dist/document_loaders/web/serpapi.js

@@ -1,6 +1,10 @@
 import { getEnvironmentVariable } from "../../util/env.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 export class SerpAPILoader extends BaseDocumentLoader {
     constructor(params) {
         super();

package/dist/document_loaders/web/sonix_audio.cjs

@@ -4,6 +4,10 @@ exports.SonixAudioTranscriptionLoader = void 0;
 const sonix_speech_recognition_1 = require("sonix-speech-recognition");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 class SonixAudioTranscriptionLoader extends base_js_1.BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {
         super();
@@ -22,6 +26,12 @@ class SonixAudioTranscriptionLoader extends base_js_1.BaseDocumentLoader {
         this.sonixSpeechRecognitionService = new sonix_speech_recognition_1.SonixSpeechRecognitionService(sonixAuthKey);
         this.speechToTextRequest = speechToTextRequest;
     }
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     async load() {
         const { text, status, error } = await this.sonixSpeechRecognitionService.speechToText(this.speechToTextRequest);
         if (status === "failed") {

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

@@ -1,6 +1,10 @@
 import { SpeechToTextRequest } from "sonix-speech-recognition/lib/types.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 export declare class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     private readonly sonixSpeechRecognitionService;
     private readonly speechToTextRequest;
@@ -8,5 +12,11 @@ export declare class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
         sonixAuthKey: string;
         request: SpeechToTextRequest;
     });
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/sonix_audio.js

@@ -1,6 +1,10 @@
 import { SonixSpeechRecognitionService } from "sonix-speech-recognition";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 export class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {
         super();
@@ -19,6 +23,12 @@ export class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
         this.sonixSpeechRecognitionService = new SonixSpeechRecognitionService(sonixAuthKey);
         this.speechToTextRequest = speechToTextRequest;
     }
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     async load() {
         const { text, status, error } = await this.sonixSpeechRecognitionService.speechToText(this.speechToTextRequest);
         if (status === "failed") {

package/dist/document_loaders/web/sort_xyz_blockchain.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SortXYZBlockchainLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 class SortXYZBlockchainLoader extends base_js_1.BaseDocumentLoader {
     constructor({ apiKey, query }) {
         super();
@@ -56,6 +60,12 @@ class SortXYZBlockchainLoader extends base_js_1.BaseDocumentLoader {
             this.limit = query.limit ?? 100;
         }
     }
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     async load() {
         if (this.limit > 1000) {
             throw new Error(`Limit is set too high. Please set limit to 1000 or lower.`);

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

@@ -11,10 +11,17 @@ export interface Query {
     blockchain: "ethereum" | "polygon" | "goerli";
     limit?: number;
 }
+/**
+ * Interface representing the parameters for the SortXYZBlockchainLoader
+ * class.
+ */
 export interface SortXYZBlockchainLoaderParams {
     apiKey: string;
     query: Query | string;
 }
+/**
+ * Interface representing the response from the SortXYZ API.
+ */
 export interface SortXYZBlockchainAPIResponse {
     code: number;
     data: {
@@ -25,6 +32,10 @@ export interface SortXYZBlockchainAPIResponse {
         recordCount: number;
     };
 }
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 export declare class SortXYZBlockchainLoader extends BaseDocumentLoader {
     readonly contractAddress: string;
     readonly blockchain: string;
@@ -33,5 +44,11 @@ export declare class SortXYZBlockchainLoader extends BaseDocumentLoader {
     readonly sql: string;
     readonly limit: number;
     constructor({ apiKey, query }: SortXYZBlockchainLoaderParams);
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/sort_xyz_blockchain.js

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 export class SortXYZBlockchainLoader extends BaseDocumentLoader {
     constructor({ apiKey, query }) {
         super();
@@ -53,6 +57,12 @@ export class SortXYZBlockchainLoader extends BaseDocumentLoader {
             this.limit = query.limit ?? 100;
         }
     }
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     async load() {
         if (this.limit > 1000) {
             throw new Error(`Limit is set too high. Please set limit to 1000 or lower.`);

package/dist/document_loaders/web/youtube.cjs

@@ -5,6 +5,11 @@ const youtube_transcript_1 = require("youtube-transcript");
 const youtubei_js_1 = require("youtubei.js");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * A document loader for loading data from YouTube videos. It uses the
+ * youtube-transcript and youtubei.js libraries to fetch the transcript
+ * and video metadata.
+ */
 class YoutubeLoader extends base_js_1.BaseDocumentLoader {
     constructor(config) {
         super();
@@ -30,6 +35,11 @@ class YoutubeLoader extends base_js_1.BaseDocumentLoader {
         this.language = config?.language;
         this.addVideoInfo = config?.addVideoInfo ?? false;
     }
+    /**
+     * Extracts the videoId from a YouTube video URL.
+     * @param url The URL of the YouTube video.
+     * @returns The videoId of the YouTube video.
+     */
     static getVideoID(url) {
         const match = url.match(/.*(?:youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=)([^#&?]*).*/);
         if (match !== null && match[1].length === 11) {
@@ -39,10 +49,23 @@ class YoutubeLoader extends base_js_1.BaseDocumentLoader {
             throw new Error("Failed to get youtube video id from the url");
         }
     }
+    /**
+     * Creates a new instance of the YoutubeLoader class from a YouTube video
+     * URL.
+     * @param url The URL of the YouTube video.
+     * @param config Optional configuration options for the YoutubeLoader instance, excluding the videoId.
+     * @returns A new instance of the YoutubeLoader class.
+     */
     static createFromUrl(url, config) {
         const videoId = YoutubeLoader.getVideoID(url);
         return new YoutubeLoader({ ...config, videoId });
     }
+    /**
+     * Loads the transcript and video metadata from the specified YouTube
+     * video. It uses the youtube-transcript library to fetch the transcript
+     * and the youtubei.js library to fetch the video metadata.
+     * @returns An array of Documents representing the retrieved data.
+     */
     async load() {
         let transcript;
         const metadata = {