langchain 0.0.130 → 0.0.132

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;

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

@@ -5,6 +5,10 @@ import type { readFile as ReadFileT } from "node:fs/promises";
 import { DirectoryLoader, UnknownHandling } from "./directory.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Represents an element returned by the Unstructured API. It has
+ * properties for the element type, text content, and metadata.
+ */
 type Element = {
     type: string;
     text: string;
@@ -12,7 +16,15 @@ type Element = {
         [key: string]: unknown;
     };
 };
+/**
+ * Represents the available strategies for the UnstructuredLoader. It can
+ * be one of "hi_res", "fast", "ocr_only", or "auto".
+ */
 export type UnstructuredLoaderStrategy = "hi_res" | "fast" | "ocr_only" | "auto";
+/**
+ * Represents a string value with autocomplete suggestions. It is used for
+ * the `strategy` property in the UnstructuredLoaderOptions.
+ */
 type StringWithAutocomplete<T> = T | (string & Record<never, never>);
 export type UnstructuredLoaderOptions = {
     apiKey?: string;
@@ -28,6 +40,14 @@ type UnstructuredDirectoryLoaderOptions = UnstructuredLoaderOptions & {
     recursive?: boolean;
     unknown?: UnknownHandling;
 };
+/**
+ * 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.
+ */
 export declare class UnstructuredLoader extends BaseDocumentLoader {
     filePath: string;
     private apiUrl;
@@ -46,6 +66,12 @@ export declare class UnstructuredLoader extends BaseDocumentLoader {
         basename: typeof BasenameT;
     }>;
 }
+/**
+ * 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.
+ */
 export declare class UnstructuredDirectoryLoader extends DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl: string, optionsOrLegacyDirectoryPath: UnstructuredDirectoryLoaderOptions | string, legacyOptionRecursive?: boolean, legacyOptionUnknown?: UnknownHandling);
 }

package/dist/document_loaders/fs/unstructured.js

@@ -23,6 +23,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.
+ */
 export class UnstructuredLoader extends BaseDocumentLoader {
     constructor(filePathOrLegacyApiUrl, optionsOrLegacyFilePath = {}) {
         super();
@@ -171,6 +179,12 @@ export class UnstructuredLoader extends BaseDocumentLoader {
         }
     }
 }
