Nanonets 文档提取 API。可将 PDF 和图像转换为 Markdown、JSON 或 CSV,并提供置信度评分。适用于文档 OCR、发票字段提取、收据解析或表格转结构化数据。
DocStrange by Nanonets.
功能概述
DocStrange by Nanonets.是一项面向实际任务的技能,主要用于Document retrieved API – 转换PDF,图像和文档,以标记下,JSON,或CSV,并按每个字段打入信任分.;Get your API key: https://docstrang.nanonets.。
核心要点
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
- 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
- 从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;
结果检查与注意事项
涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
DocStrange(由 Nanonets 提供)
文档提取 API —— 将 PDF、图像及各类文档转换为 Markdown、JSON 或 CSV 格式,并为每个字段提供置信度评分。
获取您的 API 密钥: https://docstrange.nanonets.com/app
快速开始
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/sync" -H "Authorization: Bearer $DOCSTRANGE_API_KEY" -F "file=@document.pdf" -F "output_format=markdown"
响应示例:
{
"success": true,
"record_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"result": {
"markdown": {
"content": "# Invoice\n\n**Invoice Number:** INV-2024-001..."
}
}
}
配置
1. 获取您的 API 密钥
# 访问控制台 https://docstrange.nanonets.com/app
保存您的 API 密钥:
export DOCSTRANGE_API_KEY="your_api_key_here"
2. OpenClaw 配置(可选)
推荐方式:使用环境变量(最安全):
{
skills: {
entries: {
"docstrange": {
enabled: true,
// API 密钥从环境变量 DOCSTRANGE_API_KEY 中加载
},
},
},
}
替代方式:存储于配置文件中(请谨慎使用):
{
skills: {
entries: {
"docstrange": {
enabled: true,
env: {
DOCSTRANGE_API_KEY: "your_api_key_here",
},
},
},
},
}
安全提示: 若将 API 密钥存储在 ~/.openclaw/openclaw.json 中,请注意:
- 设置文件权限:
chmod 600 ~/.openclaw/openclaw.json - 切勿将该文件提交至版本控制系统
- 尽可能优先使用环境变量或代理自身的密钥存储服务(secret store)
- 定期轮换密钥,并在支持的情况下限制 API 密钥的权限范围
常见任务
提取为 Markdown
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/sync" -H "Authorization: Bearer $DOCSTRANGE_API_KEY" -F "file=@document.pdf" -F "output_format=markdown"
访问内容字段:response["result"]["markdown"]["content"]
提取 JSON 字段
简单字段列表:
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/sync" -H "Authorization: Bearer $DOCSTRANGE_API_KEY" -F "file=@invoice.pdf" -F "output_format=json" -F 'json_options=["invoice_number", "date", "total_amount", "vendor"]' -F "include_metadata=confidence_score"
使用 JSON Schema:
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/sync"
-H "Authorization: Bearer $DOCSTRANGE_API_KEY"
-F "file=@invoice.pdf"
-F "output_format=json"
-F '{"type": "object", "properties": {"invoice_number": {"type": "string"}, "total_amount": {"type": "number"}}}'
带置信度评分的响应示例:
{
"result": {
"json": {
"content": {
"invoice_number": "INV-2024-001",
"total_amount": 500.00
},
"metadata": {
"confidence_score": {
"invoice_number": 98,
"total_amount": 99
}
}
}
}
}
提取表格为 CSV
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/sync" -H "Authorization: Bearer $DOCSTRANGE_API_KEY" -F "file=@table.pdf" -F "output_format=csv" -F "csv_options=table"
异步提取(适用于大文档)
对于页数超过 5 页的文档,请使用异步接口并轮询结果:
提交文档至队列:
curl -X POST "https://extraction-api.nanonets.com/api/v1/extract/async"
-H "Authorization: Bearer $DOCSTRANGE_API_KEY"
-F "file=@large-document.pdf"
-F "output_format=markdown"
# 返回示例:{"record_id": "12345", "status": "processing"}
轮询提取结果:
curl -X GET "https://extraction-api.nanonets.com/api/v1/extract/results/12345"
-H "Authorization: Bearer $DOCSTRANGE_API_KEY"
# 返回示例:{"status": "completed", "result": {...}}
高级功能
边界框(Bounding Boxes)
获取元素坐标,用于版面分析:
-F "include_metadata=bounding_boxes"
层级结构输出(Hierarchy Output)
提取文档结构(章节、表格、键值对等):
-F "json_options=hierarchy_output"
财务文档模式(Financial Documents Mode)
增强的表格识别与数字格式化能力:
-F "markdown_options=financial-docs"
自定义指令(Custom Instructions)
通过提示词引导提取行为:
-F "custom_instructions=Focus on financial data. Ignore headers." -F "prompt_mode=append"
多格式输出
单次请求返回多种格式:
-F "output_format=markdown,json"
适用场景
建议使用 DocStrange 的场景:
- 发票与收据处理
- 合同文本提取
- 银行对账单解析
- 表单数字化
- 图像 OCR(扫描件)
不建议使用的场景:
- 同步接口不适用于页数超过 5 页的文档(请改用异步接口)
- 音视频转录
- 非文档类图像(如照片、插图等)
最佳实践
| 文档大小 | 接口路径 | 说明 |
|---|---|---|
| ≤5 页 | /extract/sync |
即时响应 |
| >5 页 | /extract/async |
需轮询结果 |
JSON 提取方式:
- 字段列表:
["field1", "field2"]—— 快速提取 - JSON Schema:
{"type": "object", ...}—— 支持强类型校验与嵌套结构
置信度评分:
- 添加参数:
include_metadata=confidence_score - 各字段评分为 0–100 区间整数
- 建议人工复核评分低于 80 的字段
Schema 模板
发票(Invoice)
{
"type": "object",
"properties": {
"invoice_number": {"type": "string"},
"date": {"type": "string"},
"vendor": {"type": "string"},
"total": {"type": "number"},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {"type": "string"},
"quantity": {"type": "number"},
"price": {"type": "number"}
}
}
}
}
}
收据(Receipt)
{
"type": "object",
"properties": {
"merchant": {"type": "string"},
"date": {"type": "string"},
"total": {"type": "number"},
"items": {
"type": "array",
"items": {"type": "object", "properties": {"name": {"type": "string"}, "price": {"type": "number"}}}
}
}
}
安全与隐私
数据处理
重要提示: 上传至 DocStrange 的文档将传输至 https://extraction-api.nanonets.com 并在外部服务器上进行处理。
上传敏感文档前,请务必:
- 查阅 Nanonets 隐私政策与数据保留策略:https://docstrange.nanonets.com/docs
- 确认传输过程(HTTPS)与静态存储均已加密
- 核实数据删除或保留时限
- 优先使用非敏感样本文档进行测试
最佳实践:
- 在确认该服务的安全性与合规性之前,请勿上传高度敏感的个人身份信息(PII),例如社保号(SSN)、医疗记录、银行账户号码等
- 如支持,请使用具有最小必要权限范围的 API 密钥
- 定期轮换 API 密钥(建议每 90 天一次)
- 监控 API 使用日志,防范未授权访问
- 切勿在代码仓库或示例中记录或提交 API 密钥
文件大小限制
- 同步接口: 推荐用于 ≤5 页的文档
- 异步接口: 页数超过 5 页时应使用此接口,避免超时
- 大文件处理: 可考虑使用
file_url参数配合公开可访问的 URL,而非直接上传大型文件
运维防护措施
- 始终通过环境变量或安全的密钥存储服务管理 API 密钥
- 切勿在代码示例或文档中硬编码真实 API 密钥
- 所有示例中均应使用占位符(如
"your_api_key_here") - 为配置文件设置恰当的权限(JSON 配置文件建议设为 600)
- 启用 API 密钥轮换机制,并通过控制台持续监控调用情况
故障排查
400 错误(Bad Request):
- 确保仅提供一种输入源:
file、file_url或file_base64 - 验证 API 密钥是否有效
同步调用超时:
- 页数超过 5 页时请改用异步接口
- 轮询
/extract/results/{record_id}获取结果
缺失置信度评分:
- 需指定
json_options(字段列表或 JSON Schema) - 需添加
include_metadata=confidence_score
认证错误:
- 确认已正确设置
DOCSTRANGE_API_KEY环境变量 - 检查 API 密钥是否已过期或被撤销
- 确保 API 密钥值中无多余空白字符
发布前安全检查清单
在发布或更新本技能前,请确认完成以下检查项:
-
package.json中已声明requiredEnv和primaryEnv字段,且其值为DOCSTRANGE_API_KEY -
package.json的endpoints数组中已列出所有 API 接口地址 - 所有代码示例均使用占位符(如
"your_api_key_here"),未包含真实密钥 -
SKILL.md与package.json中均未嵌入任何 API 密钥或敏感信息 - “安全与隐私”章节已明确说明数据处理方式及相关风险
- 配置示例中已包含关于明文存储密钥的安全警告
- 已提供配置文件权限设置指导(如 JSON 文件建议设为 600)
参考资料
- API 文档: https://docstrange.nanonets.com/docs
- 获取 API 密钥: https://docstrange.nanonets.com/app
- 隐私政策: https://docstrange.nanonets.com/docs(请查看其中的隐私政策与数据政策链接)
热门AI工具
相关专题
本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。
0
2026.10.22
本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。
0
2026.10.22
本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。
0
2026.10.22
本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。
0
2026.10.22
本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。
0
2026.10.22
本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。
0
2026.10.22
本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。
0
2026.10.22
PHP2Shell漏洞是什么,哪些PHP版本和运行环境会受到影响,服务器应该如何检测与修复?本专题提供版本自查脚本、Linux与Docker升级命令、PHP-FPM和Apache排查步骤,以及修复验证、临时缓解和应急响应方案。
0
2026.10.22
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.5万人学习
共6课时 | 54.7万人学习
最新文章
