Dedoc
本示例演示了将 Dedoc
与 LangChain
结合使用作为 DocumentLoader
的方法。
概述
Dedoc 是一个 开源 库/服务,可从各种格式的文件中提取文本、表格、附加文件和文档结构(例如,标题、列表项等)。
Dedoc
支持 DOCX
、XLSX
、PPTX
、EML
、HTML
、PDF
、图像等。支持格式的完整列表可在 此处 找到。
集成详细信息
类 | 包 | 本地 | 可序列化 | JS 支持 |
---|---|---|---|---|
DedocFileLoader | langchain_community | ❌ | beta | ❌ |
DedocPDFLoader | langchain_community | ❌ | beta | ❌ |
DedocAPIFileLoader | langchain_community | ❌ | beta | ❌ |
加载器功能
提供懒加载和异步加载方法,但实际上,文档加载是同步执行的。
来源 | 文档懒加载 | 异步支持 |
---|---|---|
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.ac.cn/v0.2/api_reference/community/document_loaders/langchain_community.document_loaders.dedoc.DedocFileLoader.html
- https://python.langchain.ac.cn/v0.2/api_reference/community/document_loaders/langchain_community.document_loaders.pdf.DedocPDFLoader.html
- https://python.langchain.ac.cn/v0.2/api_reference/community/document_loaders/langchain_community.document_loaders.dedoc.DedocAPIFileLoader.html
加载任何文件
为了自动处理 支持格式 中的任何文件,DedocFileLoader
可能很有用。文件加载器会自动检测具有正确扩展名的文件类型。
文件解析过程可以通过 dedoc_kwargs
在 DedocFileLoader
类初始化期间进行配置。这里给出了某些选项使用情况的基本示例,请参阅 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
处理表格
当 with_tables
参数在加载器初始化期间设置为 True
时,DedocFileLoader
支持表格处理(默认情况下 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')
处理附加文件
当 with_attachments
在加载器初始化期间设置为 True
时,DedocFileLoader
支持附加文件处理(默认情况下 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 <[email protected]>\nMIME-Version\n1.0\nMessage-ID\n<CAPgNNXSzLVJ-d1OCX_TjFgJU7ugtQrjFybPtAMmmYZzphxNFYg@mail.gmail.com>\nSubject\nFake email with attachment\nTo\nMallori Harrell <[email protected]>')
加载 PDF 文件
如果您只想处理 PDF
文档,可以使用仅支持 PDF
的 DedocPDFLoader
。加载器支持相同的参数,用于文档拆分、表格和附件提取。
Dedoc
可以提取包含或不包含文本层的 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 '