[L016]文档解析

post
https://connect.zhihuiya.com/rd-llm/v1/documents/doc_parsing
在体验中心中试用

对上传文件执行版面检测和 OCR。支持 png、jpg、jpeg、pdf、doc、docx、ppt、pptx、xls、xlsx。单个文件大小不得超过 20 MB，单个文档不得超过 200 页；单次请求处理时间超过 300 秒将超时 返回的图片链接为签名链接，有期限7天。output_format 可选，默认 markdown。

请求参数

此 API 接口支持的参数列表

名称类型示例描述
file
必填
filemaximum 20MB
待解析文件。支持 png、jpg、jpeg、pdf、doc、docx、ppt、pptx、xls、xlsx。单个文件大小不得超过 20 MB，单个文档不得超过 200 页。
output_format
stringmarkdown
输出格式：both 返回 JSONL 结构化数据和 Markdown；jsonl 仅返回 JSONL 结构化数据；markdown 仅返回 Markdown。返回的图片链接为签名链接，有期限7天。默认 markdown。
可选值
bothboth returns structured JSONL data and Markdown
jsonljsonl returns structured JSONL data only
markdownmarkdown returns Markdown only

响应结构

API 响应数据的结构说明

字段名类型示例描述
data
必填
objectPlease check the form: DocumentParseResponse
文档完整解析的数据部分。
state
必填
stringsuccess
执行状态；success 表示解析成功。
results
必填
arrayPlease check the form: DocumentResultItem
JSONL 结构化数据，每个元素表示一个文档区域。output_format=markdown 时返回空数组。
url
string<uri>https://oss.example.com/doc/0_2.png?sign=...
区域裁剪图的签名链接，用于化学结构式，图片，公式和表格；未生成时为 null。返回的图片链接有期限为7天。
bbox
必填
array[ 0.16, 0.18, 0.37, 0.2, 0.9 ]
归一化坐标 [x1, y1, x2, y2, confidence]，各值范围为 0 到 1。
page
必填
integer<int32>-
页码，从 0 开始；0 表示第 1 页。
type
必填
stringtext
Layout 模型输出的原始区域类型。
markdown
stringTECHNICAL FIELD The present disclosure relates to...
完整 Markdown 汇总。output_format 为 both 或 markdown 时返回；output_format=jsonl 时不返回该字段。
file_type
必填
stringpdf
根据上传文件扩展名识别出的输入文件类型。
total_pages
必填
integer<int32>12
文档总页数；图片固定为 1。
status
必填
stringsuccess
请求执行成功。
error_msg
必填
stringsuccess
成功时固定为 success。
error_code
必填
integer<int32>-
成功时固定为 0。

成功响应示例

成功调用 API 的响应示例

JSON 
{
  "data": {
    "state": "success",
    "results": [
      {
        "url": "https://oss.example.com/doc/0_2.png?sign=...",
        "bbox": [
          0.16,
          0.18,
          0.37,
          0.2,
          0.9
        ],
        "page": 0,
        "type": "text"
      }
    ],
    "markdown": "TECHNICAL FIELD\n\nThe present disclosure relates to...",
    "file_type": "pdf",
    "total_pages": 12
  },
  "status": true,
  "error_msg": "success",
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码描述
68300004请求参数异常!
68300005查询Api失败!
68300006解析基本存取错误!
68300007存在错误的请求!
68300008服务中断异常，请稍后再试!
68300010文件不符合上传规范!

平台错误码

错误码描述
67200000API整体限流错误!
67200001API整体限流错误！
67200002当前调用速率过快,超过当前配置限制QPS！
67200003申请token的key和secret传参不正确或者客户端已被禁用！
67200004请求的接口无权限请联系我们的支持人员！
67200005账户余额/调用次数不足！
67200006客户端超过开通有效期！
67200007当前调用超过当天配置使用额度！
67200008请检查query参数中必填的apikey是否传输！
67200009apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
67200012请求不合法！
67200100当前服务器状态正忙,请求响应超时！
67200101当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码描述
0请求成功
400请求参数错误、缺少文件、文件为空或文件格式不支持
413文件大小超过 20 MB，或文档超过 200 页
500服务器内部错误；error_code 为 INTERNAL_ERROR
502下游处理失败；error_code 可能为 OCR_FAILED、LAYOUT_DETECTION_FAILED、PDF_PARSE_FAILED 或 DOCUMENT_CONVERSION_FAILED
504单次请求处理时间超过 300 秒；error_code 为 GATEWAY_TIMEOUT

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms