mirror of
https://github.com/Mintplex-Labs/langchain-python.git
synced 2026-07-23 17:56:16 -04:00
Matt Robinson
c4d53f98dc
### Summary Updates the docstrings in the Unstructured document loaders to display more useful information on the integrations page.
59 lines
2.0 KiB
Python
59 lines
2.0 KiB
Python
"""Loads rich text files."""
|
|
from typing import Any, List
|
|
|
|
from langchain.document_loaders.unstructured import (
|
|
UnstructuredFileLoader,
|
|
satisfies_min_unstructured_version,
|
|
)
|
|
|
|
|
|
class UnstructuredRTFLoader(UnstructuredFileLoader):
|
|
"""Loader that uses unstructured to load RTF files.
|
|
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
|
|
--------
|
|
from langchain.document_loaders import UnstructuredRTFLoader
|
|
|
|
loader = UnstructuredRTFLoader(
|
|
"example.rtf", mode="elements", strategy="fast",
|
|
)
|
|
docs = loader.load()
|
|
|
|
References
|
|
----------
|
|
https://unstructured-io.github.io/unstructured/bricks.html#partition-rtf
|
|
"""
|
|
|
|
def __init__(
|
|
self, file_path: str, mode: str = "single", **unstructured_kwargs: Any
|
|
):
|
|
"""
|
|
Initialize with a file path.
|
|
|
|
Args:
|
|
file_path: The path to the file to load.
|
|
mode: The mode to use for partitioning. See unstructured for details.
|
|
Defaults to "single".
|
|
**unstructured_kwargs: Additional keyword arguments to pass
|
|
to unstructured.
|
|
"""
|
|
min_unstructured_version = "0.5.12"
|
|
if not satisfies_min_unstructured_version(min_unstructured_version):
|
|
raise ValueError(
|
|
"Partitioning rtf files is only supported in "
|
|
f"unstructured>={min_unstructured_version}."
|
|
)
|
|
|
|
super().__init__(file_path=file_path, mode=mode, **unstructured_kwargs)
|
|
|
|
def _get_elements(self) -> List:
|
|
from unstructured.partition.rtf import partition_rtf
|
|
|
|
return partition_rtf(filename=self.file_path, **self.unstructured_kwargs)
|