Docling Serve

将 https://github.com/docling-project/docling 作为 API 服务运行。

📚 Docling Serve 文档

• 了解如何配置 Web 服务器
• 熟悉 API 的所有运行时选项
• 探索实用的部署示例
• 以及更多内容

[!NOTE] 迁移至 v1 API。Docling Serve 现已提供稳定的 v1 API。有关详情，请阅读迁移至 v1。

快速开始

安装 docling-serve 包并运行服务器。

# 使用 Python 包
pip install "docling-serve[ui]"
docling-serve run --enable-ui

# 使用容器镜像，例如通过 Podman
podman run -p 5001:5001 -e DOCLING_SERVE_ENABLE_UI=1 quay.io/docling-project/docling-serve

服务器可通过以下方式访问：

• API
• API 文档
• UI playground

尝试使用简单转换：

curl -X 'POST' \
'http://localhost:5001/v1/convert/source' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"sources": [{"kind": "http", "url": "https://arxiv.org/pdf/2501.17887"}]
}'

容器镜像

以下容器镜像适用于不同硬件和 PyTorch 配置的 Docling Serve 运行：

📦 已分发镜像

[!IMPORTANT] CUDA 镜像标签策略

CUDA 特定镜像（-cu128、-cu130）遵循 PyTorch 的 CUDA 版本支持生命周期，其标签与基础镜像不同：

• 基础镜像（docling-serve、docling-serve-cpu）：为方便起见，标记为 latest 和 main
• CUDA 镜像（docling-serve-cu*）：仅使用显式版本标记（例如 1.12.0）和 main

原因：随着 PyTorch 增加对新版本 CUDA 的支持，旧 CUDA 版本会逐渐被弃用。为避免意外拉取已弃用的 CUDA 版本，CUDA 镜像特意排除 latest 标签。请始终使用显式版本标签，例如：

> # ✅ 推荐：显式版本
> docker pull quay.io/docling-project/docling-serve-cu130:v1.18.0
>
> # ❌ CUDA 镜像不支持此标签
> docker pull quay.io/docling-project/docling-serve-cu130:latest
>

🚫 未分发

支持适用于 AMD ROCm 6.3 的镜像（docling-serve-rocm），但由于其体积较大，未发布。

如需本地构建：

git clone --branch main git@github.com:docling-project/docling-serve.git
cd docling-serve/
make docling-serve-rocm-image

有关使用 Docker Compose 部署的信息，请参见 docs/deployment.md。

即将推出：docling-serve-slim 镜像将通过跳过模型权重下载来减小体积。

演示 UI

在 /ui 端点提供易于使用的 UI。

获取帮助与支持

欢迎通过https://github.com/docling-project/docling/discussions%E4%B8%8E%E6%88%91%E4%BB%AC%E8%81%94%E7%B3%BB%E3%80%82

贡献

详情请阅读https://github.com/docling-project/docling-serve/blob/main/CONTRIBUTING.md%E3%80%82

参考文献

如果您在项目中使用 Docling，请考虑引用以下文献：

@techreport{Docling,
author = {Docling Contributors},
month = {1},
title = {Docling: An Efficient Open-Source Toolkit for AI-driven Document Conversion},
url = {https://arxiv.org/abs/2501.17887},
eprint = {2501.17887},
doi = {10.48550/arXiv.2501.17887},
version = {2.0.0},
year = {2025}
}

许可证

Docling Serve 代码库采用 MIT 许可证。

IBM ❤️ 开源 AI

Docling 由 IBM 开发。