Class DirectoryLoader

A document loader that loads documents from a directory. It extends the BaseDocumentLoader class and implements the load() method.

Example


const directoryLoader = new DirectoryLoader(
  "src/document_loaders/example_data/",
  {
    ".pdf": (path: string) => new PDFLoader(path),
  },
);

const docs = await directoryLoader.load();
console.log({ docs });

Hierarchy (view full)

Constructors

constructor

Properties

directoryPath loaders recursive unknown

Methods

load loadAndSplit imports

Constructors

constructor

Properties

directoryPath

directoryPath: string

loaders

loaders: LoadersMapping

recursive

recursive: boolean = true

unknown

unknown: UnknownHandling = UnknownHandling.Warn

Methods

load

  • load(): Promise<Document<Record<string, any>>[]>

  • Loads the documents from the directory. If a file is a directory and recursive is true, it recursively loads documents from the subdirectory. If a file is a file, it checks if there is a corresponding loader function for the file extension in the loaders mapping. If there is, it loads the documents. If there is no corresponding loader function and unknown is set to Warn, it logs a warning message. If unknown is set to Error, it throws an error.

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

    A promise that resolves to an array of loaded documents.

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>

  • 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.

    Deprecated

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

Staticimports

  • imports(): Promise<{
        extname: ((path: string) => string);
        readdir: {
            (path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes?: false;
            }): Promise<string[]>;
            (path: PathLike, options: {
                encoding: "buffer";
                recursive?: boolean;
                withFileTypes?: false;
            } | "buffer"): Promise<Buffer[]>;
            (path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes?: false;
            }): Promise<string[] | Buffer[]>;
            (path: PathLike, options: ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes: true;
            }): Promise<Dirent[]>;
        };
        resolve: ((...paths: string[]) => string);
    }>

  • Imports the necessary functions from the node:path and node:fs/promises modules. It is used to dynamically import the functions when needed. If the import fails, it throws an error indicating that the modules failed to load.

    Returns Promise<{
        extname: ((path: string) => string);
        readdir: {
            (path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes?: false;
            }): Promise<string[]>;
            (path: PathLike, options: {
                encoding: "buffer";
                recursive?: boolean;
                withFileTypes?: false;
            } | "buffer"): Promise<Buffer[]>;
            (path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes?: false;
            }): Promise<string[] | Buffer[]>;
            (path: PathLike, options: ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes: true;
            }): Promise<Dirent[]>;
        };
        resolve: ((...paths: string[]) => string);
    }>

    A promise that resolves to an object containing the imported functions.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods