文档转换服务项目教程

文档转换服务项目教程

docling-api Easily deployable and scalable backend server that efficiently converts various document formats (pdf, docx, pptx, html, images, etc) into Markdown. With support for both CPU and GPU processing, it is Ideal for large-scale workflows, it offers text/table extraction, OCR, and batch processing with sync/async endpoints. 项目地址: https://gitcode.com/gh_mirrors/do/docling-api

一、项目目录结构及介绍

项目目录结构如下所示：

docling-api/
├── images/                       # 存储项目所需的图片资源
├── worker/                       # 存储Celery工作进程相关文件
├── document_converter/           # 存储文档转换相关代码
├── .env.example                  # 配置文件示例
├── .gitignore                    # 指定git忽略的文件
├── pre-commit-config.yaml        # pre-commit配置文件
├── Dockerfile                    # Docker构建文件
├── LICENSE                       # 项目许可证文件
├── README.md                     # 项目说明文件
├── docker-compose.cpu.yml        # Docker Compose配置文件（CPU模式）
├── docker-compose.gpu.yml        # Docker Compose配置文件（GPU模式）
├── main.py                       # 项目主程序文件
├── poetry.lock                   # Poetry依赖锁定文件
└── pyproject.toml                # Poetry项目配置文件

• images/：存放项目所需的图片资源。
• worker/：包含Celery工作进程的配置和启动脚本。
• document_converter/：包含文档转换服务的核心代码。
• .env.example：提供了项目环境变量的示例配置。
• .gitignore：定义了Git应该忽略的文件和目录。
• pre-commit-config.yaml：配置pre-commit钩子，用于在提交代码前执行一些格式化任务。
• Dockerfile：定义了如何构建Docker镜像。
• LICENSE：项目的开源许可证。
• README.md：项目的详细说明文档。
• docker-compose.cpu.yml：使用CPU模式的Docker Compose配置。
• docker-compose.gpu.yml：使用GPU模式的Docker Compose配置。
• main.py：项目的主程序，启动FastAPI服务。
• poetry.lock：记录了项目的依赖关系。
• pyproject.toml：定义了项目信息和依赖。

二、项目的启动文件介绍

项目的启动文件是main.py，它负责初始化和启动FastAPI服务。以下是main.py的主要部分：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Welcome to the Docling API!"}

# 更多API路由和逻辑...

main.py文件中创建了一个FastAPI实例，并定义了一个简单的根路由，用于确认服务正在运行。

三、项目的配置文件介绍

项目的配置文件是.env.example，它包含了项目所需的环境变量和默认值。在本地开发时，你可以根据这个示例文件创建一个.env文件，并填入相应的配置值。

以下是.env.example文件的内容：

REDIS_HOST=redis://localhost:6379/0
ENV=development
# 其他可能的配置项...

• REDIS_HOST：定义了Redis服务器的地址，用于消息队列和结果后端。
• ENV：定义了项目的环境，通常是development或production。

在实际部署时，应根据实际环境调整这些配置值，并确保它们在.env文件中正确设置。

docling-api Easily deployable and scalable backend server that efficiently converts various document formats (pdf, docx, pptx, html, images, etc) into Markdown. With support for both CPU and GPU processing, it is Ideal for large-scale workflows, it offers text/table extraction, OCR, and batch processing with sync/async endpoints. 项目地址: https://gitcode.com/gh_mirrors/do/docling-api