langchain_community.document_loaders.unstructured.UnstructuredAPIFileLoader¶

class langchain_community.document_loaders.unstructured.UnstructuredAPIFileLoader(file_path: Union[str, List[str]] = '', mode: str = 'single', url: str = 'https://api.unstructured.io/general/v0/general', api_key: str = '', **unstructured_kwargs: Any)[source]¶

Load files using Unstructured API.

By default, the loader makes a call to the hosted Unstructured API. If you are running the unstructured API locally, you can change the API rule by passing in the url parameter when you initialize the loader. The hosted Unstructured API requires an API key. See https://www.unstructured.io/api-key/ if you need to generate a key.

You can run the loader in one of two modes: “single” and “elements”. If you use “single” mode, the document will be returned as a single langchain Document object. If you use “elements” mode, the unstructured library will split the document into elements such as Title and NarrativeText. You can pass in additional unstructured kwargs after mode to apply different unstructured settings.

Examples ```python from langchain_community.document_loaders import UnstructuredAPIFileLoader

loader = UnstructuredFileAPILoader(

“example.pdf”, mode=”elements”, strategy=”fast”, api_key=”MY_API_KEY”,

) docs = loader.load()

References

https://unstructured-io.github.io/unstructured/bricks.html#partition https://www.unstructured.io/api-key/ https://github.com/Unstructured-IO/unstructured-api

Initialize with file path.

Methods

__init__([file_path, mode, url, api_key])

Initialize with file path.

alazy_load()

A lazy loader for Documents.

lazy_load()

Load file.

load()

Load data into Document objects.

load_and_split([text_splitter])

Load Documents and split into chunks.
Parameters

  • file_path (Union[str, List[str]]) –

  • mode (str) –

  • url (str) –

  • api_key (str) –

  • unstructured_kwargs (Any) –

__init__(file_path: Union[str, List[str]] = '', mode: str = 'single', url: str = 'https://api.unstructured.io/general/v0/general', api_key: str = '', **unstructured_kwargs: Any)[source]¶

Initialize with file path.

Parameters

  • file_path (Union[str, List[str]]) –

  • mode (str) –

  • url (str) –

  • api_key (str) –

  • unstructured_kwargs (Any) –

async alazy_load() → AsyncIterator[Document]¶

A lazy loader for Documents.

Return type

AsyncIterator[Document]

lazy_load() → Iterator[Document]¶

Load file.

Return type

Iterator[Document]

load() → List[Document]¶

Load data into Document objects.

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶

Load Documents and split into chunks. Chunks are returned as Documents.

Do not override this method. It should be considered to be deprecated!

Parameters

text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns

List of Documents.

Return type

List[Document]

Examples using UnstructuredAPIFileLoader¶