目录

• 目录
• (超级) 快速开始
• 文档
• 开源版 vs 云 API vs 企业版
• 使用 Docker Compose 快速开始
• LLM (大语言模型) 配置
  • 使用 models.yaml（推荐）
  • 使用环境变量（基础）
  • 常见 LLM API 提供商
• 许可协议
• 联系我们

开源版 vs 云 API vs 企业版

功能	开源仓库（适合开发）	云 API - chunkr.ai（最佳）	企业版
适用场景	开发与测试	生产工作负载	大规模 / 高安全性
布局分析	使用开源模型	专有内部模型	内部 + 定制微调
OCR 准确率	社区 OCR 引擎	优化的 OCR 栈	优化 + 领域微调
VLM 处理	基础开源 VLM	增强的专有 VLM	自定义微调
Excel 支持	❌	✅ 原生解析器	✅ 原生解析器
文档类型	PDF, PPT, Word, 图片	PDF, PPT, Word, 图片, Excel	PDF, PPT, Word, 图片, Excel
基础设施	自托管	全托管云	托管 / 本地部署
支持	Discord 社区	专属支持	专属创始团队
迁移支持	社区驱动	文档 + 邮件	专属迁移团队

---

如果您希望透明化、本地托管或尝试 Chunkr 的流程，开源版本是理想选择。
对于最佳性能、生产可靠性和访问内部模型，我们推荐 Chunkr 云 API。
对于高安全性或受监管行业，我们的企业版提供本地部署或 VPC 部署。

使用 Docker Compose 快速开始

1. 前置条件：

   • Docker 和 Docker Compose
   • NVIDIA 容器工具包（用于 GPU 支持，可选）

2. 克隆仓库：

git clone https://github.com/lumina-ai-inc/chunkr
cd chunkr

3. 设置环境变量：

# 复制示例环境文件
cp .env.example .env

# 配置您的 llm 模型
cp models.example.yaml models.yaml

有关如何设置 LLM 的更多信息，请参见 此处。

4. 启动服务：

# 用于 GPU 部署：
docker compose up -d

# 仅用于 CPU 部署：
docker compose -f compose.yaml -f compose.cpu.yaml up -d

# 用于 Mac ARM 架构（M1, M2, M3 等）：
docker compose -f compose.yaml -f compose.cpu.yaml -f compose.mac.yaml up -d

5. 访问服务：

   • Web UI: http://localhost:5173
   • API: http://localhost:8000

6. 完成后停止服务：

# 用于 GPU 部署：
docker compose down

# 仅用于 CPU 部署：
docker compose -f compose.yaml -f compose.cpu.yaml down

# 用于 Mac ARM 架构（M1, M2, M3 等）：
docker compose -f compose.yaml -f compose.cpu.yaml -f compose.mac.yaml down

LLM 配置

Chunkr 支持两种配置 LLM 的方式：

1. models.yaml 文件：针对多个 LLM 的高级配置，包含额外选项
2. 环境变量：单个 LLM 的简单配置

使用 models.yaml（推荐）

对于更灵活的配置，包括多个模型、默认/回退选项和速率限制：

1. 复制示例文件以创建您的配置：

cp models.example.yaml models.yaml

2. 使用您的配置编辑 models.yaml 文件。示例：

models:
  - id: gpt-4o
    model: gpt-4o
    provider_url: https://api.openai.com/v1/chat/completions
    api_key: "your_openai_api_key_here"
    default: true
    rate-limit: 200 # requests per minute - optional

使用 models.yaml 的好处：

• 同时配置多个 LLM 提供商
• 设置默认和回退模型
• 为每个模型添加分布式速率限制
• 在 API 请求中通过 ID 引用模型（详见文档）

阅读 models.example.yaml 文件以了解可用选项的更多信息。

使用环境变量（基础）

您可以通过在 .env 文件中设置以下变量来使用任何兼容 OpenAI API 的端点：

LLM__KEY:
LLM__MODEL:
LLM__URL:

常见大语言模型 (LLM) API 提供商

以下是常见的 LLM 提供商及其配置详情的表格，助您快速开始：

提供商	API URL	文档
OpenAI	https://api.openai.com/v1/chat/completions	OpenAI 文档
Google AI Studio	https://generativelanguage.googleapis.com/v1beta/openai/chat/completions	Google AI 文档
OpenRouter	https://openrouter.ai/api/v1/chat/completions	OpenRouter 模型
自托管	http://localhost:8000/v1	VLLM 或 Ollama

许可协议

本项目的核心采用双重许可：

1. GNU Affero 通用公共许可证 v3.0 (AGPL-3.0)
2. 商业许可证

如果您希望在不遵守 AGPL-3.0 许可条款的情况下使用 Chunkr，可以 联系我们 或访问我们的 网站。

联系我们

• 📧 邮箱：mehul@chunkr.ai
• 📅 预约通话：预订 30 分钟会议
• 🌐 访问我们的网站：chunkr.ai

Chunkr 快速上手指南

Chunkr 是一个开源的文档智能 API，支持文档布局分析、OCR 和语义分块。它可将 PDF、PPT、Word 及图片转换为适合 RAG/LLM 使用的数据块。本指南针对开源版本（基于社区模型）的快速部署进行说明。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux / macOS / Windows (需支持 Docker)
• 核心工具:
  • Docker
  • Docker Compose
• 硬件加速 (可选):
  • 如需 GPU 支持，请安装 NVIDIA Container Toolkit
  • 若仅使用 CPU 或 Mac ARM 架构 (M1/M2/M3)，无需额外显卡驱动

安装步骤

1. 克隆仓库

git clone https://github.com/lumina-ai-inc/chunkr
cd chunkr

2. 配置环境变量

复制示例文件并修改配置：

# 复制环境变量模板
cp .env.example .env

# 复制 LLM 模型配置模板
cp models.example.yaml models.yaml

注意: 您需要编辑 .env 和 models.yaml 文件以填入有效的 LLM API Key。推荐使用 models.yaml 配置多个模型及速率限制。

LLM 配置示例 (models.yaml):

models:
  - id: gpt-4o
    model: gpt-4o
    provider_url: https://api.openai.com/v1/chat/completions
    api_key: "your_openai_api_key_here"
    default: true
    rate-limit: 200

3. 启动服务

根据您的硬件环境选择对应的启动命令：

• GPU 部署:

  docker compose up -d
  

• 纯 CPU 部署:

  docker compose -f compose.yaml -f compose.cpu.yaml up -d
  

• Mac ARM 架构 (M1/M2/M3):

  docker compose -f compose.yaml -f compose.cpu.yaml -f compose.mac.yaml up -d
  

基本使用

服务启动成功后，您可通过以下地址访问：

• Web 管理界面: http://localhost:5173
• API 接口: http://localhost:8000

停止服务时，请使用对应的 down 命令（例如 docker compose down）。

---

⚠️ 许可说明 本项目采用双重许可模式（AGPL-3.0 或商业许可）。如果您需要在生产环境中使用且不遵守 AGPL 条款，请联系官方获取商业授权。