Chunkr项目安装与配置指南

Chunkr项目安装与配置指南

chunkr Vision infrastructure to turn complex documents into RAG/LLM-ready data 项目地址: https://gitcode.com/gh_mirrors/ch/chunkr

1. 项目基础介绍

Chunkr是一个开源的文档智能API服务，能够对文档进行布局分析、OCR（光学字符识别）和语义分块，将PDF、PPT、Word文档以及图片转换成RAG/LLM（语言模型）可处理的数据块。此项目主要使用Rust、TypeScript、Python等编程语言开发。

2. 项目使用的关键技术和框架

• OCR: 光学字符识别技术，用于从图片或文档中提取文字。
• 布局分析: 分析文档布局，理解文本、图片、标题等元素的排列和结构。
• 语义分块: 将文档内容按照语义分块，便于后续处理和理解。
• API服务: 提供RESTful API接口，方便开发者集成到自己的应用程序中。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统中已经安装以下依赖：

• Docker
• Docker Compose
• NVIDIA Container Toolkit（如果需要GPU支持）

详细安装步骤

步骤 1: 克隆项目仓库

打开终端（命令提示符或PowerShell），执行以下命令克隆项目仓库：

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

步骤 2: 配置环境变量

复制.env.example文件为.env，然后根据实际情况编辑.env文件，设置必要的环境变量。至少需要设置LLM__KEY为您的OpenAI API密钥。

cp .env.example .env
# 编辑.env文件，配置您的环境变量

步骤 3: 启动服务

根据您的需要选择以下命令启动服务：

GPU版本：

docker compose up -d

CPU版本（仍在开发中，不推荐用于生产）：

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

步骤 4: 访问服务

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

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

步骤 5: 停止服务

使用以下命令停止服务：

docker compose down

以上就是Chunkr项目的详细安装和配置指南。在安装过程中遇到任何问题，请参考项目的官方文档或联系开发者社区获取帮助。

chunkr Vision infrastructure to turn complex documents into RAG/LLM-ready data 项目地址: https://gitcode.com/gh_mirrors/ch/chunkr