Abstract class that extends the BaseDocumentLoader class. It represents a document loader that loads documents from a buffer. The load() method is implemented to read the buffer contents and metadata based on the type of filePathOrBlob, and then calls the parse() method to parse the buffer and return the documents.

Hierarchy (view full)

Constructors

Properties

filePathOrBlob: string | Blob

Methods

  • Method that reads the buffer contents and metadata based on the type of filePathOrBlob, and then calls the parse() method to parse the buffer and return the documents.

    Returns Promise<Document<Record<string, any>>[]>

    Promise that resolves with an array of Document objects.

  • Parameters

    • Optionalsplitter: BaseDocumentTransformer<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[]>

    Returns Promise<Document<Record<string, any>>[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

    Use this.load() and splitter.splitDocuments() individually. Loads the documents and splits them using a specified text splitter.

  • Abstract method that needs to be implemented by subclasses. It is used to parse the buffer and return the documents.

    Parameters

    • raw: Buffer

      The buffer to be parsed.

    • metadata: Record<string, any>

      Metadata of the document.

    Returns Promise<Document<Record<string, any>>[]>

    Promise that resolves with an array of Document objects.

  • Static method that imports the readFile function from the fs/promises module in Node.js. 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 Promise<{
        readFile: {
            (path: PathLike | FileHandle, options?: null | {
                encoding?: null;
                flag?: OpenMode;
            } & Abortable): Promise<Buffer>;
            (path: PathLike | FileHandle, options: {
                encoding: BufferEncoding;
                flag?: OpenMode | undefined;
            } & Abortable | BufferEncoding): Promise<string>;
            (path: PathLike | FileHandle, options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {
                flag?: OpenMode | undefined;
            }): Promise<string | Buffer>;
        };
    }>

    Promise that resolves with an object containing the readFile function.