+/**
+ * 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.
+ */
 export class UnstructuredDirectoryLoader extends DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl, optionsOrLegacyDirectoryPath, legacyOptionRecursive = true, legacyOptionUnknown = UnknownHandling.Warn) {
         let directoryPath;

package/dist/document_loaders/web/apify_dataset.cjs

@@ -4,6 +4,11 @@ exports.ApifyDatasetLoader = void 0;
 const apify_client_1 = require("apify-client");
 const base_js_1 = require("../base.cjs");
 const env_js_1 = require("../../util/env.cjs");
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader that loads
+ * documents from an Apify dataset.
+ */
 class ApifyDatasetLoader extends base_js_1.BaseDocumentLoader {
     constructor(datasetId, config) {
         super();
@@ -36,6 +41,12 @@ class ApifyDatasetLoader extends base_js_1.BaseDocumentLoader {
     static _getApifyApiToken(config) {
         return config?.token ?? (0, env_js_1.getEnvironmentVariable)("APIFY_API_TOKEN");
     }
+    /**
+     * Retrieves the dataset items from the Apify platform and applies the
+     * datasetMappingFunction to each item to create an array of Document
+     * instances.
+     * @returns An array of Document instances.
+     */
     async load() {
         const datasetItems = (await this.apifyClient.dataset(this.datasetId).listItems({ clean: true })).items;
         return datasetItems.map(this.datasetMappingFunction);

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

@@ -1,7 +1,16 @@
 import { ApifyClient, ApifyClientOptions, ActorCallOptions, TaskCallOptions } from "apify-client";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader, DocumentLoader } from "../base.js";
+/**
+ * A type that represents a function that takes a single object (an Apify
+ * dataset item) and converts it to an instance of the Document class.
+ */
 export type ApifyDatasetMappingFunction = (item: Record<string | number, unknown>) => Document;
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader that loads
+ * documents from an Apify dataset.
+ */
 export declare class ApifyDatasetLoader extends BaseDocumentLoader implements DocumentLoader {
     protected apifyClient: ApifyClient;
     protected datasetId: string;
@@ -11,6 +20,12 @@ export declare class ApifyDatasetLoader extends BaseDocumentLoader implements Do
         clientOptions?: ApifyClientOptions;
     });
     private static _getApifyApiToken;
+    /**
+     * Retrieves the dataset items from the Apify platform and applies the
+     * datasetMappingFunction to each item to create an array of Document
+     * instances.
+     * @returns An array of Document instances.
+     */
     load(): Promise<Document[]>;
     /**
      * Create an ApifyDatasetLoader by calling an Actor on the Apify platform and waiting for its results to be ready.

package/dist/document_loaders/web/apify_dataset.js

@@ -1,6 +1,11 @@
 import { ApifyClient, } from "apify-client";
 import { BaseDocumentLoader } from "../base.js";
 import { getEnvironmentVariable } from "../../util/env.js";
+/**
+ * A class that extends the BaseDocumentLoader and implements the
+ * DocumentLoader interface. It represents a document loader that loads
+ * documents from an Apify dataset.
+ */
 export class ApifyDatasetLoader extends BaseDocumentLoader {
     constructor(datasetId, config) {
         super();
@@ -33,6 +38,12 @@ export class ApifyDatasetLoader extends BaseDocumentLoader {
     static _getApifyApiToken(config) {
         return config?.token ?? getEnvironmentVariable("APIFY_API_TOKEN");
     }
+    /**
+     * Retrieves the dataset items from the Apify platform and applies the
+     * datasetMappingFunction to each item to create an array of Document
+     * instances.
+     * @returns An array of Document instances.
+     */
     async load() {
         const datasetItems = (await this.apifyClient.dataset(this.datasetId).listItems({ clean: true })).items;
         return datasetItems.map(this.datasetMappingFunction);

package/dist/document_loaders/web/azure_blob_storage_container.cjs

@@ -4,6 +4,10 @@ exports.AzureBlobStorageContainerLoader = void 0;
 const storage_blob_1 = require("@azure/storage-blob");
 const azure_blob_storage_file_js_1 = require("./azure_blob_storage_file.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader that loads documents from an Azure
+ * Blob Storage container. It extends the BaseDocumentLoader class.
+ */
 class AzureBlobStorageContainerLoader extends base_js_1.BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {
         super();
@@ -29,6 +33,15 @@ class AzureBlobStorageContainerLoader extends base_js_1.BaseDocumentLoader {
         this.container = azureConfig.container;
         this.unstructuredConfig = unstructuredConfig;
     }
+    /**
+     * Method to load documents from an Azure Blob Storage container. It
+     * creates a BlobServiceClient using the connection string, gets the
+     * container client using the container name, and iterates over the blobs
+     * in the container. For each blob, it creates an instance of
+     * AzureBlobStorageFileLoader and loads the documents using the loader.
+     * The loaded documents are concatenated to the docs array and returned.
+     * @returns An array of loaded documents.
+     */
     async load() {
         const blobServiceClient = storage_blob_1.BlobServiceClient.fromConnectionString(this.connectionString);
         const containerClient = blobServiceClient.getContainerClient(this.container);

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

@@ -1,19 +1,45 @@
 import { BaseDocumentLoader } from "../base.js";
 import { Document } from "../../document.js";
 import { UnstructuredLoaderOptions } from "../fs/unstructured.js";
+/**
+ * Interface representing the configuration for accessing an Azure Blob
+ * Storage container. It includes properties for the connection string and
+ * container name.
+ */
 interface AzureBlobStorageContainerConfig {
     connectionString: string;
     container: string;
 }
+/**
+ * Interface representing the configuration for the
+ * AzureBlobStorageContainerLoader. It includes properties for the
+ * azureConfig and unstructuredConfig. The azureConfig property contains
+ * the Azure Blob Storage container configuration, and the
+ * unstructuredConfig property contains the options for the
+ * UnstructuredLoader.
+ */
 interface AzureBlobStorageContainerLoaderConfig {
     azureConfig: AzureBlobStorageContainerConfig;
     unstructuredConfig?: UnstructuredLoaderOptions;
 }
+/**
+ * Class representing a document loader that loads documents from an Azure
+ * Blob Storage container. It extends the BaseDocumentLoader class.
+ */
 export declare class AzureBlobStorageContainerLoader extends BaseDocumentLoader {
     private readonly connectionString;
     private readonly container;
     private readonly unstructuredConfig?;
     constructor({ azureConfig, unstructuredConfig, }: AzureBlobStorageContainerLoaderConfig);
+    /**
+     * Method to load documents from an Azure Blob Storage container. It
+     * creates a BlobServiceClient using the connection string, gets the
+     * container client using the container name, and iterates over the blobs
+     * in the container. For each blob, it creates an instance of
+     * AzureBlobStorageFileLoader and loads the documents using the loader.
+     * The loaded documents are concatenated to the docs array and returned.
+     * @returns An array of loaded documents.
+     */
     load(): Promise<Document<Record<string, any>>[]>;
 }
 export {};

package/dist/document_loaders/web/azure_blob_storage_container.js

@@ -1,6 +1,10 @@
 import { BlobServiceClient } from "@azure/storage-blob";
 import { AzureBlobStorageFileLoader } from "./azure_blob_storage_file.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader that loads documents from an Azure
+ * Blob Storage container. It extends the BaseDocumentLoader class.
+ */
 export class AzureBlobStorageContainerLoader extends BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {
         super();
@@ -26,6 +30,15 @@ export class AzureBlobStorageContainerLoader extends BaseDocumentLoader {
         this.container = azureConfig.container;
         this.unstructuredConfig = unstructuredConfig;
     }
+    /**
+     * Method to load documents from an Azure Blob Storage container. It
+     * creates a BlobServiceClient using the connection string, gets the
+     * container client using the container name, and iterates over the blobs
+     * in the container. For each blob, it creates an instance of
+     * AzureBlobStorageFileLoader and loads the documents using the loader.
+     * The loaded documents are concatenated to the docs array and returned.
+     * @returns An array of loaded documents.
+     */
     async load() {
         const blobServiceClient = BlobServiceClient.fromConnectionString(this.connectionString);
         const containerClient = blobServiceClient.getContainerClient(this.container);

package/dist/document_loaders/web/azure_blob_storage_file.cjs

@@ -30,6 +30,11 @@ const os = __importStar(require("node:os"));
 const storage_blob_1 = require("@azure/storage-blob");
 const base_js_1 = require("../base.cjs");
 const unstructured_js_1 = require("../fs/unstructured.cjs");
+/**
+ * Class representing a document loader that loads a specific file from
+ * Azure Blob Storage. It extends the BaseDocumentLoader class and
+ * implements the DocumentLoader interface.
+ */
 class AzureBlobStorageFileLoader extends base_js_1.BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {
         super();
@@ -62,6 +67,13 @@ class AzureBlobStorageFileLoader extends base_js_1.BaseDocumentLoader {
         this.blobName = azureConfig.blobName;
         this.unstructuredConfig = unstructuredConfig;
     }
+    /**
+     * Method to load a specific file from Azure Blob Storage. It creates a
+     * temporary directory, constructs the file path, downloads the file, and
+     * loads the documents using the UnstructuredLoader. The loaded documents
+     * are returned, and the temporary directory is deleted.
+     * @returns An array of documents loaded from the file in Azure Blob Storage.
+     */
     async load() {
         const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "azureblobfileloader-"));
         const filePath = path.join(tempDir, this.blobName);

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

@@ -1,20 +1,41 @@
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoaderOptions } from "../fs/unstructured.js";
+/**
+ * Interface representing the configuration for accessing a specific file
+ * in Azure Blob Storage.
+ */
 interface AzureBlobStorageFileConfig {
     connectionString: string;
     container: string;
     blobName: string;
 }
+/**
+ * Interface representing the configuration for the
+ * AzureBlobStorageFileLoader. It contains the Azure Blob Storage file
+ * configuration and the options for the UnstructuredLoader.
+ */
 interface AzureBlobStorageFileLoaderConfig {
     azureConfig: AzureBlobStorageFileConfig;
     unstructuredConfig?: UnstructuredLoaderOptions;
 }
+/**
+ * Class representing a document loader that loads a specific file from
+ * Azure Blob Storage. It extends the BaseDocumentLoader class and
+ * implements the DocumentLoader interface.
+ */
 export declare class AzureBlobStorageFileLoader extends BaseDocumentLoader {
     private readonly connectionString;
     private readonly container;
     private readonly blobName;
     private readonly unstructuredConfig?;
     constructor({ azureConfig, unstructuredConfig, }: AzureBlobStorageFileLoaderConfig);
+    /**
+     * Method to load a specific file from Azure Blob Storage. It creates a
+     * temporary directory, constructs the file path, downloads the file, and
+     * loads the documents using the UnstructuredLoader. The loaded documents
+     * are returned, and the temporary directory is deleted.
+     * @returns An array of documents loaded from the file in Azure Blob Storage.
+     */
     load(): Promise<import("../../document.js").Document<Record<string, any>>[]>;
 }
 export {};

package/dist/document_loaders/web/azure_blob_storage_file.js

@@ -4,6 +4,11 @@ import * as os from "node:os";
 import { BlobServiceClient } from "@azure/storage-blob";
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoader, } from "../fs/unstructured.js";
+/**
+ * Class representing a document loader that loads a specific file from
+ * Azure Blob Storage. It extends the BaseDocumentLoader class and
+ * implements the DocumentLoader interface.
+ */
 export class AzureBlobStorageFileLoader extends BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {
         super();
@@ -36,6 +41,13 @@ export class AzureBlobStorageFileLoader extends BaseDocumentLoader {
         this.blobName = azureConfig.blobName;
         this.unstructuredConfig = unstructuredConfig;
     }
+    /**
+     * Method to load a specific file from Azure Blob Storage. It creates a
+     * temporary directory, constructs the file path, downloads the file, and
+     * loads the documents using the UnstructuredLoader. The loaded documents
+     * are returned, and the temporary directory is deleted.
+     * @returns An array of documents loaded from the file in Azure Blob Storage.
+     */
     async load() {
         const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "azureblobfileloader-"));
         const filePath = path.join(tempDir, this.blobName);