Class UnstructuredLoader

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.

It accepts either a filepath or an object containing a buffer and a filename as input.

Hierarchy (view full)

Constructors

constructor

Properties

filePath

Methods

imports load loadAndSplit

Constructors

constructor

Properties

filePath

filePath: string

Methods

imports

  • imports(): Promise<{
        basename: ((path: string, suffix?: string) => string);
        readFile: {
            (path: PathLike | FileHandle, options?: null | {
                encoding?: null;
                flag?: OpenMode;
            } & Abortable): Promise<Buffer>;
            (path: PathLike | FileHandle, options: BufferEncoding | {
                encoding: BufferEncoding;
                flag?: OpenMode | undefined;
            } & Abortable): Promise<string>;
            (path: PathLike | FileHandle, options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {
                flag?: OpenMode | undefined;
            }): Promise<string | Buffer>;
        };
    }>

  • Returns Promise<{
        basename: ((path: string, suffix?: string) => string);
        readFile: {
            (path: PathLike | FileHandle, options?: null | {
                encoding?: null;
                flag?: OpenMode;
            } & Abortable): Promise<Buffer>;
            (path: PathLike | FileHandle, options: BufferEncoding | {
                encoding: BufferEncoding;
                flag?: OpenMode | undefined;
            } & Abortable): Promise<string>;
            (path: PathLike | FileHandle, options?: null | BufferEncoding | ObjectEncodingOptions & Abortable & {
                flag?: OpenMode | undefined;
            }): Promise<string | Buffer>;
        };
    }>

load

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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods