关于 docling
面向需要阅读或处理多种文件的开发者和用户的文档转换技能。它介绍 CLI、Python SDK、结构化提取、分块及服务端转换,可导出 Markdown 或 JSON。
主要功能
- 01转换多种文档格式
- 02导出 Markdown 或结构化 JSON
- 03使用 CLI 或 Python SDK
- 04提取类型化字段并切分文档
- 05通过服务端执行转换
适用场景
- 01在命令行读取 PDF 或网址
- 02使用自定义管线批量转换文档
- 03准备供检索使用的文档分块
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ docling-project/ docling --skill docling安装后在 Claude Code 中输入/docling确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/cli.mdextraction.mdpython-sdk.mdrag.mdservice-client.mdslim-packaging.md详细介绍
Docling
Docling 可将文档(PDF、DOCX、PPTX、XLSX、HTML、Markdown、AsciiDoc、
CSV、图像、音频和 XML)转换为统一表示形式,即
DoclingDocument,并可导出为便于阅读的 Markdown 或结构化且无损的
JSON。如果需要理解无法直接读取的文件内容,尤其是 PDF(包括通过 OCR 或视觉语言模型处理的扫描件),请使用 Docling。
最快上手:CLI
如果只需读取文档内容,可运行 CLI。安装 docling 包时会一并安装它,并且它接受本地路径或 URL:
docling report.pdf --to md --output /tmp/ # → /tmp/report.md
docling https://example.com/paper.pdf --to json --output /tmp/
输出文件以输入文件命名(report.pdf → report.md)。默认输出目录为当前目录。此方法适用于大多数“这个文件里有什么”这类请求。有关处理流水线(标准、VLM 或原生)、OCR 引擎、表格、扫描版 PDF、密码和所有标志,请参阅 references/cli.md。
选择如何使用 Docling
| 你需要…… | 使用 | 参考 |
|---|---|---|
| 在 Shell 中读取或转换单个文件 | CLI(docling …) | references/cli.md |
| 以编程方式转换、调整流水线、批量处理、ASR、导出图像或表格 | Python SDK(DocumentConverter + PipelineOptions) | references/python-sdk.md |
| 从文档中提取特定类型的字段(而非整个文档) | DocumentExtractor(结构化提取,Beta 版) | references/extraction.md |
| 为检索处理文档分块,或馈入 RAG 索引 | 分块 + 框架加载器 | references/rag.md |
| 将转换任务交给远程服务处理,以获得低延迟和可扩展性,且无需本地 ML 依赖或 GPU | Service Client(自托管或托管式 docling-serve) | references/service-client.md |
| 仅安装实际使用的依赖项 | docling-slim extras | references/slim-packaging.md |
经验法则:
- 本地、一次性、无需编写代码 → CLI。
- 自定义流水线、分块、结构分析、嵌入应用 → Python SDK。
- 处理大量文档、低延迟、无需管理 GPU/ML 安装、按需扩展
→ 使用 Service Client 连接
docling-serve端点(自托管或托管式的 Docling for IBM watsonx 服务)。 - 尽量缩小安装体积,避免安装不需要的 torch 和 OCR 引擎 → 使用带有针对性 extras 的 docling-slim。
无需安装即可运行(uvx)
无需持久安装即可运行 CLI:
uvx --from docling docling report.pdf --to md --output /tmp/
输出约定
- 始终报告转换状态,以及(对于 PDF)页数。
- 如果用户未指定格式,请询问他们需要便于阅读的 Markdown,还是结构化且无损的 JSON / DoclingDocument。
- 对于表格,优先对表格项使用
export_to_markdown()/export_to_dataframe()(Python)——请参阅 references/python-sdk.md。 - 如果转换后的 PDF 几乎为空、内容重复或充满
�,则源文件可能是扫描件或布局复杂——请使用 OCR 或--pipeline vlm重试(参阅 references/cli.md)。
评论
支持 Markdown