图片翻译 API 简介
概念解释
图片翻译:基于文字识别与文本翻译技术,结合组段和渲染技术,满足用户翻译图片文字的需求,提升输入效率。
说明
Hi,您好,欢迎使用有道智云图片翻译API接口服务。
如果您想快速体验服务,建议您前往图片翻译体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成HTTP API的技术开发工程师,详细描述图片翻译能力相关的技术内容。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云翻译技术交流QQ 1群: 652880659
智云翻译技术交流QQ 2群: 669384425
智云翻译技术交流QQ 3群: 807539209
智云翻译技术交流QQ 4群: 936752411
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
接口说明
图片翻译API接口提供有道的图片文字识别翻译服务。您只需要通过调用图片翻译API,传入图片的Base64编码,指定源语言与目标语言,通过POST请求方式,就可以识别图片中的文字并进行翻译。
图片翻译 API HTTPS地址:
https://openapi.youdao.com/ocrtransapi
协议须知
调用方在集成文本翻译API时,请遵循以下规则。
规则 | 描述 |
---|---|
传输方式 | HTTPS |
请求方式 | POST |
字符编码 | 统一使用UTF-8编码 |
请求格式 | 表单 |
响应格式 | JSON |
接口调用参数
调用API需要向接口发送以下字段来访问服务。
字段名 | 类型 | 含义 | 必填 | 备注 |
---|---|---|---|---|
type | text | 文件上传类型 | True | 目前支持Base64,请置该字段值为1 |
from | text | 源语言 | True | 参考下方的 支持语言 (可设置为auto) |
to | text | 目标语言 | True | 参考下方的 支持语言 (可设置为auto) |
appKey | text | 应用ID | True | 可在应用管理 查看 |
salt | text | UUID | True | uuid,唯一通用识别码,例:1995882C5064805BC30A39829B779D7B |
sign | text | 签名 | True | sha256(应用ID+input+salt+curtime+应用密钥) |
signType | text | 签名类型 | True | v3 |
curtime | text | 当前UTC时间戳(秒) | true | TimeStamp |
ext | text | 翻译结果音频格式,支持mp3 | false | mp3 |
q | text | 要识别的图片 | true | type为1时必填,图片的Base64编码 |
docType | text | 服务器响应类型,目前只支持json | false | json |
render | text | 是否需要服务端返回渲染的图片,0:否;1:是,默认是0 | false | 0 |
签名生成方法如下:
signType=v3;
sign=sha256(应用ID
+input
+salt
+curtime
+应用密钥
);
其中,input的计算方式为:input
=q前10个字符
+q长度
+q后10个字符
(当q长度大于20)或input
=q字符串
(当q长度小于等于20);
注意:
- 请先将需要识别的图片转换为 Base64 编码。
- 在发送HTTP请求之前需要对各字段做 URL encode。
- 在生成签名拼接
应用ID+q+salt+应用密钥
字符串时,q
不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的q
做URL encode。 - 签名和请求有疑问,可以参考文档最后的常用语言demo。
输出结果
返回的结果是json格式,具体说明如下:
字段名 | 字段说明 |
---|---|
orientation | 图片所对应的方向 |
lanFrom | ocr所识别出来认为的图片中的语言 |
textAngle | 图片的倾斜角度 |
errorCode | 错误码 |
lanTo | 目标语言 |
resRegions | 图片翻译的具体内容 |
-boundingBox | 区域范围,四个值: 左上角的x值,左上角的y值,区域的的宽,区域的高 例如:134,0,1066,249 |
-linesCount | 行数(用于前端排版) |
-lineheight | 行高 |
-context | 该区域的原文 |
-linespace | 行间距 |
-tranContent | 翻译结果 |
-lines | 当render=1即返回渲染图片,返回结果lines |
-color | 图片颜色(默认字段,暂不支持修改) |
-words | 字数组,当render=1即返回渲染图片 |
-text | 行识别结果,当render=1即返回渲染图片 |
-word | 识别的字的结果,当render=1即返回渲染图片 |
-textHeight | 文字的高度,当render=1即返回渲染图片 |
注:resRegions是一个json列表,表示图中多个区域对应的翻译结果,每个json中有6个参数:boundingBox、linesCount、lineheight、context、linespace、tranContent。
示例
发送请求,调用接口:
{
"type":"1",
"q":"BASE64", //要翻译的图片BASE 64编码
"from":"en",
"to":"zh-CHS",
"appKey":"test",
"salt":"1995882C5064805BC30A39829B779D7B",
"sign":"f9976efca9dd9e280d4c6637230da5d94c2df6e520605db5a5a4d1d91ba45761",
"signType":"v3",
"docType":"json"
}
返回结果:
{
"orientation": "Up",
"lanFrom": "en",
"textAngle": "0.0",
"errorCode": "0",
"lanTo": "zh-CHS",
"resRegions": [{
"boundingBox": "134,0,1066,249",
"linesCount": 7,
"lineheight": 28,
"context": " There are two ways to cope with the problem in government. One (dis cussed in the preceding chapter) is to supply the service or product in a marketlike environment. Shift the burden of evaluation off the shoulders of professional evaluators and onto the shoulders of clients and customers, and let the latter vote with their feet. The \"client\" in these cases can be individual citizens or government agencies; what is important is that the client be able to choose from among rival suppliers.",
"linespace": 7,
"tranContent": "有两种方法可以解决政府的问题。一个(在前一章中讨论的)是在一个市场环境中提供服务或产品。将评估的负担从专业评估人员的肩膀上转移到客户和客户的肩上,让后者用脚投票。这些案件的“委托人”可以是公民个人或政府机构;重要的是客户可以从竞争对手那里选择。"
}, {
"boundingBox": "116,253,1100,354",
"linesCount": 10,
"lineheight": 28,
"context": " But some public services cannot be supplied, or arc never going to be sup plied, by a market. We can imagine allowing parents to choose among schools but we cannot imagine letting them choose (at least for most purposes) among police departments or armies. In that case one should adopt the second way of evaluating a public service: carry out a demonstration project or conduct a field experiment. (I will use the two ideas interchangeably, though some schol ars distinguish between them.7) An experiment is a planned alteration in a state of affairs designed to measure the effect of the intervention. It involves asking the question, \"If I change X, what will happen to Y, having first made certain that everything else stays the same?\" It sounds easy, but it is not.",
"linespace": 5,
"tranContent": "但是一些公共服务不能提供,或者不能被市场所垄断。我们可以想象允许父母在学校里选择,但我们无法想象让他们在警察部门或军队中选择(至少是在大多数情况下)。在这种情况下,应该采用第二种评价公共服务的方法:进行示范项目或进行现场试验。(我将把这两种观点交替使用,尽管有些学校将两者区分开来。)实验是一种计划中的改变,旨在衡量干预的效果。它涉及到问这个问题,“如果我改变X, Y会发生什么,首先确定其他一切都保持不变?”这听起来很容易,但事实并非如此。"
}, {
"boundingBox": "101,609,1141,152",
"linesCount": 4,
"lineheight": 28,
"context": " A good experiment (bad ones are worse than no experiment at all) requires that one do the following: First, identify a course of action to be test ed; call it the treatment. A \"treatment\" can be a police tactic, a school cur riculum, or a welfare program. Second, decide what impact the treatment is",
"linespace": 5,
"tranContent": "一个好的实验(坏的实验比没有实验更糟糕)需要一个人做以下的事情:首先,确定要测试的行动过程;叫它治疗。“治疗”可以是警察的策略,也可以是学校里的,或者是福利项目。其次,确定治疗的影响。"
}]
}
支持语言
下表为各语言对应代码:
英文名 | 中文名 | 代码 | |
---|---|---|---|
Arabic | 阿拉伯语 | ar | |
German | 德语 | de | |
English | 英语 | en | |
Spanish | 西班牙语 | es | |
French | 法语 | fr | |
Hindi | 印地语 | hi | |
Indonesian | 印度尼西亚语 | id | |
Italian | 意大利语 | it | |
Japanese | 日语 | ja | |
Korean | 韩语 | ko | |
Dutch | 荷兰语 | nl | |
Portuguese | 葡萄牙语 | pt | |
Russian | 俄语 | ru | |
Thai | 泰语 | th | |
Vietnamese | 越南语 | vi | |
中文 | zh-CHS | ||
中文繁体 | zh-CHT | ||
Afrikaans | 南非荷兰语 | af | |
Azeerbaijani | 阿塞拜疆语 | az | |
Belarusian | 白俄罗斯语 | be | |
Bulgarian | 保加利亚语 | bg | |
Bangla | 孟加拉语 | bn | |
Bosnian (Latin) | 波斯尼亚语 | bs | |
Catalan | 加泰隆语 | ca | |
Cebuano | 宿务语 | ceb | |
Corsican | 科西嘉语 | co | |
Czech | 捷克语 | cs | |
Welsh | 威尔士语 | cy | |
Danish | 丹麦语 | da | |
Greek | 希腊语 | el | |
Esperanto | 世界语 | eo | |
Estonian | 爱沙尼亚语 | et | |
Basque | 巴斯克语 | eu | |
Persian | 波斯语 | fa | |
Finnish | 芬兰语 | fi | |
Frisian | 弗里西语 | fy | |
Irish | 爱尔兰语 | ga | |
Scots | 苏格兰盖尔语 | gd | |
Galician | 加利西亚语 | gl | |
Gujarati | 古吉拉特语 | gu | |
Hausa | 豪萨语 | ha | |
Hawaiian | 夏威夷语 | haw | |
Hebrew | 希伯来语 | he | |
Croatian | 克罗地亚语 | hr | |
Haitian | 海地克里奥尔语 | ht | |
Hungarian | 匈牙利语 | hu | |
Armenian | 亚美尼亚语 | hy | |
Igbo | 伊博语 | ig | |
Icelandic | 冰岛语 | is | |
Javanese | 爪哇语 | jw | |
Georgian | 格鲁吉亚语 | ka | |
Kazakh | 哈萨克语 | kk | |
Khmer | 高棉语 | km | |
Kannada | 卡纳达语 | kn | |
Kurdish | 库尔德语 | ku | |
Kyrgyz | 柯尔克孜语 | ky | |
Latin | 拉丁语 | la | |
Luxembourgish | 卢森堡语 | lb | |
Lao | 老挝语 | lo | |
Lithuanian | 立陶宛语 | lt | |
Latvian | 拉脱维亚语 | lv | |
Malagasy | 马尔加什语 | mg | |
Maori | 毛利语 | mi | |
Macedonian | 马其顿语 | mk | |
Malayalam | 马拉雅拉姆语 | ml | |
Mongolian | 蒙古语 | mn | |
Marathi | 马拉地语 | mr | |
Malay | 马来语 | ms | |
Maltese | 马耳他语 | mt | |
Myanmar (Burmese) | 缅甸语 | my | |
Nepali | 尼泊尔语 | ne | |
Norwegian | 挪威语 | no | |
Nyanja (Chichewa) | 齐切瓦语 | ny | |
Punjabi | 旁遮普语 | pa | |
Polish | 波兰语 | pl | |
Pashto | 普什图语 | ps | |
Romanian | 罗马尼亚语 | ro | |
Sindhi | 信德语 | sd | |
Sinhala (Sinhalese) | 僧伽罗语 | si | |
Slovak | 斯洛伐克语 | sk | |
Slovenian | 斯洛文尼亚语 | sl | |
Samoan | 萨摩亚语 | sm | |
Shona | 修纳语 | sn | |
Somali | 索马里语 | so | |
Albanian | 阿尔巴尼亚语 | sq | |
Serbian (Cyrillic) | 塞尔维亚语(西里尔文) | sr-Cyrl | |
Serbian (Latin) | 塞尔维亚语(拉丁文) | sr-Latn | |
Sesotho | 塞索托语 | st | |
Sundanese | 巽他语 | su | |
Swedish | 瑞典语 | sv | |
Kiswahili | 斯瓦希里语 | sw | |
Tamil | 泰米尔语 | ta | |
Telugu | 泰卢固语 | te | |
Tajik | 塔吉克语 | tg | |
Filipino | 菲律宾语 | tl | |
Turkish | 土耳其语 | tr | |
Ukrainian | 乌克兰语 | uk | |
Urdu | 乌尔都语 | ur | |
Uzbek | 乌兹别克语 | uz | |
Yiddish | 意第绪语 | yi | |
Yoruba | 约鲁巴语 | yo | |
Cantonese (Traditional) | 粤语 | yue | |
Zulu | 南非祖鲁语 | zu | |
自动识别 | auto |
注意:若列表语言出现不支持的问题,请参考产品定价列表语种互译的限制
服务配置
支持图片格式 | 图片大小 | 每小时最大查询次数 | 支持语言 |
---|---|---|---|
jpgpngbmp | 2M 内(编码后) | 3600 | 中(简繁)到英/日/韩/法/俄/西班牙/葡萄牙/德语的互译 |
错误代码列表
错误码 | 含义 |
---|---|
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,一般是编码问题。请确保翻译文本 q 为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 | 服务调用失败 |