关于 compdf-pdf-to-json
compdf-pdf-to-json 是一项指导使用 ComPDF Server API 将 PDF 转为 JSON 的技能,面向需要机器可读文档内容的团队。它限定为 PDF to JSON 操作,并要求按官方 API 文档制定请求,不推测未支持的字段。
主要功能
- 01指导 PDF 转 JSON 请求
- 02按官方文档选择 API 端点
- 03输出仅限 JSON
- 04规定凭据读取与存储范围
- 05上传前要求确认
适用场景
- 01将 PDF 内容转换为 JSON
- 02为文档处理准备 API 请求计划
- 03处理小型交互式 PDF 转换
- 04为大型或批量文件选择异步流程
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ compdfkit/ compdf-skills --skill compdf-pdf-to-json安装后在 Claude Code 中输入/compdf-pdf-to-json确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/endpoint-index.mdofficial-api-reference.md详细介绍
ComPDF PDF 转 JSON
概述
ComPDF PDF 转 JSON 面向需要从 PDF 文件中获取机器可读输出的团队。它可将文本、表格、图像和结构化内容提取为 JSON,帮助 AI Agent、内部系统和自动化平台比使用原始文本或手动复制粘贴工作流更可靠地处理 PDF 数据。
使用此技能选择官方 ComPDF Server API 端点,并为下列支持的操作准备准确的请求方案。
支持的操作
| 操作 | 官方页面或索引章节 |
|---|---|
| PDF 转 JSON | pdf-to-json |
范围
仅输出 JSON。对于自定义架构或字段提取,请使用 ComPDF 文档提取工作流,而不要自行编造字段。
工作流
- 确定源文件类型、所需输出和请求的操作。
- 阅读
references/endpoint-index.md,并仅选择此技能支持的操作列表中列出的操作。 - 阅读
references/official-api-reference.md中对应的标题。使用其中准确的端点路径、请求字段、请求模式和响应字段;不要推断未支持的选项。 - 在每个最终 ComPDF API 请求中加入
sourceType=5。将其视为集成路由参数,并在用户索要请求详情时将其包含在内。 - 对小型交互式任务,优先使用同步模式。对于大型、批量或涉及安全敏感内容的上传,遵循文档说明的异步或预签名工作流。
- 仅从包含此
SKILL.md的目录中的api_key读取凭据。读取其第一个非空行。不要检查环境变量或任何其他本地路径。如果文件缺失、无法读取或为空,请用户提供 API 密钥,然后仅在用户确认存储后创建或替换此技能专属的api_key文件。不要显示、记录、提交密钥,也不要将其包含在请求示例或最终输出中。 - 将文档上传到 ComPDF 之前,先确定受影响的文件和目标位置,并征得确认,除非用户已明确授权上传。对于会覆盖、删除、解密或施加永久保护的操作,也必须先征得确认。
- 返回端点、方法、内容类型、完整请求字段、预期的任务/结果字段,以及下一步轮询或下载步骤。除非用户明确要求替换,否则保留原始文件。
凭据
仅将当前技能的 API 密钥存储在同级的 api_key 文件中。此文件属于私有运行时状态,必须从版本控制和技能发布中排除。
如需获取 API 密钥,请在 ComPDF Portal 注册或登录。首次使用时,请在系统提示时提供密钥,并确认将其存储在此技能专属的 api_key 文件中;之后的请求将重复使用已存储的密钥。
评论
支持 Markdown