JSON OCR

AI-powered OCR that turns any image or PDF into clean, structured JSON. You define the fields you want with a simple schema; the API reads the document and returns validated data — invoices, receipts, IDs, forms, and more. No templates, no training

原始信息汇总

数据集概述：JSON OCR

JSON OCR 是一个基于视觉大语言模型（Vision LLM）的结构化OCR API，旨在将图像或PDF文档转换为符合用户定义Schema的干净、结构化的JSON数据。

核心功能

• Schema驱动提取：用户通过声明式Schema定义输出结构，API返回的数据将自动进行验证，确保无意外字段。
• 免模板、免训练：可处理从未见过的文档类型，如发票、收据、采购订单、身份证、名片、表格、手写笔记等。
• 多格式输入：支持PNG、JPEG图像以及PDF（包括扫描件和多页PDF）。
• 灵活输入方式：支持通过base64字符串、公开URL或multipart/form-data文件上传提供文档。
• 支持部分结果：通过添加"allowPartial": true参数，可在文档不完整时获取最佳努力结果及逐字段错误信息。
• Schema推断：提供/v1/extract-schema端点，可自动从文档中推断出合适的提取Schema。

可提取的文档类型

• 发票、收据、采购订单、身份证、名片、表格、手写笔记等。

端点

• POST /v1/extract：根据指定的Schema从文档中提取数据。
  • 请求体支持：source（base64或url）、schema（简单Schema）或jsonSchema（完整JSON Schema）、allowPartial（可选）。
  • 响应：成功时返回{ "data": { ... } }；失败时返回带有error信息的错误码。
• POST /v1/extract-schema：为文档推断Schema。
  • 支持查询参数?format=easy返回简单Schema（field: type），默认返回完整JSON Schema。

如何定义提取Schema

• 简单模式（Easy Mode）：适用于扁平文档，使用field → type映射，类型支持string、number、boolean。
  • 示例：{ "merchant": "string", "amount": "number", "paid": "boolean" }
• 完整模式（Power Mode）：适用于嵌套结构、数组、枚举和验证规则，使用JSON Schema (draft 2020-12)。
  • 示例：可定义包含vendor、total、line_items（数组，包含description、qty、price）的复杂对象。

身份验证与基址

• 认证方式：通过RapidAPI进行，请求头需包含X-RapidAPI-Key和X-RapidAPI-Host。
• 基URL：https://json-ocr.p.rapidapi.com

支持的输入格式

格式	说明
PNG / JPEG	照片和扫描件
PDF	文本及扫描页，包括多页PDF

响应与错误处理

• 成功：返回HTTP 2xx，响应体为{ "data": { ... } }。
• 部分结果：返回{ "data": { ... }, "errors": ["field: reason"] }，仅在启用allowPartial时出现。
• 失败：返回HTTP 4xx或5xx，响应体为{ "error": { "code", "message" } }。
• 所有响应均包含X-Request-Id头，用于调试和支持。