提交SAR解析任务
异步接口。通过专利PN下载原文,或直接上传PDF,创建一个SAR解析任务;成功时从data.task_id取得任务ID
调用步骤:1. pn和file必须且只能提供一个,PDF最大30MB、1000页;2. language可省略,默认EN;3. 提交成功返回status=true、data.status=PROCESSING;4. 使用data.task_id调用/file/detail,直到data.status为SUCCESS、FAILED或NOT_FOUND。
请求参数
此 API 接口支持的参数列表
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| file | document.pdf | 待解析的PDF文件,最大30MB、1000页;与pn二选一 |
| string | EN | 结果语言:CN(中文)或EN(英文) |
| string | US10392366B2 | 专利公开号;与file二选一 |
响应结构
API 响应数据的结构说明
| 字段名 | 类型 | 示例 | 描述 |
|---|---|---|---|
data | object | {
"status": "PROCESSING",
"task_id": "abc123xyz"
} | 任务提交结果 |
status | string | PROCESSING | 提交状态,固定为PROCESSING,表示任务已创建。创建失败时通过外层status=false返回 |
task_id | string | abc123xyz | 任务ID。提交成功后使用该ID调用 /file/detail 轮询任务状态 |
status | boolean | true | 请求是否成功 |
error_msg | string | Exactly one of pn or file must be provided | 错误信息;成功时不返回 |
error_code | integer<int32> | - | 业务错误码;成功时为0 |
error_params | object | {} | 错误参数;成功时不返回 |
成功响应示例
成功调用 API 的响应示例
JSON
{
"data": {
"status": "PROCESSING",
"task_id": "abc123xyz"
},
"status": true,
"error_msg": "Exactly one of pn or file must be provided",
"error_code": 0,
"error_params": {}
}错误码
此接口可能返回的错误码列表
业务错误码
| 错误码 | 描述 |
|---|---|
68300004 | 请求参数异常! |
68300005 | 查询Api失败! |
68300006 | 解析基本存取错误! |
68300007 | 存在错误的请求! |
68300008 | 服务中断异常,请稍后再试! |
68300010 | 文件不符合上传规范! |
平台错误码
| 错误码 | 描述 |
|---|---|
67200000 | API整体限流错误! |
67200001 | API整体限流错误! |
67200002 | 当前调用速率过快,超过当前配置限制QPS! |
67200003 | 申请token的key和secret传参不正确或者客户端已被禁用! |
67200004 | 请求的接口无权限请联系我们的支持人员! |
67200005 | 账户余额/调用次数不足! |
67200006 | 客户端超过开通有效期! |
67200007 | 当前调用超过当天配置使用额度! |
67200008 | 请检查query参数中必填的apikey是否传输! |
67200009 | apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token! |
67200012 | 请求不合法! |
67200100 | 当前服务器状态正忙,请求响应超时! |
67200101 | 当前请求的Api不存在请检查请求Path! |
HTTP 状态码
| 状态码 | 描述 |
|---|---|
0 | 请求成功 |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
性能指标
此接口的预期性能特征
正常响应时间
5000 ms
最大响应时间
10000 ms