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/api_reference/community/document_loaders/langchain_community.document_loaders.dedoc.DedocFileLoader.html
- https://python.langchain.ac.cn/api_reference/community/document_loaders/langchain_community.document_loaders.pdf.DedocPDFLoader.html
- https://python.langchain.ac.cn/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
处理表格
当在加载器初始化期间将 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
处理程序可用,您可以使用 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 '