ExtractThinker

ExtractThinker 是一款灵活的文档智能工具，它利用大型语言模型（LLMs）从文档中提取和分类结构化数据，就像一个 ORM 一样，能够实现流畅的文档处理工作流。

简而言之：面向 LLM 的文档智能

🚀 核心功能

• 灵活的文档加载器：支持多种文档加载器，包括 Tesseract OCR、Azure 表单识别器、AWS Textract、Google 文档 AI 等。
• 可定制的契约：使用 Pydantic 模型定义自定义提取契约，以实现精确的数据提取。
• 高级分类：通过自定义分类和策略对文档或文档部分进行分类。
• 异步处理：采用异步处理方式，高效处理大型文档。
• 多格式支持：无缝处理各种文档格式，如 PDF、图像、电子表格等。
• ORM 风格交互：以类似 ORM 的方式与文档和 LLM 交互，便于直观开发。
• 拆分策略：实施惰性或主动拆分策略，按页或整体处理文档。
• 与 LLM 集成：轻松集成到不同的 LLM 提供商，如 OpenAI、Anthropic、Cohere 等。
• 社区驱动开发：受 LangChain 生态系统的启发，专注于智能文档处理。

📦 安装

使用 pip 安装 ExtractThinker：

pip install extract_thinker

🛠️ 使用方法

基本提取示例

以下是一个快速入门示例，演示如何使用 ExtractThinker。此示例展示了如何使用 PyPdf 加载文档，并提取契约中定义的特定字段。

import os
from dotenv import load_dotenv
from extract_thinker import Extractor, DocumentLoaderPyPdf, Contract

load_dotenv()

class InvoiceContract(Contract):
    invoice_number: str
    invoice_date: str

# 设置 Tesseract 可执行文件的路径
test_file_path = os.path.join("path_to_your_files", "invoice.pdf")

# 初始化提取器
extractor = Extractor()
extractor.load_document_loader(DocumentLoaderPyPdf())
extractor.load_llm("gpt-4o-mini")  # 或任何其他支持的模型

# 从文档中提取数据
result = extractor.extract(test_file_path, InvoiceContract)

print("发票号码:", result.invoice_number)
print("发票日期:", result.invoice_date)

分类示例

ExtractThinker 允许您使用自定义分类对文档或文档的一部分进行分类：

import os
from dotenv import load_dotenv
from extract_thinker import (
    Extractor, Classification, Process, ClassificationStrategy,
    DocumentLoaderPyPdf, Contract
)

load_dotenv()

class InvoiceContract(Contract):
    invoice_number: str
    invoice_date: str

class DriverLicenseContract(Contract):
    name: str
    license_number: str

# 初始化提取器并加载文档加载器
extractor = Extractor()
extractor.load_document_loader(DocumentLoaderPyPdf())
extractor.load_llm("gpt-4o-mini")

# 定义分类
classifications = [
    Classification(
        name="Invoice",
        description="一张发票文档",
        contract=InvoiceContract,
        extractor=extractor,
    ),
    Classification(
        name="Driver License",
        description="一张驾驶证文档",
        contract=DriverLicenseContract,
        extractor=extractor,
    ),
]

# 直接使用提取器对文档进行分类
result = extractor.classify(
    "path_to_your_document.pdf",  # 可以是文件路径或 IO 流
    classifications,
    image=True  # 设置为 True 进行基于图像的分类
)

# 结果将是一个包含 'name' 和 'confidence' 字段的 ClassificationResponse 对象
print(f"文档被分类为: {result.name}")
print(f"置信度: {result.confidence}")

文件拆分示例

ExtractThinker 允许您使用不同的策略拆分和处理文档。以下是拆分文档并根据分类提取数据的方法。

import os
from dotenv import load_dotenv
from extract_thinker import (
    Extractor,
    Process,
    Classification,
    ImageSplitter,
    DocumentLoaderTesseract,
    Contract,
    SplittingStrategy,
)

load_dotenv()

class DriverLicenseContract(Contract):
    name: str
    license_number: str

class InvoiceContract(Contract):
    invoice_number: str
    invoice_date: str

# 初始化提取器并加载文档加载器
extractor = Extractor()
extractor.load_document_loader(DocumentLoaderPyPdf())
extractor.load_llm("gpt-4o-mini")

# 定义分类
classifications = [
    Classification(
        name="Driver License",
        description="一张驾驶证文档",
        contract=DriverLicenseContract,
        extractor=extractor,
    ),
    Classification(
        name="Invoice",
        description="一张发票文档",
        contract=InvoiceContract,
        extractor=extractor,
    ),
]

# 初始化流程并加载拆分器
process = Process()
process.load_document_loader(DocumentLoaderPyPdf())
process.load_splitter(ImageSplitter(model="gpt-4o-mini"))

# 加载并处理文档
path_to_document = "path_to_your_multipage_document.pdf"
split_content = (
    process.load_file(path_to_document)
    .split(classifications, strategy=SplittingStrategy.LAZY)
    .extract()
)

# 根据需要处理提取的内容
for item in split_content:
    if isinstance(item, InvoiceContract):
        print("提取的发票:")
        print("发票号码:", item.invoice_number)
        print("发票日期:", item.invoice_date)
    elif isinstance(item, DriverLicenseContract):
        print("提取的驾驶证:")
        print("姓名:", item.name)
        print("许可证号码:", item.license_number)

批量处理示例

您还可以对文档进行批量处理：

