SDK隐私政策
整题识别(含公式)服务:基于有道机器学习团队业界领先的深度学习技术,将自然场景下图片上的题目文字、数字及公式信息,通过定位和检测,智能识别为可编辑的文本信息,轻松实现题目电子化。
Hi,您好,欢迎使用有道智云整题识别(含公式)OCR API接口服务。
本文档主要针对需要集成API的技术开发工程师,详细描述整题识别(含公式)OCR能力相关的技术内容。
如果您想快速体验服务,建议您前往 体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云OCR技术交流QQ 1群: 654064748
智云OCR技术交流QQ 2群: 471638046
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员接入测试前需要获取应用ID和应用密钥;如果您还没有,请按照新手 指南操作 。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 整题识别(含公式)OCR服务报价 。
整题识别(含公式) API HTTPS地址:
https://openapi.youdao.com/ocr_formula
调用方在集成整题识别(含公式)OCR API时,请遵循以下规则。
| 规则 | 描述 |
|---|---|
| 传输方式 | HTTPS |
| 请求方式 | POST |
| 字符编码 | 统一使用UTF-8编码 |
| 请求格式 | 表单 |
| 响应格式 | JSON |
调用API需要向接口发送以下字段来访问服务。
| 符号 | 含义 | 必填 | 举例 |
|---|---|---|---|
| detectType | 识别类型,10011:识别结果公式完美还原;10012:识别结果适合搜题,默认10011 | false | 10011 |
| imageType | 支持的图片类型,目前只支持Base64 | true | 目前只支持Base64,请置此字段固定值为1 |
| appKey | 应用ID | true | 可在 应用管理 查看 |
| img | 要识别的图片,目前只支持Base64编码 | true | UTF-8编码 |
| curtime | 时间戳(秒) | true | TimeStamp |
| sign | 签名 | true | sha256(应用ID+input+curtime+salt+应用密钥) |
| salt | UUID | true | uuid,唯一通用识别码 |
| signType | 签名类型 | true | v3 |
| docType | 服务器响应类型,目前只支持json | false | json |
签名生成方法如下: signType=v3; sign=sha256(
应用ID+input+salt+curtime+应用密钥)。 其中,input的计算方式为:input=img前10个字符+img长度+img后10个字符(当img长度大于20)或input=img字符串(当img长度小于等于20)。
具体示例如下:
a. 比如:img="Welcome to youdao AICloud.",字符串长度为26,大于20,其input="Welcome to"(前10个字符) + 26(字符串长度) + "o AICloud."(q字符串后10个字符)。 b. 比如:img = "sdT4bWrjS",字符串长度为9,小于20,input = "sdT4bWrjS".
注意:
请先将需要识别的图片转换为 Base64 编码。
在发送HTTP请求之前需要对各字段做 URL encode。
在生成签名拼接 应用ID+input+salt+curtime+应用密钥 字符串时,q 不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的 img 做URL encode。
签名和请求有疑问,可以参考文档最后的常用语言demo
返回的结果是json格式,具体说明如下:
| 字段 | 类型 | 字段说明 |
|---|---|---|
| errorCode | text | 错误码 |
| Result | jsonObject | 错误 |
| -orientation | text | 识别方向 |
| -regions | text | 区域 |
| --boundingBox | text | 识别区域坐标 |
| --dir | text | 方向:行 |
| --lines | jsonArray | 行数组 |
| ---boundingBox | text | 行坐标信息 |
| ---text_height | text | 行高 |
| ---text | text | 识别的内容 |
| ---type | text | 内容类型:文本或公式 |
**注意:**boundingBox:坐标,共八个值:分别是左上角坐标(x,y),右上角坐标(x,y),右下角坐标(x,y),左下角(x,y),原点为左上角坐标。
返回结果示例:
{
"errorCode": "0",
"Result": {
"orientation": "",
"regions": [{
"boundingBox": "13,15,584,15,584,83,13,83",
"dir": "h",
"lang": "",
"lines": [
[{
"boundingBox": "13,22,110,22,110,76,13,76",
"text_height": 53,
"words": [{
"boundingBox": "13,23,74,22,74,75,13,76",
"word": "13."
}, {
"boundingBox": "86,22,110,22,110,75,86,75",
"word": "若"
}],
"text": "13.若",
"type": "text"
}, {
"boundingBox": "111,15,326,15,326,82,111,82",
"text_height": 67,
"words": [{
"boundingBox": "111,15,326,15,326,82,111,82",
"word": " x = ( \\sqrt { 3 } { - 5 } ) ^ { 3 }"
}],
"text": "x = ( \\sqrt { 3 } { - 5 } ) ^ { 3 }",
"type": "formula"
}, {
"boundingBox": "327,22,384,22,384,76,327,76",
"text_height": 53,
"words": [{
"boundingBox": "327,22,338,22,338,75,327,75",
"word": ","
}, {
"boundingBox": "350,23,384,23,384,76,350,76",
"word": "则"
}],
"text": ",则",
"type": "text"
}, {
"boundingBox": "385,15,584,15,584,83,385,83",
"text_height": 67,
"words": [{
"boundingBox": "385,16,584,15,584,82,385,83",
"word": " \\sqrt { - x - 1 } ="
}],
"text": "\\sqrt { - x - 1 } =",
"type": "formula"
}]
]
}],
"exif": "UP"
}
}
| 支持图片格式 | 每小时最大请求次数 | 图片大小 |
|---|---|---|
| jpg\png\bmp | 3600 | 编码后2M |
| 错误码 | 含义 |
|---|---|
| 101 | 缺少必填的参数,首先确保必填参数齐全,然后,确认参数书写是否正确。 |
| 102 | 不支持的语言类型 |
| 103 | 翻译文本过长 |
| 104 | 不支持的API类型 |
| 105 | 不支持的签名类型 |
| 106 | 不支持的响应类型 |
| 107 | 不支持的传输加密类型 |
| 108 | 应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息 |
| 109 | batchLog格式不正确 |
| 110 | 无相关服务的有效实例,应用没有绑定服务实例,可以新建服务实例,绑定服务实例。注:某些服务的翻译结果发音需要tts实例,需要在控制台创建语音合成实例绑定应用后方能使用。 |
| 111 | 开发者账号无效 |
| 112 | 请求服务无效 |
| 113 | q不能为空 |
| 114 | 不支持的图片传输方式 |
| 201 | 解密失败,可能为DES,BASE64,URLDecode的错误 |
| 202 | 签名检验失败,如果确认应用ID和应用密钥的正确性,仍返回202,一般是编码问题。请确保 img 为UTF-8编码. |
| 203 | 访问IP地址不在可访问IP列表 |
| 205 | 请求的接口与应用的平台类型不一致,确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。如有疑问请参考入门指南 |
| 206 | 因为时间戳无效导致签名校验失败 |
| 207 | 重放请求 |
| 301 | 辞典查询失败 |
| 302 | 翻译查询失败 |
| 303 | 服务端的其它异常 |
| 304 | 会话闲置太久超时 |
| 401 | 账户已经欠费停 |
| 402 | offlinesdk不可用 |
| 411 | 访问频率受限,请稍后访问 |
| 412 | 长请求过于频繁,请稍后访问 |
| 1001 | 无效的OCR类型 |
| 1002 | 不支持的OCR image类型 |
| 1003 | 不支持的OCR Language类型 |
| 1004 | 识别图片过大 |
| 1201 | 图片base64解密失败 |
| 1301 | OCR段落识别失败 |
| 1411 | 访问频率受限 |
| 1412 | 超过最大识别字节数 |
| 2003 | 不支持的语言识别Language类型 |
| 2004 | 合成字符过长 |
| 2005 | 不支持的音频文件类型 |
| 2006 | 不支持的发音类型 |
| 2201 | 解密失败 |
| 2301 | 服务的异常 |
| 2411 | 访问频率受限,请稍后访问 |
| 2412 | 超过最大请求字符数 |
| 3001 | 不支持的语音格式 |
| 3002 | 不支持的语音采样率 |
| 3003 | 不支持的语音声道 |
| 3004 | 不支持的语音上传类型 |
| 3005 | 不支持的语言类型 |
| 3006 | 不支持的识别类型 |
| 3007 | 识别音频文件过大 |
| 3008 | 识别音频时长过长 |
| 3009 | 不支持的音频文件类型 |
| 3010 | 不支持的发音类型 |
| 3201 | 解密失败 |
| 3301 | 语音识别失败 |
| 3302 | 语音翻译失败 |
| 3303 | 服务的异常 |
| 3411 | 访问频率受限,请稍后访问 |
| 3412 | 超过最大请求字符数 |
| 4001 | 不支持的语音识别格式 |
| 4002 | 不支持的语音识别采样率 |
| 4003 | 不支持的语音识别声道 |
| 4004 | 不支持的语音上传类型 |
| 4005 | 不支持的语言类型 |
| 4006 | 识别音频文件过大 |
| 4007 | 识别音频时长过长 |
| 4201 | 解密失败 |
| 4301 | 语音识别失败 |
| 4303 | 服务的异常 |
| 4411 | 访问频率受限,请稍后访问 |
| 4412 | 超过最大请求时长 |
| 5001 | 无效的OCR类型 |
| 5002 | 不支持的OCR image类型 |
| 5003 | 不支持的语言类型 |
| 5004 | 识别图片过大 |
| 5005 | 不支持的图片类型 |
| 5006 | 文件为空 |
| 5201 | 解密错误,图片base64解密失败 |
| 5301 | OCR段落识别失败 |
| 5411 | 访问频率受限 |
| 5412 | 超过最大识别流量 |
| 9001 | 不支持的语音格式 |
| 9002 | 不支持的语音采样率 |
| 9003 | 不支持的语音声道 |
| 9004 | 不支持的语音上传类型 |
| 9005 | 不支持的语音识别 Language类型 |
| 9301 | ASR识别失败 |
| 9303 | 服务器内部错误 |
| 9411 | 访问频率受限(超过最大调用次数) |
| 9412 | 超过最大处理语音长度 |
| 10001 | 无效的OCR类型 |
| 10002 | 不支持的OCR image类型 |
| 10004 | 识别图片过大 |
| 10201 | 图片base64解密失败 |
| 10301 | OCR段落识别失败 |
| 10411 | 访问频率受限 |
| 10412 | 超过最大识别流量 |
| 11001 | 不支持的语音识别格式 |
| 11002 | 不支持的语音识别采样率 |
| 11003 | 不支持的语音识别声道 |
| 11004 | 不支持的语音上传类型 |
| 11005 | 不支持的语言类型 |
| 11006 | 识别音频文件过大 |
| 11007 | 识别音频时长过长,最大支持30s |
| 11201 | 解密失败 |
| 11301 | 语音识别失败 |
| 11303 | 服务的异常 |
| 11411 | 访问频率受限,请稍后访问 |
| 11412 | 超过最大请求时长 |
| 12001 | 图片尺寸过大 |
| 12002 | 图片base64解密失败 |
| 12003 | 引擎服务器返回错误 |
| 12004 | 图片为空 |
| 12005 | 不支持的识别图片类型 |
| 12006 | 图片无匹配结果 |
| 13001 | 不支持的角度类型 |
| 13002 | 不支持的文件类型 |
| 13003 | 表格识别图片过大 |
| 13004 | 文件为空 |
| 13301 | 表格识别失败 |
| 15001 | 需要图片 |
| 15002 | 图片过大(1M) |
| 15003 | 服务调用失败 |
| 17001 | 需要图片 |
| 17002 | 图片过大(1M) |
| 17003 | 识别类型未找到 |
| 17004 | 不支持的识别类型 |
| 17005 | 服务调用失败 |
| 上线日期 | 版本号 | 更新内容 |
|---|---|---|
| 2019.05.23 | v1.0.0 | 整题识别(含公式)API上线,支持识别中英文场景下的公式,返回可编辑的latex结果 |
Java 示例 整题识别(含公式) java demo