快速开始

PDF 工具

pdf 会分析一个或多个 PDF 文档并返回文本。

快速行为:

  • Anthropic 和 Google 模型提供商使用原生提供商模式。
  • 其他提供商使用提取回退模式(先提取文本,需要时再提取页面图像)。
  • 支持单个(pdf)或多个(pdfs)输入,每次调用最多 10 个 PDF。

可用性

只有当 OpenClaw 能为该智能体解析到支持 PDF 的模型配置时,才会注册该工具:

  1. agents.defaults.pdfModel
  2. 回退到 agents.defaults.imageModel
  3. 回退到智能体解析后的会话/默认模型
  4. 如果原生 PDF 提供商由凭证支持,则优先于通用图像回退候选项

如果无法解析出可用模型,则不会暴露 pdf 工具。

可用性说明:

  • 回退链会感知凭证。配置的 provider/model 只有在 OpenClaw 能实际为该智能体认证该提供商时才算有效。
  • 原生 PDF 提供商目前是 AnthropicGoogle
  • 如果解析后的会话/默认提供商已经配置了视觉/PDF 模型,PDF 工具会先复用它,再回退到其他由凭证支持的 提供商。

输入参考

pdfstring

一个 PDF 路径或 URL。

pdfsstring[]

多个 PDF 路径或 URL,总数最多 10 个。

promptstringdefault: Analyze this PDF document.

分析提示词。

pagesstring

类似 1-51,3,7-9 的页面过滤器。

passwordstring

提取回退模式下加密 PDF 的密码。

modelstring

可选的模型覆盖项,格式为 provider/model

maxBytesMbnumber

每个 PDF 的大小上限,单位为 MB。默认为 agents.defaults.pdfMaxBytesMb10

输入说明:

  • pdfpdfs 会在加载前合并并去重。
  • 如果未提供 PDF 输入,工具会报错。
  • pages 会按从 1 开始的页码解析、去重、排序,并限制在已配置的最大页数内。
  • password 会应用于请求中的每个 PDF,并且只由提取回退模式使用。
  • maxBytesMb 默认为 agents.defaults.pdfMaxBytesMb10

支持的 PDF 引用

  • 本地文件路径(包括 ~ 展开)
  • file:// URL
  • http://https:// URL
  • OpenClaw 管理的入站引用,例如 media://inbound/<id>

引用说明:

  • 其他 URI scheme(例如 ftp://)会被拒绝,并返回 unsupported_pdf_reference
  • 在沙箱模式下,远程 http(s) URL 会被拒绝。
  • 启用仅限工作区的文件策略时,允许根目录之外的本地文件路径会被拒绝。
  • OpenClaw 的入站媒体存储下受管理的入站引用和重放路径,在仅限工作区的文件策略下是允许的。

执行模式

原生提供商模式

提供商为 anthropicgoogle 时会使用原生模式。 该工具会将原始 PDF 字节直接发送到提供商 API。

原生模式限制:

  • 不支持 pages。如果设置了该参数,工具会返回错误。
  • 不支持 password。请使用非原生模型来分析加密 PDF。
  • 支持多个 PDF 输入;每个 PDF 都会在提示词之前作为原生文档块 / 内联 PDF 部分发送。

提取回退模式

非原生提供商会使用回退模式。

流程:

  1. 从选定页面提取文本(最多 agents.defaults.pdfMaxPages,默认 20)。
  2. 如果提取出的文本长度少于 200 个字符,则将选定页面渲染为 PNG 图像并包含它们。
  3. 将提取的内容和提示词发送到选定模型。

回退细节:

  • 页面图像提取使用 4,000,000 的像素预算。
  • 可通过顶层 password 参数打开加密 PDF。
  • 如果目标模型不支持图像输入,且没有可提取文本,工具会报错。
  • 如果文本提取成功,但图像提取需要在仅文本模型上使用视觉能力, OpenClaw 会丢弃渲染图像,并继续使用提取出的 文本。
  • 提取回退使用内置的 document-extract 插件。该插件拥有 clawpdf,后者通过 PDFium WebAssembly 提供文本提取和图像渲染。

配置

json5
{  agents: {    defaults: {      pdfModel: {        primary: "anthropic/claude-opus-4-6",        fallbacks: ["openai/gpt-5.4-mini"],      },      pdfMaxBytesMb: 10,      pdfMaxPages: 20,    },  },}

查看配置参考以了解完整字段详情。

输出详情

该工具会在 content[0].text 中返回文本,并在 details 中返回结构化元数据。

常见 details 字段:

  • model:解析后的模型引用(provider/model
  • native:原生提供商模式为 true,回退模式为 false
  • attempts:成功前失败的回退尝试

路径字段:

  • 单个 PDF 输入:details.pdf
  • 多个 PDF 输入:details.pdfs[],其中包含 pdf 条目
  • 沙箱路径重写元数据(适用时):rewrittenFrom

错误行为

  • 缺少 PDF 输入:抛出 pdf required: provide a path or URL to a PDF document
  • PDF 数量过多:在 details.error = "too_many_pdfs" 中返回结构化错误
  • 不支持的引用 scheme:返回 details.error = "unsupported_pdf_reference"
  • 原生模式搭配 pages:抛出明确的 pages is not supported with native PDF providers 错误

示例

单个 PDF:

json
{  "pdf": "/tmp/report.pdf",  "prompt": "Summarize this report in 5 bullets"}

多个 PDF:

json
{  "pdfs": ["/tmp/q1.pdf", "/tmp/q2.pdf"],  "prompt": "Compare risks and timeline changes across both documents"}

带页面过滤的回退模型:

json
{  "pdf": "https://example.com/report.pdf",  "pages": "1-3,7",  "model": "openai/gpt-5.4-mini",  "prompt": "Extract only customer-impacting incidents"}

使用提取回退的加密 PDF:

json
{  "pdf": "/tmp/locked.pdf",  "password": "example-password",  "model": "openai/gpt-5.4-mini",  "prompt": "Summarize this contract"}

相关

Was this useful?