langchain 0.0.131 → 0.0.132

package/dist/document_loaders/fs/epub.js

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that extends the `BaseDocumentLoader` class. It represents a
+ * document loader that loads documents from EPUB files.
+ */
 export class EPubLoader extends BaseDocumentLoader {
     constructor(filePath, { splitChapters = true } = {}) {
         super();
@@ -17,6 +21,13 @@ export class EPubLoader extends BaseDocumentLoader {
         });
         this.splitChapters = splitChapters;
     }
+    /**
+     * A protected method that takes an EPUB object as a parameter and returns
+     * a promise that resolves to an array of objects representing the content
+     * and metadata of each chapter.
+     * @param epub The EPUB object to parse.
+     * @returns A promise that resolves to an array of objects representing the content and metadata of each chapter.
+     */
     async parse(epub) {
         const { htmlToText } = await HtmlToTextImport();
         const chapters = await Promise.all(epub.flow.map(async (chapter) => {
@@ -37,6 +48,11 @@ export class EPubLoader extends BaseDocumentLoader {
             },
         }));
     }
+    /**
+     * A method that loads the EPUB file and returns a promise that resolves
+     * to an array of `Document` instances.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     async load() {
         const { EPub } = await EpubImport();
         const epub = await EPub.createAsync(this.filePath);

package/dist/document_loaders/fs/json.cjs

@@ -6,6 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JSONLinesLoader = exports.JSONLoader = void 0;
 const jsonpointer_1 = __importDefault(require("jsonpointer"));
 const text_js_1 = require("./text.cjs");
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON files. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the JSON
+ * file or a `Blob` object, and an optional `pointers` parameter that
+ * specifies the JSON pointers to extract.
+ */
 class JSONLoader extends text_js_1.TextLoader {
     constructor(filePathOrBlob, pointers = []) {
         super(filePathOrBlob);
@@ -17,6 +24,15 @@ class JSONLoader extends text_js_1.TextLoader {
         });
         this.pointers = Array.isArray(pointers) ? pointers : [pointers];
     }
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON string and
+     * extracts the values based on the specified JSON pointers. If no JSON
+     * pointers are specified, it extracts all the strings from the JSON
+     * object.
+     * @param raw The raw JSON string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     async parse(raw) {
         const json = JSON.parse(raw.trim());
         // If there is no pointers specified we extract all strings we found
@@ -72,6 +88,15 @@ class JSONLoader extends text_js_1.TextLoader {
         }
         return [];
     }
