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.

Hierarchy

BaseDocumentLoader
- UnstructuredLoader

Index

Constructors

constructor

new UnstructuredLoader(filePathOrLegacyApiUrl, optionsOrLegacyFilePath?): UnstructuredLoader
Parameters
- filePathOrLegacyApiUrl: string
- optionsOrLegacyFilePath: string | UnstructuredLoaderOptions = {}
Returns UnstructuredLoader
Overrides BaseDocumentLoader.constructor
- Defined in langchain/src/document_loaders/fs/unstructured.ts:157

Properties

filePath

filePath: string

Methods

imports

imports(): Promise<{
    basename: ((path, suffix?) => string);
    readFile: {
        (path, options?): Promise<Buffer>;
        (path, options): Promise<string>;
        (path, options?): Promise<string | Buffer>;
    };
}>
Returns Promise<{
    basename: ((path, suffix?) => string);
    readFile: {
        (path, options?): Promise<Buffer>;
        (path, options): Promise<string>;
        (path, options?): Promise<string | Buffer>;
    };
}>
- Defined in langchain/src/document_loaders/fs/unstructured.ts:279

load

load(): Promise<Document<Record<string, any>>[]>
Loads the documents.

Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances.
Overrides BaseDocumentLoader.load
- Defined in langchain/src/document_loaders/fs/unstructured.ts:257

loadAndSplit

loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
Inherited from BaseDocumentLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

Class UnstructuredLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

filePathOrLegacyApiUrl: string

optionsOrLegacyFilePath: string | UnstructuredLoaderOptions = {}

Returns UnstructuredLoader

Properties

filePath

Methods

imports

Returns Promise<{
    basename: ((path, suffix?) => string);
    readFile: {
        (path, options?): Promise<Buffer>;
        (path, options): Promise<string>;
        (path, options?): Promise<string | Buffer>;
    };
}>

load

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

loadAndSplit

Parameters

splitter: TextSplitter = ...

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

Settings

Member Visibility

Theme

On This Page

Class UnstructuredLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

filePathOrLegacyApiUrl: string

optionsOrLegacyFilePath: string | UnstructuredLoaderOptions = {}

Returns UnstructuredLoader

Properties

filePath

Methods

imports

Returns Promise<{ basename: ((path, suffix?) => string); readFile: { (path, options?): Promise<Buffer>; (path, options): Promise<string>; (path, options?): Promise<string | Buffer>; }; }>

load

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

loadAndSplit

Parameters

splitter: TextSplitter = ...

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

Settings

Member Visibility

Theme

On This Page

Returns Promise<{
basename: ((path, suffix?) => string);
readFile: {
(path, options?): Promise<Buffer>;
(path, options): Promise<string>;
(path, options?): Promise<string | Buffer>;
};
}>