from extract_thinker import Extractor, Contract

class ReceiptContract(Contract):
    store_name: str
    total_amount: float

extractor = Extractor()
extractor.load_llm("gpt-4o-mini")

# 文件路径或流的列表
document = "receipt1.jpg"

batch_job = extractor.extract_batch(
    source=document,
    response_model=ReceiptContract,
    vision=True,
)

# 监控批量作业状态
print("批量作业状态:", await batch_job.get_status())

# 处理完成后获取结果
results = await batch_job.get_result()
for result in results.parsed_results:
    print("商店名称:", result.store_name)
    print("总金额:", result.total_amount)

本地 LLM 集成示例

ExtractThinker 支持自定义 LLM 集成。以下是使用自定义 LLM 的方法：

from extract_thinker import Extractor, LLM, DocumentLoaderTesseract, Contract

class InvoiceContract(Contract):
    invoice_number: str
    invoice_date: str

# 初始化提取器
extractor = Extractor()
extractor.load_document_loader(DocumentLoaderTesseract(os.getenv("TESSERACT_PATH")))

# 加载自定义 LLM（例如 Ollama）
os.environ['API_BASE'] = "http://localhost:11434"
llm = LLM('ollama/phi3')
extractor.load_llm(llm)

# 提取数据
result = extractor.extract("invoice.png", InvoiceContract)
print("发票号码:", result.invoice_number)
print("发票日期:", result.invoice_date)

📚 文档和资源

• 示例: 查看 examples 目录中的 Jupyter 笔记本和脚本，演示各种使用场景。
• Medium 文章: 阅读作者 Medium 页面上关于 ExtractThinker 的文章。
• 测试套件: 探索 tests/ 目录中的测试套件，获取更多高级用法示例和测试案例。

🧩 与 LLM 提供商的集成

ExtractThinker 支持与多个 LLM 提供商的集成：

• OpenAI: 使用 gpt-3.5-turbo、gpt-4 等模型。
• Anthropic: 集成 Claude 模型。
• Cohere: 利用 Cohere 的语言模型。
• Azure OpenAI: 连接 Azure 的 OpenAI 服务。
• 本地模型: 兼容 Ollama 的模型。

⚙️ 工作原理

ExtractThinker 采用受 LangChain 生态系统启发的模块化架构：

• 文档加载器: 负责从各种来源和格式加载并预处理文档。
• 提取器: 协调文档加载器与 LLM 之间的交互，以提取结构化数据。
• 分割器: 实现将文档分割为可管理块的策略，以便进行处理。
• 合同: 使用 Pydantic 模型定义提取数据的预期结构。
• 分类器: 对文档或文档部分进行分类，以应用适当的提取合同。
• 流程: 管理从文档加载、分类、分割到数据提取的工作流程。

📝 为什么使用 ExtractThinker？

虽然像 LangChain 这样的通用框架提供了广泛的功能，但 ExtractThinker 专门用于智能文档处理 (IDP)。它通过以下方式简化了 IDP 相关的复杂性：

• 专用组件: 专为文档加载、分割和提取设计的工具。
• LLM 高精度: 利用 LLM 的强大功能提高数据提取和分类的准确性。
• 易用性: 直观的 API 和 ORM 风格的交互降低了学习曲线。
• 社区支持: 积极的开发和社区支持。

🤝 贡献

我们欢迎社区的贡献！要参与贡献：

1. 分支仓库
2. 为您的功能或错误修复创建新分支
3. 为您的更改编写测试
4. 运行测试以确保一切正常工作
5. 提交包含您更改描述的拉取请求

🌟 社区和支持

保持更新并与社区保持联系：

• 使用 o1、GPT-4o 和 Mini 扩展文档提取
• Claude 3.5 — 文档智能之王
• LLM 的分类树
• 使用 LLM 进行高级文档分类
• Phi-3 和 Azure：PDF 数据提取 | ExtractThinker
• ExtractThinker：面向 LLM 的文档智能

📄 许可证

本项目采用 Apache License 2.0 许可证。有关详细信息，请参阅 LICENSE 文件。

联系方式

如有任何问题或疑问，请在 GitHub 仓库中提交问题，或通过电子邮件联系我们。

ExtractThinker 快速上手指南

环境准备

系统要求

• Python 3.9 或更高版本
• 支持 Linux、macOS 和 Windows 操作系统

前置依赖

• python-dotenv（用于加载环境变量）
• pydantic（用于定义数据结构）
• 其他依赖会通过 pip 自动安装

推荐使用国内镜像源加速安装，例如：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple extract_thinker

安装步骤

使用 pip 安装 ExtractThinker：

pip install extract_thinker

基本使用

以下是一个最简单的使用示例，演示如何加载文档并提取指定字段。

import os
from dotenv import load_dotenv
from extract_thinker import Extractor, DocumentLoaderPyPdf, Contract

load_dotenv()

class InvoiceContract(Contract):
    invoice_number: str
    invoice_date: str

# 设置文档路径
test_file_path = os.path.join("path_to_your_files", "invoice.pdf")

# 初始化提取器
extractor = Extractor()
extractor.load_document_loader(DocumentLoaderPyPdf())
extractor.load_llm("gpt-4o-mini")  # 可替换为其他支持的模型

# 提取数据
result = extractor.extract(test_file_path, InvoiceContract)

print("Invoice Number:", result.invoice_number)
print("Invoice Date:", result.invoice_date)