+    /**
+     * Method that takes a `json` object and an array of `pointers` as
+     * parameters and returns an array of targeted entries. It iterates over
+     * the JSON pointers and uses the `jsonpointer.get()` function to get the
+     * targeted entries from the JSON object.
+     * @param json The JSON object to get targeted entries from.
+     * @param pointers The JSON pointers to get targeted entries.
+     * @returns An array of targeted entries.
+     */
     getTargetedEntries(json, pointers) {
         const targetEntries = [];
         for (const pointer of pointers) {
@@ -84,6 +109,13 @@ class JSONLoader extends text_js_1.TextLoader {
     }
 }
 exports.JSONLoader = JSONLoader;
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON Lines files. It has a constructor
+ * that takes a `filePathOrBlob` parameter representing the path to the
+ * JSON Lines file or a `Blob` object, and a `pointer` parameter that
+ * specifies the JSON pointer to extract.
+ */
 class JSONLinesLoader extends text_js_1.TextLoader {
     constructor(filePathOrBlob, pointer) {
         super(filePathOrBlob);
@@ -94,6 +126,14 @@ class JSONLinesLoader extends text_js_1.TextLoader {
             value: pointer
         });
     }
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON Lines
+     * string, splits it into lines, parses each line as JSON, and extracts
+     * the values based on the specified JSON pointer.
+     * @param raw The raw JSON Lines string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     async parse(raw) {
         const lines = raw.split("\n");
         const jsons = lines

package/dist/document_loaders/fs/json.d.ts

@@ -1,7 +1,23 @@
 import { TextLoader } from "./text.js";
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON files. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the JSON
+ * file or a `Blob` object, and an optional `pointers` parameter that
+ * specifies the JSON pointers to extract.
+ */
 export declare class JSONLoader extends TextLoader {
     pointers: string[];
     constructor(filePathOrBlob: string | Blob, pointers?: string | string[]);
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON string and
+     * extracts the values based on the specified JSON pointers. If no JSON
+     * pointers are specified, it extracts all the strings from the JSON
+     * object.
+     * @param raw The raw JSON string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     protected parse(raw: string): Promise<string[]>;
     /**
      * If JSON pointers are specified, return all strings below any of them
@@ -10,10 +26,34 @@ export declare class JSONLoader extends TextLoader {
      * If no JSON pointer is specified then return all string in the object
      */
     private extractArrayStringsFromObject;
+    /**
+     * Method that takes a `json` object and an array of `pointers` as
+     * parameters and returns an array of targeted entries. It iterates over
+     * the JSON pointers and uses the `jsonpointer.get()` function to get the
+     * targeted entries from the JSON object.
+     * @param json The JSON object to get targeted entries from.
+     * @param pointers The JSON pointers to get targeted entries.
+     * @returns An array of targeted entries.
+     */
     private getTargetedEntries;
 }
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON Lines files. It has a constructor
+ * that takes a `filePathOrBlob` parameter representing the path to the
+ * JSON Lines file or a `Blob` object, and a `pointer` parameter that
+ * specifies the JSON pointer to extract.
+ */
 export declare class JSONLinesLoader extends TextLoader {
     pointer: string;
     constructor(filePathOrBlob: string | Blob, pointer: string);
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON Lines
+     * string, splits it into lines, parses each line as JSON, and extracts
+     * the values based on the specified JSON pointer.
+     * @param raw The raw JSON Lines string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     protected parse(raw: string): Promise<string[]>;
 }

package/dist/document_loaders/fs/json.js

@@ -1,5 +1,12 @@
 import jsonpointer from "jsonpointer";
 import { TextLoader } from "./text.js";
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON files. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the JSON
+ * file or a `Blob` object, and an optional `pointers` parameter that
+ * specifies the JSON pointers to extract.
+ */
 export class JSONLoader extends TextLoader {
     constructor(filePathOrBlob, pointers = []) {
         super(filePathOrBlob);
@@ -11,6 +18,15 @@ export class JSONLoader extends TextLoader {
         });
         this.pointers = Array.isArray(pointers) ? pointers : [pointers];
     }
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON string and
+     * extracts the values based on the specified JSON pointers. If no JSON
+     * pointers are specified, it extracts all the strings from the JSON
+     * object.
+     * @param raw The raw JSON string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     async parse(raw) {
         const json = JSON.parse(raw.trim());
         // If there is no pointers specified we extract all strings we found
@@ -66,6 +82,15 @@ export class JSONLoader extends TextLoader {
         }
         return [];
     }
+    /**
+     * Method that takes a `json` object and an array of `pointers` as
+     * parameters and returns an array of targeted entries. It iterates over
+     * the JSON pointers and uses the `jsonpointer.get()` function to get the
+     * targeted entries from the JSON object.
+     * @param json The JSON object to get targeted entries from.
+     * @param pointers The JSON pointers to get targeted entries.
+     * @returns An array of targeted entries.
+     */
     getTargetedEntries(json, pointers) {
         const targetEntries = [];
         for (const pointer of pointers) {
@@ -77,6 +102,13 @@ export class JSONLoader extends TextLoader {
         return targetEntries;
     }
 }
+/**
+ * Class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from JSON Lines files. It has a constructor
+ * that takes a `filePathOrBlob` parameter representing the path to the
+ * JSON Lines file or a `Blob` object, and a `pointer` parameter that
+ * specifies the JSON pointer to extract.
+ */
 export class JSONLinesLoader extends TextLoader {
     constructor(filePathOrBlob, pointer) {
         super(filePathOrBlob);
@@ -87,6 +119,14 @@ export class JSONLinesLoader extends TextLoader {
             value: pointer
         });
     }
+    /**
+     * Method that takes a `raw` string as a parameter and returns a promise
+     * that resolves to an array of strings. It parses the raw JSON Lines
+     * string, splits it into lines, parses each line as JSON, and extracts
+     * the values based on the specified JSON pointer.
+     * @param raw The raw JSON Lines string to parse.
+     * @returns A promise that resolves to an array of strings.
+     */
     async parse(raw) {
         const lines = raw.split("\n");
         const jsons = lines

package/dist/document_loaders/fs/notion.cjs

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotionLoader = void 0;
 const directory_js_1 = require("./directory.cjs");
 const text_js_1 = require("./text.cjs");
+/**
+ * A class that extends the DirectoryLoader class. It represents a
+ * document loader that loads documents from a directory in the Notion
+ * format. It uses the TextLoader for loading '.md' files and ignores
+ * unknown file types.
+ */
 class NotionLoader extends directory_js_1.DirectoryLoader {
     constructor(directoryPath) {
         super(directoryPath, {

package/dist/document_loaders/fs/notion.d.ts

@@ -1,4 +1,10 @@
 import { DirectoryLoader } from "./directory.js";
+/**
+ * A class that extends the DirectoryLoader class. It represents a
+ * document loader that loads documents from a directory in the Notion
+ * format. It uses the TextLoader for loading '.md' files and ignores
+ * unknown file types.
+ */
 export declare class NotionLoader extends DirectoryLoader {
     constructor(directoryPath: string);
 }

package/dist/document_loaders/fs/notion.js

@@ -1,5 +1,11 @@
 import { DirectoryLoader, UnknownHandling } from "./directory.js";
 import { TextLoader } from "./text.js";
+/**
+ * A class that extends the DirectoryLoader class. It represents a
+ * document loader that loads documents from a directory in the Notion
+ * format. It uses the TextLoader for loading '.md' files and ignores
+ * unknown file types.
+ */
 export class NotionLoader extends DirectoryLoader {
     constructor(directoryPath) {
         super(directoryPath, {

package/dist/document_loaders/fs/pdf.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PDFLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const buffer_js_1 = require("./buffer.cjs");
+/**
+ * A class that extends the `BufferLoader` class. It represents a document
+ * loader that loads documents from PDF files.
+ */
 class PDFLoader extends buffer_js_1.BufferLoader {
     constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
         super(filePathOrBlob);
@@ -21,6 +25,23 @@ class PDFLoader extends buffer_js_1.BufferLoader {
         this.splitPages = splitPages;
         this.pdfjs = pdfjs;
     }
+    /**
+     * A method that takes a `raw` buffer and `metadata` as parameters and
+     * returns a promise that resolves to an array of `Document` instances. It
+     * uses the `getDocument` function from the PDF.js library to load the PDF
+     * from the buffer. It then iterates over each page of the PDF, retrieves
+     * the text content using the `getTextContent` method, and joins the text
+     * items to form the page content. It creates a new `Document` instance
+     * for each page with the extracted text content and metadata, and adds it
+     * to the `documents` array. If `splitPages` is `true`, it returns the
+     * array of `Document` instances. Otherwise, if there are no documents, it
+     * returns an empty array. Otherwise, it concatenates the page content of
+     * all documents and creates a single `Document` instance with the
+     * concatenated content.
+     * @param raw The buffer to be parsed.
+     * @param metadata The metadata of the document.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     async parse(raw, metadata) {
         const { getDocument, version } = await this.pdfjs();
         const pdf = await getDocument({

package/dist/document_loaders/fs/pdf.d.ts

@@ -2,6 +2,10 @@
 /// <reference types="node" resolution-mode="require"/>
 import { Document } from "../../document.js";
 import { BufferLoader } from "./buffer.js";
+/**
+ * A class that extends the `BufferLoader` class. It represents a document
+ * loader that loads documents from PDF files.
+ */
 export declare class PDFLoader extends BufferLoader {
     private splitPages;
     private pdfjs;
@@ -9,6 +13,23 @@ export declare class PDFLoader extends BufferLoader {
         splitPages?: boolean | undefined;
         pdfjs?: typeof PDFLoaderImports | undefined;
     });
+    /**
+     * A method that takes a `raw` buffer and `metadata` as parameters and
+     * returns a promise that resolves to an array of `Document` instances. It
+     * uses the `getDocument` function from the PDF.js library to load the PDF
+     * from the buffer. It then iterates over each page of the PDF, retrieves
+     * the text content using the `getTextContent` method, and joins the text
+     * items to form the page content. It creates a new `Document` instance
+     * for each page with the extracted text content and metadata, and adds it
+     * to the `documents` array. If `splitPages` is `true`, it returns the
+     * array of `Document` instances. Otherwise, if there are no documents, it
+     * returns an empty array. Otherwise, it concatenates the page content of
+     * all documents and creates a single `Document` instance with the
+     * concatenated content.
+     * @param raw The buffer to be parsed.
+     * @param metadata The metadata of the document.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     parse(raw: Buffer, metadata: Document["metadata"]): Promise<Document[]>;
 }
 declare function PDFLoaderImports(): Promise<{

package/dist/document_loaders/fs/pdf.js

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BufferLoader } from "./buffer.js";
+/**
+ * A class that extends the `BufferLoader` class. It represents a document
+ * loader that loads documents from PDF files.
+ */
 export class PDFLoader extends BufferLoader {
     constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
         super(filePathOrBlob);
@@ -18,6 +22,23 @@ export class PDFLoader extends BufferLoader {
         this.splitPages = splitPages;
         this.pdfjs = pdfjs;
     }
+    /**
+     * A method that takes a `raw` buffer and `metadata` as parameters and
+     * returns a promise that resolves to an array of `Document` instances. It
+     * uses the `getDocument` function from the PDF.js library to load the PDF
+     * from the buffer. It then iterates over each page of the PDF, retrieves
+     * the text content using the `getTextContent` method, and joins the text
+     * items to form the page content. It creates a new `Document` instance
+     * for each page with the extracted text content and metadata, and adds it
+     * to the `documents` array. If `splitPages` is `true`, it returns the
+     * array of `Document` instances. Otherwise, if there are no documents, it
+     * returns an empty array. Otherwise, it concatenates the page content of
+     * all documents and creates a single `Document` instance with the
+     * concatenated content.
+     * @param raw The buffer to be parsed.
+     * @param metadata The metadata of the document.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     async parse(raw, metadata) {
         const { getDocument, version } = await this.pdfjs();
         const pdf = await getDocument({

package/dist/document_loaders/fs/srt.cjs

@@ -2,10 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SRTLoader = void 0;
 const text_js_1 = require("./text.cjs");
+/**
+ * A class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from SRT (SubRip) subtitle files. It has a
+ * constructor that takes a `filePathOrBlob` parameter representing the
+ * path to the SRT file or a `Blob` object. The `parse()` method is
+ * implemented to parse the SRT file and extract the text content of each
+ * subtitle.
+ */
 class SRTLoader extends text_js_1.TextLoader {
     constructor(filePathOrBlob) {
         super(filePathOrBlob);
     }
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array of strings. It parses the raw SRT
+     * string using the `SRTParser2` class from the `srt-parser-2` module. It
+     * retrieves the subtitle objects from the parsed SRT data and extracts
+     * the text content from each subtitle object. It filters out any empty
+     * text content and joins the non-empty text content with a space
+     * separator.
+     * @param raw The raw SRT string to be parsed.
+     * @returns A promise that resolves to an array of strings representing the text content of each subtitle.
+     */
     async parse(raw) {
         const { SRTParser2 } = await SRTLoaderImports();
         const parser = new SRTParser2();

package/dist/document_loaders/fs/srt.d.ts

@@ -1,5 +1,24 @@
 import { TextLoader } from "./text.js";
+/**
+ * A class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from SRT (SubRip) subtitle files. It has a
+ * constructor that takes a `filePathOrBlob` parameter representing the
+ * path to the SRT file or a `Blob` object. The `parse()` method is
+ * implemented to parse the SRT file and extract the text content of each
+ * subtitle.
+ */
 export declare class SRTLoader extends TextLoader {
     constructor(filePathOrBlob: string | Blob);
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array of strings. It parses the raw SRT
+     * string using the `SRTParser2` class from the `srt-parser-2` module. It
+     * retrieves the subtitle objects from the parsed SRT data and extracts
+     * the text content from each subtitle object. It filters out any empty
+     * text content and joins the non-empty text content with a space
+     * separator.
+     * @param raw The raw SRT string to be parsed.
+     * @returns A promise that resolves to an array of strings representing the text content of each subtitle.
+     */
     protected parse(raw: string): Promise<string[]>;
 }

package/dist/document_loaders/fs/srt.js

@@ -1,8 +1,27 @@
 import { TextLoader } from "./text.js";
+/**
+ * A class that extends the `TextLoader` class. It represents a document
+ * loader that loads documents from SRT (SubRip) subtitle files. It has a
+ * constructor that takes a `filePathOrBlob` parameter representing the
+ * path to the SRT file or a `Blob` object. The `parse()` method is
+ * implemented to parse the SRT file and extract the text content of each
+ * subtitle.
+ */
 export class SRTLoader extends TextLoader {
     constructor(filePathOrBlob) {
         super(filePathOrBlob);
     }
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array of strings. It parses the raw SRT
+     * string using the `SRTParser2` class from the `srt-parser-2` module. It
+     * retrieves the subtitle objects from the parsed SRT data and extracts
+     * the text content from each subtitle object. It filters out any empty
+     * text content and joins the non-empty text content with a space
+     * separator.
+     * @param raw The raw SRT string to be parsed.
+     * @returns A promise that resolves to an array of strings representing the text content of each subtitle.
+     */
     async parse(raw) {
         const { SRTParser2 } = await SRTLoaderImports();
         const parser = new SRTParser2();

package/dist/document_loaders/fs/text.cjs

@@ -4,6 +4,14 @@ exports.TextLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const env_js_1 = require("../../util/env.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * A class that extends the `BaseDocumentLoader` class. It represents a
+ * document loader that loads documents from a text file. The `load()`
+ * method is implemented to read the text from the file or blob, parse it
+ * using the `parse()` method, and create a `Document` instance for each
+ * parsed page. The metadata includes the source of the text (file path or
+ * blob) and, if there are multiple pages, the line number of each page.
+ */
 class TextLoader extends base_js_1.BaseDocumentLoader {
     constructor(filePathOrBlob) {
         super();
@@ -14,9 +22,27 @@ class TextLoader extends base_js_1.BaseDocumentLoader {
             value: filePathOrBlob
         });
     }
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array containing the raw text as a single
+     * element.
+     * @param raw The raw text to be parsed.
+     * @returns A promise that resolves to an array containing the raw text as a single element.
+     */
     async parse(raw) {
         return [raw];
     }
+    /**
+     * A method that loads the text file or blob and returns a promise that
+     * resolves to an array of `Document` instances. It reads the text from
+     * the file or blob using the `readFile` function from the
+     * `node:fs/promises` module or the `text()` method of the blob. It then
+     * parses the text using the `parse()` method and creates a `Document`
+     * instance for each parsed page. The metadata includes the source of the
+     * text (file path or blob) and, if there are multiple pages, the line
+     * number of each page.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     async load() {
         let text;
         let metadata;
@@ -45,6 +71,14 @@ class TextLoader extends base_js_1.BaseDocumentLoader {
                 },
         }));
     }
+    /**
+     * A static method that imports the `readFile` function from the
+     * `node:fs/promises` module. It is used to dynamically import the
+     * function when needed. If the import fails, it throws an error
+     * indicating that the `fs/promises` module is not available in the
+     * current environment.
+     * @returns A promise that resolves to an object containing the `readFile` function from the `node:fs/promises` module.
+     */
     static async imports() {
         try {
             const { readFile } = await import("node:fs/promises");

package/dist/document_loaders/fs/text.d.ts

@@ -2,11 +2,45 @@
 import type { readFile as ReadFileT } from "node:fs/promises";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that extends the `BaseDocumentLoader` class. It represents a
+ * document loader that loads documents from a text file. The `load()`
+ * method is implemented to read the text from the file or blob, parse it
+ * using the `parse()` method, and create a `Document` instance for each
+ * parsed page. The metadata includes the source of the text (file path or
+ * blob) and, if there are multiple pages, the line number of each page.
+ */
 export declare class TextLoader extends BaseDocumentLoader {
     filePathOrBlob: string | Blob;
     constructor(filePathOrBlob: string | Blob);
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array containing the raw text as a single
+     * element.
+     * @param raw The raw text to be parsed.
+     * @returns A promise that resolves to an array containing the raw text as a single element.
+     */
     protected parse(raw: string): Promise<string[]>;
+    /**
+     * A method that loads the text file or blob and returns a promise that
+     * resolves to an array of `Document` instances. It reads the text from
+     * the file or blob using the `readFile` function from the
+     * `node:fs/promises` module or the `text()` method of the blob. It then
+     * parses the text using the `parse()` method and creates a `Document`
+     * instance for each parsed page. The metadata includes the source of the
+     * text (file path or blob) and, if there are multiple pages, the line
+     * number of each page.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     load(): Promise<Document[]>;
+    /**
+     * A static method that imports the `readFile` function from the
+     * `node:fs/promises` module. It is used to dynamically import the
+     * function when needed. If the import fails, it throws an error
+     * indicating that the `fs/promises` module is not available in the
+     * current environment.
+     * @returns A promise that resolves to an object containing the `readFile` function from the `node:fs/promises` module.
+     */
     static imports(): Promise<{
         readFile: typeof ReadFileT;
     }>;

package/dist/document_loaders/fs/text.js

@@ -1,6 +1,14 @@
 import { Document } from "../../document.js";
 import { getEnv } from "../../util/env.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that extends the `BaseDocumentLoader` class. It represents a
+ * document loader that loads documents from a text file. The `load()`
+ * method is implemented to read the text from the file or blob, parse it
+ * using the `parse()` method, and create a `Document` instance for each
+ * parsed page. The metadata includes the source of the text (file path or
+ * blob) and, if there are multiple pages, the line number of each page.
+ */
 export class TextLoader extends BaseDocumentLoader {
     constructor(filePathOrBlob) {
         super();
@@ -11,9 +19,27 @@ export class TextLoader extends BaseDocumentLoader {
             value: filePathOrBlob
         });
     }
+    /**
+     * A protected method that takes a `raw` string as a parameter and returns
+     * a promise that resolves to an array containing the raw text as a single
+     * element.
+     * @param raw The raw text to be parsed.
+     * @returns A promise that resolves to an array containing the raw text as a single element.
+     */
     async parse(raw) {
         return [raw];
     }
+    /**
+     * A method that loads the text file or blob and returns a promise that
+     * resolves to an array of `Document` instances. It reads the text from
+     * the file or blob using the `readFile` function from the
+     * `node:fs/promises` module or the `text()` method of the blob. It then
+     * parses the text using the `parse()` method and creates a `Document`
+     * instance for each parsed page. The metadata includes the source of the
+     * text (file path or blob) and, if there are multiple pages, the line
+     * number of each page.
+     * @returns A promise that resolves to an array of `Document` instances.
+     */
     async load() {
         let text;
         let metadata;
@@ -42,6 +68,14 @@ export class TextLoader extends BaseDocumentLoader {
                 },
         }));
     }
+    /**
+     * A static method that imports the `readFile` function from the
+     * `node:fs/promises` module. It is used to dynamically import the
+     * function when needed. If the import fails, it throws an error
+     * indicating that the `fs/promises` module is not available in the
+     * current environment.
+     * @returns A promise that resolves to an object containing the `readFile` function from the `node:fs/promises` module.
+     */
     static async imports() {
         try {
             const { readFile } = await import("node:fs/promises");

package/dist/document_loaders/fs/unstructured.cjs

@@ -27,6 +27,14 @@ const UNSTRUCTURED_API_FILETYPES = [
     ".odt",
     ".epub",
 ];
+/**
+ * A document loader that uses the Unstructured API to load unstructured
+ * documents. It supports both the new syntax with options object and the
+ * legacy syntax for backward compatibility. The load() method sends a
+ * partitioning request to the Unstructured API and retrieves the
+ * partitioned elements. It creates a Document instance for each element
+ * and returns an array of Document instances.
+ */
 class UnstructuredLoader extends base_js_1.BaseDocumentLoader {
     constructor(filePathOrLegacyApiUrl, optionsOrLegacyFilePath = {}) {
         super();
@@ -176,6 +184,12 @@ class UnstructuredLoader extends base_js_1.BaseDocumentLoader {
     }
 }
 exports.UnstructuredLoader = UnstructuredLoader;
+/**
+ * A document loader that loads unstructured documents from a directory
+ * using the UnstructuredLoader. It creates a UnstructuredLoader instance
+ * for each supported file type and passes it to the DirectoryLoader
+ * constructor.
+ */
 class UnstructuredDirectoryLoader extends directory_js_1.DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl, optionsOrLegacyDirectoryPath, legacyOptionRecursive = true, legacyOptionUnknown = directory_js_1.UnknownHandling.Warn) {
         let directoryPath;