Dedoc
本示例演示了如何将Dedoc与LangChain结合使用作为DocumentLoader。
概述
Dedoc 是一个 开源的库/服务，它可以从各种格式的文件中提取文本、表格、附件和文档结构（例如，标题、列表项等）。
Dedoc 支持 DOCX, XLSX, PPTX, EML, HTML, PDF, 图片等更多格式。
完整的支持格式列表可以在 这里 找到。
集成详情
| 类 | 包 | 本地 | 可序列化 | JS支持 |
|---|---|---|---|---|
| DedocFileLoader | langchain_community | ❌ | 测试版 | ❌ |
| DedocPDFLoader | langchain_community | ❌ | 测试版 | ❌ |
| DedocAPIFileLoader | langchain_community | ❌ | 测试版 | ❌ |
加载器特性
提供了懒加载和异步加载的方法，但实际上，文档加载是同步执行的。
| 来源 | 文档懒加载 | 异步支持 |
|---|---|---|
| DedocFileLoader | ❌ | ❌ |
| DedocPDFLoader | ❌ | ❌ |
| DedocAPIFileLoader | ❌ | ❌ |
设置
- 要访问
DedocFileLoader和DedocPDFLoader文档加载器，您需要安装dedoc集成包。 - 要访问
DedocAPIFileLoader，您需要运行Dedoc服务，例如Docker容器（请参阅文档了解更多详情）：
docker pull dedocproject/dedoc
docker run -p 1231:1231
Dedoc 的安装说明在 这里 给出。
# Install package
%pip install --quiet "dedoc[torch]"
Note: you may need to restart the kernel to use updated packages.
实例化
from langchain_community.document_loaders import DedocFileLoader
loader = DedocFileLoader("./example_data/state_of_the_union.txt")
加载
docs = loader.load()
docs[0].page_content[:100]
'\nMadam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and t'
懒加载
docs = loader.lazy_load()
for doc in docs:
print(doc.page_content[:100])
break
Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and t
API 参考
有关配置和调用Dedoc加载器的详细信息，请参阅API参考：
- https://python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.dedoc.DedocFileLoader.html
- https://python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.pdf.DedocPDFLoader.html
- https://python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.dedoc.DedocAPIFileLoader.html
加载任何文件
为了自动处理支持格式中的任何文件，
DedocFileLoader 可能很有用。
文件加载器会自动检测具有正确扩展名的文件类型。
文件解析过程可以通过在DedocFileLoader类初始化期间配置dedoc_kwargs来进行。
这里给出了一些选项使用的基本示例，
请参阅DedocFileLoader的文档和
dedoc文档
以获取有关配置参数的更多详细信息。
基本示例
from langchain_community.document_loaders import DedocFileLoader
loader = DedocFileLoader("./example_data/state_of_the_union.txt")
docs = loader.load()
docs[0].page_content[:400]
'\nMadam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans. \n\n\n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\n\n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\n\n\nWith a duty to one another to the American people to '
分割模式
DedocFileLoader 支持将不同类型的文档分割成多个部分（每个部分单独返回）。
为此，使用 split 参数，并提供以下选项：
document(默认值): 文档文本作为单个 langchainDocument对象返回（不分割）；page: 将文档文本分页（适用于PDF,DJVU,PPTX,PPT,ODP);node: 将文档文本分割成Dedoc树节点（标题节点、列表项节点、原始文本节点）；line: 将文档文本分割成文本行。
loader = DedocFileLoader(
"./example_data/layout-parser-paper.pdf",
split="page",
pages=":2",
)
docs = loader.load()
len(docs)
2
处理表格
DedocFileLoader 支持在加载器初始化时将 with_tables 参数设置为 True 时处理表格（默认情况下 with_tables=True）。
表格不会被拆分 - 每个表格对应一个 langchain Document 对象。
对于表格，Document 对象有额外的 metadata 字段 type="table"
和 text_as_html，其中包含表格的 HTML 表示。
loader = DedocFileLoader("./example_data/mlb_teams_2012.csv")
docs = loader.load()
docs[1].metadata["type"], docs[1].metadata["text_as_html"][:200]
('table',
'<table border="1" style="border-collapse: collapse; width: 100%;">\n<tbody>\n<tr>\n<td colspan="1" rowspan="1">Team</td>\n<td colspan="1" rowspan="1"> "Payroll (millions)"</td>\n<td colspan="1" r')
处理附件文件
DedocFileLoader 支持在加载器初始化时将 with_attachments 设置为 True 时处理附加文件（默认情况下 with_attachments=False）。
附件根据split参数进行分割。
对于附件，langchain的Document对象有一个额外的元数据字段type="attachment"。
loader = DedocFileLoader(
"./example_data/fake-email-attachment.eml",
with_attachments=True,
)
docs = loader.load()
docs[1].metadata["type"], docs[1].page_content
('attachment',
'\nContent-Type\nmultipart/mixed; boundary="0000000000005d654405f082adb7"\nDate\nFri, 23 Dec 2022 12:08:48 -0600\nFrom\nMallori Harrell <mallori@unstructured.io>\nMIME-Version\n1.0\nMessage-ID\n<CAPgNNXSzLVJ-d1OCX_TjFgJU7ugtQrjFybPtAMmmYZzphxNFYg@mail.gmail.com>\nSubject\nFake email with attachment\nTo\nMallori Harrell <mallori@unstructured.io>')
加载PDF文件
如果您只想处理PDF文档，您可以使用仅支持PDF的DedocPDFLoader。
该加载器支持相同的参数用于文档分割、表格和附件提取。
Dedoc 可以提取带有或不带有文本层的 PDF，并自动检测其存在和正确性。提供了多个 PDF 处理程序，您可以使用 pdf_with_text_layer 参数来选择其中之一。请参阅 参数描述 以获取更多详细信息。
对于没有文本层的PDF，应安装Tesseract OCR及其语言包。
在这种情况下，该指南可能会有所帮助。
from langchain_community.document_loaders import DedocPDFLoader
loader = DedocPDFLoader(
"./example_data/layout-parser-paper.pdf", pdf_with_text_layer="true", pages="2:2"
)
docs = loader.load()
docs[0].page_content[:400]
'\n2\n\nZ. Shen et al.\n\n37], layout detection [38, 22], table detection [26], and scene text detection [4].\n\nA generalized learning-based framework dramatically reduces the need for the\n\nmanual specification of complicated rules, which is the status quo with traditional\n\nmethods. DL has the potential to transform DIA pipelines and benefit a broad\n\nspectrum of large-scale document digitization projects.\n'
Dedoc API
如果你想以较少的设置快速上手，你可以使用Dedoc作为服务。
DedocAPIFileLoader可以在不安装dedoc库的情况下使用。
该加载器支持与DedocFileLoader相同的参数，并且还能自动检测输入文件类型。
要使用DedocAPIFileLoader，您应该运行Dedoc服务，例如Docker容器（请参阅文档了解更多详情）：
docker pull dedocproject/dedoc
docker run -p 1231:1231
请不要在您的代码中使用我们的演示URL https://dedoc-readme.hf.space。
from langchain_community.document_loaders import DedocAPIFileLoader
loader = DedocAPIFileLoader(
"./example_data/state_of_the_union.txt",
url="https://dedoc-readme.hf.space",
)
docs = loader.load()
docs[0].page_content[:400]
'\nMadam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans. \n\n\n\nLast year COVID-19 kept us apart. This year we are finally together again. \n\n\n\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n\n\n\nWith a duty to one another to the American people to '
