[AI10]生成OCR识别任务
该接口提供对OCR识别创建下载任务,生成job_id,通过job_id 去 [AI10]查询导出OCR识别结果。 OCR识别支持识别图片或扫描的PDF等文件中的数字、文字信息、表格内容等,且能对版面进行分析,输出跟原文档结构高度接近的多种格式的OCR识别结果。
请求参数
此 API 接口支持的参数列表
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
必填 | string | https://static-open.zhihuiya.com/sample/common_demo.png | 需要进行OCR识别的图片或者扫描的PDF等文件 |
必填 | string | png | 需要进行OCR识别的文件的类型,包括:pdf,png,jpg |
必填 | string | doc | 查询OCR识别结果的文件格式doc/html/xls/ppt/txt |
| array | [
"简体中文",
"数字",
"英语"
] | 需要进行OCR识别的文件中文字的语言,可支持多选,例如: 简体中文 阿布哈兹语 阿迪格语 南非荷兰语 阿古尔语 阿尔巴尼亚语 阿尔泰语 阿拉伯语(沙特阿拉伯) 亚美尼亚语(东部) 亚美尼亚语(西部) 亚美尼亚语(格拉巴) 阿瓦尔语 艾玛拉语 阿塞语(西里尔) 阿塞语(拉丁) 巴什基尔语 巴斯克语 白俄罗斯语 本巴语 布莱克福特语 布列塔尼语 布哥图语 保加利亚语 布里亚特语 加泰隆语 宿务语 查莫罗语 车臣语 繁体中文 楚克其语 楚瓦什语 科西嘉语 克里米亚鞑靼语 克罗地亚语 克罗语 捷克语 达科他语 丹麦语 达尔格瓦语 东干语 荷兰语 荷兰语(比利时) 英语 爱斯基摩语(西里尔) 爱斯基摩语(拉丁) 爱沙尼亚语 鄂温语 鄂温克语 法罗语 斐济语 芬兰语 法语 弗里西亚语 弗留利语 加告兹语 加利西亚语 干达语 德语 德语(卢森堡) 德语(新的拼写规则) 希腊语 瓜拉尼语 哈尼语 豪萨语 夏威夷语 希伯来语 匈牙利语 冰岛语 印度尼西亚语 印古什语 爱尔兰语 意大利语 日语 日语(现代) 景颇语 卡巴尔达语 卡尔梅克语 恰伊-巴尔卡尔语 卡拉卡尔帕克语 卡舒比语 卡瓦语 哈萨克语 哈卡斯语 汉特语 吉库犹语 吉尔吉斯语 刚果语 韩语 韩语(韩文字母) 科尔雅克语 克佩勒语 库梅克语 库尔德语 拉克语 拉丁语 拉脱维亚语 拉脱维亚哥特式 莱兹吉语 立陶宛语 卢巴语 马其顿语 马达加斯加语 马来语(马来西亚) 马林凯语 马耳他语 曼西语 毛利语 马里语 玛雅语 苗语 米南卡堡语 莫霍克语 蒙古语 摩尔多瓦语 那瓦特语 涅涅茨语 尼夫赫语 诺盖语 挪威语 挪威语(博克马尔) 挪威语(尼诺斯克) 尼昂加语 奥克语 奥杰布瓦语 古英语 古法语 古德语 古意大利语 古斯拉夫语 古西班牙语 奥塞梯语 帕皮阿门托语 波兰语 葡萄牙语 葡萄牙语(巴西) 凯楚阿语(玻利维亚) 利托-罗曼诸语 罗马尼亚语 罗马尼亚语(摩尔瓦多) 吉普赛语 隆迪语 俄语 俄语(旧式拼写) 俄语带重音标记 卢旺达语 萨米语(拉皮什) 萨摩亚语 苏格兰盖尔语 塞尔库普语 塞尔维亚语(西里尔) 塞尔维亚语(拉丁) 修纳语 斯洛伐克语 斯洛文尼亚语 索马里语 索布语 索托语 西班牙语 巽他语 斯瓦希利语 斯瓦齐语 瑞典语 塔巴萨兰语 塔加洛语 塔希提语 塔吉克语 鞑靼语 泰语 托克皮辛语 汤加语 茨瓦纳语 侗语 土耳其语 土库曼语(西里尔) 土库曼语(拉丁) 图瓦语 乌德穆尔特语 维吾尔语(西里尔) 维吾尔语(拉丁) 乌克兰语 乌兹别克语(西里尔) 乌兹别克语(拉丁) 越南语 威尔士语 沃洛夫语 科萨语 雅库特语 意第绪语 萨巴特克语 祖鲁语 注:默认为简体中文;数字;英语 |
响应结构
API 响应数据的结构说明
| 字段名 | 类型 | 示例 | 描述 |
|---|---|---|---|
data | object | - | 响应数据 |
job_id | string | b4bdae6b4a65432d91f25b5c52bdfd80 | 导出OCR识别结果任务id |
status必填 | boolean | false | 状态 |
error_msg | string | The request parameter format is incorrect! | 错误信息 |
error_code必填 | integer | 0 | 错误代码 |
成功响应示例
成功调用 API 的响应示例
{
"data": {
"job_id": "b4bdae6b4a65432d91f25b5c52bdfd80"
},
"status": true,
"error_code": 0
}错误码
此接口可能返回的错误码列表
业务错误码
| 错误码 | 描述 |
|---|---|
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