帮助与文档 > 产品文档 > 自然语言翻译服务 > API文档 > 图片翻译
图片翻译

图片翻译 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

温馨提示:

  • 本文档主要针对开发人员,接入测试前需要获取应用ID和应用密钥;如果您还没有,请按照新手指南获取。
  • 平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 图片翻译服务报价

接口说明

图片翻译API接口提供有道的图片文字识别翻译服务。您只需要通过调用图片翻译API,传入图片的Base64编码,指定源语言与目标语言,通过POST请求方式,就可以识别图片中的文字并进行翻译。

图片翻译 API HTTPS地址:

https://openapi.youdao.com/ocrtransapi

协议须知

调用方在集成文本翻译API时,请遵循以下规则。

规则描述
传输方式HTTPS
请求方式POST
字符编码统一使用UTF-8编码
请求格式表单
响应格式JSON

接口调用参数

调用API需要向接口发送以下字段来访问服务。

字段名类型含义必填备注
typetext文件上传类型True目前支持Base64,请置该字段值为1
fromtext源语言True参考下方的 支持语言 (可设置为auto)
totext目标语言True参考下方的 支持语言 (可设置为auto)
appKeytext应用IDTrue可在应用管理 查看
salttextUUIDTrueuuid,唯一通用识别码,例:1995882C5064805BC30A39829B779D7B
signtext签名Truesha256(应用ID+input+salt+curtime+应用密钥)
signTypetext签名类型Truev3
curtimetext当前UTC时间戳(秒)trueTimeStamp
exttext翻译结果音频格式,支持mp3falsemp3
qtext要识别的图片truetype为1时必填,图片的Base64编码
docTypetext服务器响应类型,目前只支持jsonfalsejson
rendertext是否需要服务端返回渲染的图片,0:否;1:是,默认是0false0

签名生成方法如下:
signType=v3;
sign=sha256(应用ID+input+salt+curtime+应用密钥);
其中,input的计算方式为:input=q前10个字符 + q长度 + q后10个字符(当q长度大于20)或 input=q字符串(当q长度小于等于20);

注意:

  1. 请先将需要识别的图片转换为 Base64 编码。
  2. 在发送HTTP请求之前需要对各字段做 URL encode。
  3. 在生成签名拼接 应用ID+q+salt+应用密钥 字符串时,q 不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的 q 做URL encode。
  4. 签名和请求有疑问,可以参考文档最后的常用语言demo。

输出结果

返回的结果是json格式,具体说明如下:

字段名字段说明
orientation图片所对应的方向
lanFromocr所识别出来认为的图片中的语言
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",
    "ext":"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

注意:若列表语言出现不支持的问题,请参考产品定价列表语种互译的限制

服务配置

支持图片格式图片大小每小时最大查询次数支持语言
jpgpngbmp2M 内(编码后)3600中(简繁)到英/日/韩/法/俄/西班牙/葡萄牙/德语的互译

错误代码列表

错误码含义
101缺少必填的参数,首先确保必填参数齐全,然后确认参数书写是否正确。
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息,
109batchLog格式不正确
110无相关服务的有效实例,应用没有绑定服务实例,可以新建服务实例,绑定服务实例。注:某些服务的翻译结果发音需要tts实例,需要在控制台创建语音合成实例绑定应用后方能使用。
111开发者账号无效
112请求服务无效
113q不能为空
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账户已经欠费停
402offlinesdk不可用
411访问频率受限,请稍后访问
412长请求过于频繁,请稍后访问
1001无效的OCR类型
1002不支持的OCR image类型
1003不支持的OCR Language类型
1004识别图片过大
1201图片base64解密失败
1301OCR段落识别失败
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解密失败
5301OCR段落识别失败
5411访问频率受限
5412超过最大识别流量
9001不支持的语音格式
9002不支持的语音采样率
9003不支持的语音声道
9004不支持的语音上传类型
9005不支持的语音识别 Language类型
9301ASR识别失败
9303服务器内部错误
9411访问频率受限(超过最大调用次数)
9412超过最大处理语音长度
10001无效的OCR类型
10002不支持的OCR image类型
10004识别图片过大
10201图片base64解密失败
10301OCR段落识别失败
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服务调用失败

常用语言 Demo

Java 示例

图片翻译 Java demo

Python3 示例

图片翻译 python3 demo

C#示例

图片翻译 C# demo

PHP1 示例

图片翻译 php demo

go 示例

图片翻译 go demo