帮助与文档 > 产品文档 > 自然语言翻译 > API 文档

有道智云翻译 API 说明文档

有道智云翻译 API 简介

有道翻译API接口提供有道的翻译服务,包含了中英翻译和小语种翻译功能。您只需要通过调用有道翻译API,传入待翻译的内容,并指定要翻译的源语言(支持源语言语种自动检测)和目标语言种类,就可以得到相应的翻译结果。

有道翻译API HTTP地址:

http://openapi.youdao.com/api

有道翻译API HTTPS地址:

https://openapi.youdao.com/api

接口调用参数

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

字段名类型含义必填备注
qtext要翻译的文本True必须是UTF-8编码
fromtext源语言True语言列表 (可设置为auto)
totext目标语言True语言列表 (可设置为auto)
appKeytext应用 IDTrue可在 应用管理 查看
salttext随机数True
signtext签名,通过md5(appKey+q+salt+应用密钥)生成TrueappKey+q+salt+应用密钥的MD5值
ext翻译结果音频格式,支持mp3falsemp3
voice翻译结果发音选择,0为女声,1为男声,默认为女声false0

注:

1.voice 没有男声的,会输出女声。

2.发音需要在控制台创建tts实例,并绑定应用才能使用,否则点击发音会报110错误。

签名生成方法如下:

  1. 将请求参数中的 appKey,翻译文本 q (注意为UTF-8编码),随机数 salt密钥 (应用密钥可在 应用管理点击应用名称到应用详情页 查看), 按照 appKey+q+salt+密钥 的顺序拼接得到字符串 str
  2. 对字符串 str 做md5,得到32位大写的 sign (参考Java生成MD5示例)

注意:

  1. 请先将需要翻译的文本转换为 UTF-8 编码
  2. 在发送 HTTP 请求之前需要对各字段做 URL encode。
  3. 在生成签名拼接 appKey+q+salt+密钥 字符串时,q 不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的待翻译文本字段 q 做 URL encode。

输出结果

返回的结果是json格式,包含字段与FROM和TO的值有关,具体说明如下:

字段名类型含义备注
errorCodetext错误返回码一定存在
querytext源语言查询正确时,一定存在
translationtext翻译结果查询正确时一定存在
basictext词义基本词典,查词时才有
webtext词义网络释义,该结果不一定存在
ltext源语言和目标语言一定存在
dicttext词典deeplink查询语种为支持语言时,存在
webdicttextwebdeeplink查询语种为支持语言时,存在
tSpeakUrltext翻译结果发音地址翻译成功一定存在
speakUrltext源语言发音地址翻译成功一定存在

注:

a.英文查词的basic字段中又包含以下字段,词典发音适合词典发音场景,且价格只为通用发音的十分之一。

字段含义
us-phonetic美式音标,英文查词成功,一定存在
phonetic默认音标,默认是英式音标,英文查词成功,一定存在
uk-phonetic英式音标,英文查词成功,一定存在
uk-speech英式发音,英文查词成功,一定存在
us-speech美式发音,英文查词成功,一定存在
explains基本释义

b.中文查词的basic字段只包含explains字段。

示例

使用good单词查询作为参考说明json返回结果:

http://openapi.youdao.com/api?q=good&from=EN&to=zh_CHS&appKey=ff889495-4b45-46d9-8f48-946554334f2a&salt=2&sign=1995882C5064805BC30A39829B779D7B

输出结果与FROM和TO的值有关:

  1. 当FROM和TO的值都在{zh-CHS, EN}范围内时
{
  "errorCode":"0",
  "query":"good", //查询正确时,一定存在
  "translation": [ //查询正确时一定存在
      "好"
  ],
  "basic":{ // 有道词典-基本词典,查词时才有
      "phonetic":"gʊd"
      "uk-phonetic":"gʊd" //英式音标
      "us-phonetic":"ɡʊd" //美式音标
      "uk-speech": "XXXX",//英式发音
      "us-speech": "XXXX",//美式发音
      "explains":[
          "好处",
          "好的"
          "好"
      ]
  },
  "web":[ // 有道词典-网络释义,该结果不一定存在
      {
          "key":"good",
          "value":["良好","善","美好"]
      },
      {...}
  ]
  ],
  "dict":{
      "url":"yddict://m.youdao.com/dict?le=eng&q=good"
  },
  "webdict":{
      "url":"http://m.youdao.com/dict?le=eng&q=good"
  },
  "l":"EN2zh-CHS",
  "tSpeakUrl":"XXX",//翻译后的发音地址
  "speakUrl": "XXX" //查询文本的发音地址
}
  1. 当FROM和TO的值有在{zh-CHS, EN}范围外的时候
{
   "errorCode": "0",
   "translation": ["大丈夫です"] //小语种翻译,一定存在
   "dict":{
       "url":"yddict://m.youdao.com/dict?le=jap&q=%E6%B2%A1%E5%85%B3%E7%B3%BB%E3%80%82"
   },
   "webdict":{
       "url":"http://m.youdao.com/dict?le=jap&q=%E6%B2%A1%E5%85%B3%E7%B3%BB%E3%80%82"
   },
   "l":"zh-CHS2ja",
   "tSpeakUrl":"XXX",//翻译后的发音地址
   "speakUrl": "XXX" //查询文本的发音地址
}

支持的语言表

语言代码
中文zh-CHS
日文ja
英文EN
韩文ko
法文fr
俄文ru
葡萄牙文pt
西班牙文es
越南文vi
德文de
阿拉伯文ar
印尼文id

错误代码列表

错误码含义
101缺少必填的参数,出现这个情况还可能是et的值和实际加密方式不对应
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号无效
113q不能为空
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
205请求的接口与选择的接入方式不一致
301辞典查询失败
302翻译查询失败
303服务端的其它异常
401账户已经欠费
411访问频率受限,请稍后访问
2005ext参数不对
2006不支持的voice

常见问题及注意事项

  • 点击发音,返回110

发音需要tts实例,需要在控制台创建语音合成实例绑定应用后方能使用。

  • 返回110

应用没有绑定服务实例,可以新建服务实例,绑定服务实例。

  • 返回108

appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)

  • 返回101

首先确保必填参数齐全,然后,确认参数书写是否正确。

  • 返回202

如果确认 appKeyappSecret 的正确性,仍返回202,一般是编码问题。请确保 q 为UTF-8编码.

  • 返回205

确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。

常用语言 Demo

Java 示例
Python 示例
C# 示例
PHP 示例
JS 示例
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;


public class Demo {

    public static void main(String[] args) throws Exception {
        String appKey ="您的应用ID";
        String query = "你好";
        String salt = String.valueOf(System.currentTimeMillis());
        String from = "zh-CHS";
        String to = "EN";
        String sign = md5(appKey + query + salt+ "您的密钥");
        Map params = new HashMap();
        params.put("q", query);
        params.put("from", from);
        params.put("to", to);
        params.put("sign", sign);
        params.put("salt", salt);
        params.put("appKey", appKey);
        System.out.println(requestForHttp("http://openapi.youdao.com/api", params));
    }

    public static String requestForHttp(String url,Map requestParams) throws Exception{
        String result = null;
        CloseableHttpClient httpClient = HttpClients.createDefault();
        /**HttpPost*/
        HttpPost httpPost = new HttpPost(url);
        System.out.println(new JSONObject(requestParams).toString());
        List params = new ArrayList();
        Iterator> it = requestParams.entrySet().iterator();
        while (it.hasNext()) {
            Entry en = it.next();
            String key = en.getKey();
            String value = en.getValue();
            if (value != null) {
                params.add(new BasicNameValuePair(key, value));
            }
        }
        httpPost.setEntity(new UrlEncodedFormEntity(params,"UTF-8"));
        /**HttpResponse*/
        CloseableHttpResponse httpResponse = httpClient.execute(httpPost);
        try{
            HttpEntity httpEntity = httpResponse.getEntity();
            result = EntityUtils.toString(httpEntity, "utf-8");
            EntityUtils.consume(httpEntity);
        }finally{
            try{
                if(httpResponse!=null){
                    httpResponse.close();
                }
            }catch(IOException e){
                e.printStackTrace();
            }
        }
        return result;
    }

    /**
     * 生成32位MD5摘要
     * @param string
     * @return
     */
    public static String md5(String string) {
        if(string == null){
            return null;
        }
        char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
                'A', 'B', 'C', 'D', 'E', 'F'};

        try{
            byte[] btInput = string.getBytes("utf-8");
            /** 获得MD5摘要算法的 MessageDigest 对象 */
            MessageDigest mdInst = MessageDigest.getInstance("MD5");
            /** 使用指定的字节更新摘要 */
            mdInst.update(btInput);
            /** 获得密文 */
            byte[] md = mdInst.digest();
            /** 把密文转换成十六进制的字符串形式 */
            int j = md.length;
            char str[] = new char[j * 2];
            int k = 0;
            for (byte byte0 : md) {
                str[k++] = hexDigits[byte0 >>> 4 & 0xf];
                str[k++] = hexDigits[byte0 & 0xf];
            }
            return new String(str);
        }catch(NoSuchAlgorithmException | UnsupportedEncodingException e){
            return null;
        }
    }

    /**
     * 根据api地址和参数生成请求URL
     * @param url
     * @param params
     * @return
     */
    public static String getUrlWithQueryString(String url, Map params) {
        if (params == null) {
            return url;
        }

        StringBuilder builder = new StringBuilder(url);
        if (url.contains("?")) {
            builder.append("&");
        } else {
            builder.append("?");
        }

        int i = 0;
        for (String key : params.keySet()) {
            String value = params.get(key);
            if (value == null) { // 过滤空的key
                continue;
            }

            if (i != 0) {
                builder.append('&');
            }

            builder.append(key);
            builder.append('=');
            builder.append(encode(value));

            i++;
        }

        return builder.toString();
    }
    /**
     * 进行URL编码
     * @param input
     * @return
     */
    public static String encode(String input) {
        if (input == null) {
            return "";
        }

        try {
            return URLEncoder.encode(input, "utf-8");
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        return input;
    }
}
				
#/usr/bin/env python
#coding=utf8
 
import httplib
import md5
import urllib
import random

appKey = '你的appkey'
secretKey = '您的应用密钥'

 
httpClient = None
myurl = '/api'
q = 'good'
fromLang = 'EN'
toLang = 'zh-CHS'
salt = random.randint(1, 65536)

sign = appKey+q+str(salt)+secretKey
m1 = md5.new()
m1.update(sign)
sign = m1.hexdigest()
myurl = myurl+'?appKey='+appKey+'&q='+urllib.quote(q)+'&from='+fromLang+'&to='+toLang+'&salt='+str(salt)+'&sign='+sign
 
try:
    httpClient = httplib.HTTPConnection('openapi.youdao.com')
    httpClient.request('GET', myurl)
 
    #response是HTTPResponse对象
    response = httpClient.getresponse()
    print response.read()
except Exception, e:
    print e
finally:
    if httpClient:
        httpClient.close()
				
using System;
using System.Web;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleApplication2
{
    using System;
    using System.Collections.Specialized;
    using System.IO;
    using System.Net;
    using System.Text;
    using System.Web;
    using System.Security.Cryptography;

    class Test
    {
        
        public static void Main() {

        string q = "好";
        string appKey="您的应用ID";
        string from = "zh-CHS";
        string to = "en";
        string salt = DateTime.Now.Millisecond.ToString();
        string appSecret = "您的应用密钥";
        MD5 md5 = new MD5CryptoServiceProvider();
        string md5Str = appKey + q + salt + appSecret;
        byte[] output = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(md5Str));
        string sign = BitConverter.ToString(output).Replace("-","");
        
        string url = string.Format("http://openapi.youdao.com/api?appKey={0}&q={1}&from={2}&to={3}&sign={4}&salt={5}", appKey, System.Web.HttpUtility.UrlDecode(q, System.Text.Encoding.GetEncoding("UTF-8")), from, to, sign, salt);
        WebRequest translationWebRequest = WebRequest.Create(url);

        WebResponse response = null;

        response = translationWebRequest.GetResponse();
        Stream stream = response.GetResponseStream();

        Encoding encode = Encoding.GetEncoding("utf-8");

        StreamReader reader = new StreamReader(stream, encode);
        string result = reader.ReadToEnd();
        Console.WriteLine(result);
        
    }


    }
}
				
<?php
define("CURL_TIMEOUT",   20); 
define("URL",            "http://openapi.youdao.com/api"); 
define("APP_KEY",         "your app key"); //替换为您的应用ID
define("SEC_KEY",        "your app secret");//替换为您的密钥

//翻译入口
function translate($query, $from, $to)
{
    $args = array(
        'q' => $query,
        'appKey' => APP_KEY,
        'salt' => rand(10000,99999),
        'from' => $from,
        'to' => $to,

    );
    $args['sign'] = buildSign(APP_KEY, $query, $args['salt'], SEC_KEY);
    $ret = call(URL, $args);
    echo $ret;
    $ret = json_decode($ret, true);
    return $ret; 
}

//加密
function buildSign($appKey, $query, $salt, $secKey)
{/*{{{*/
    $str = $appKey . $query . $salt . $secKey;
    $ret = md5($str);
    return $ret;
}/*}}}*/

//发起网络请求
function call($url, $args=null, $method="post", $testflag = 0, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
    $ret = false;
    $i = 0; 
    while($ret === false) 
    {
        if($i > 1)
            break;
        if($i > 0) 
        {
            sleep(1);
        }
        $ret = callOnce($url, $args, $method, false, $timeout, $headers);
        $i++;
    }
    return $ret;
}/*}}}*/

function callOnce($url, $args=null, $method="post", $withCookie = false, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
    $ch = curl_init();
    if($method == "post") 
    {
        $data = convert($args);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_POST, 1);
    }
    else 
    {
        $data = convert($args);
        if($data) 
        {
            if(stripos($url, "?") > 0) 
            {
                $url .= "&$data";
            }
            else 
            {
                $url .= "?$data";
            }
        }
    }
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    if(!empty($headers)) 
    {
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    }
    if($withCookie)
    {
        curl_setopt($ch, CURLOPT_COOKIEJAR, $_COOKIE);
    }
    $r = curl_exec($ch);
    curl_close($ch);
    return $r;
}/*}}}*/

function convert(&$args)
{/*{{{*/
    $data = '';
    if (is_array($args))
    {
        foreach ($args as $key=>$val)
        {
            if (is_array($val))
            {
                foreach ($val as $k=>$v)
                {
                    $data .= $key.'['.$k.']='.rawurlencode($v).'&';
                }
            }
            else
            {
                $data .="$key=".rawurlencode($val)."&";
            }
        }
        return trim($data, "&");
    }
    return $args;
}/*}}}*/

//调用翻译
translate("good","EN","zh-CHS");
?>


				

<!doctype html>
<head>
    <meta charset="utf-8"/>
</head>
<body>
<div>可打开浏览器控制台查看结果</div>
<script src="http://shared.ydstatic.com/js/jquery/jquery-3.1.1.min.js"></script>
<script src="https://cdn.bootcss.com/blueimp-md5/2.10.0/js/md5.js"></script>
<script type="text/javascript">
var appKey = '您的应用ID';
var key = '您的应用密钥';//注意:暴露appSecret,有被盗用造成损失的风险
var salt = (new Date).getTime();
var query = '你好';
// 多个query可以用\n连接  如 query='apple\norange\nbanana\npear'
var from = '';
var to = 'en';
var str1 = appKey + query + salt +key;
var sign = md5(str1);
$.ajax({
    url: 'http://openapi.youdao.com/api',
    type: 'post',
    dataType: 'jsonp',
    data: {
        q: query,
        appKey: appKey,
        salt: salt,
        from: from,
        to: to,
        sign: sign
    },
    success: function (data) {
        console.log(data);
    } 
});

</script>
</body>

有道智云语音翻译 API 说明文档

有道智云语音翻译 API 简介

有道语音翻译API接口提供有道的语音翻译服务,包含了中文和其他有道自有语种的互译功能。您只需要通过调用有道语音翻译API,传入待翻译的音频文件,并指定要翻译的源语言(支持源语言语种自动检测)和目标语言种类,以POST方式请求就可以得到相应的翻译结果。

上传的文件时长不能超过15s,文件大小不能超过2M。

有道语音翻译API HTTP地址:

http://openapi.youdao.com/speechtransapi

有道语音翻译API HTTPS地址:

https://openapi.youdao.com/speechtransapi

接口调用参数

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

字段名类型含义必填备注
qtext要翻译的音频文件的base64编码字符串True必须是Base64编码
fromtext源语言True语言列表
totext目标语言True语言列表
appKeytext应用 IDTrue可在 应用管理 查看
salttext随机数True
signtext签名,通过md5(appKey+q+salt+密钥)生成TrueappKey+q+salt+密钥的MD5值
formattext语音文件的格式, 目前只支持wav,不区分大小写truewav
ratetext采样率, 8000 或者 16000, 推荐 16000 采用率true8000
channeltext声道数, 仅支持单声道,请填写固定值1true1
typetext上传类型, 仅支持base64上传,请填写固定值1true1
exttext翻译结果音频格式,支持mp3,默认mp3falsemp3
voicetext翻译结果发音选择,0为女声,1为男声,默认为女声false0

签名生成方法如下:

  1. 将请求参数中的 appKey,翻译文本 q (注意为UTF-8编码),随机数 salt密钥 (密钥可在 应用管理 查看), 按照 appKey+q+salt+密钥 的顺序拼接得到字符串 str
  2. 对字符串 str 做md5,得到32位大写的 sign (参考Java生成MD5示例)

注意:

  1. 请先将需要翻译的音频文件转换为 Base64 编码
  2. 在发送 HTTP 请求之前需要对各字段做 URL encode。
  3. 在生成签名拼接 appKey+q+salt+密钥 字符串时,q 不需要做 URL encode,在生成签名之后,发送 HTTP 请求之前才需要对要发送的待翻译文本字段 q 做 URL encode。

输出结果

返回的结果是json格式,包含字段与FROM和TO的值有关,具体说明如下:

字段含义
tSpeakUrl翻译结果发音地址,翻译成功一定存在
errorCode翻译结果错误码,一定存在
query源语言文本,翻译成功一定存在
translation翻译结果,翻译成功一定存在
dict词典deeplink
webdict词典web deeplink
speakUrl源语言发音地址,翻译成功一定存在

示例

使用good单词查询作为参考说明json返回结果:

{
    "q":"xxx"    //xxx为音频的base64编码
    "salt":123
    "docType":"json"
    "format":"wav"
    "channel":1
    "sign":"ACE8373C54C82A9C793A480B55138F3E"
    "type":1
    "version":"v1"
    "rate":16000
    "signType":"v1"
    "appKey":"test"
    "from":"zh-CHS"
    "to":"en"
}

输出结果与FROM和TO的值有关:

如果源语言和目标语言一致,返回识别结果

否则,返回如下结果:

{
    "tSpeakUrl": "https://openapi.youdao.com/ttsapi?q=%E5%8C%97%E4%BA%AC%E7%A7%91%E6%8A%80%E9%A6%86&langType=en&sign=40133A29285AD7F85D62DC9EBFE36955&salt=1512458805233&appKey=zhudytest123",    //翻译结果发音地址,翻译成功一定存在
    "query": "北京科技馆",    //识别结果,翻译成功一定存在
    "translation": [
        "Beijing science and technology museum"
    ],    //翻译结果
    "errorCode": "0",    //错误码。一定存在
    "dict": {
        "url": "yddict://m.youdao.com/dict?le=eng&q=%E5%8C%97%E4%BA%AC%E7%A7%91%E6%8A%80%E9%A6%86"
    },    //词典deeplink
    "webdict": {
        "url": "http://m.youdao.com/dict?le=eng&q=%E5%8C%97%E4%BA%AC%E7%A7%91%E6%8A%80%E9%A6%86"
    },    //webdict deeplink
    "speakUrl": "https://openapi.youdao.com/ttsapi?q=%E5%8C%97%E4%BA%AC%E7%A7%91%E6%8A%80%E9%A6%86&langType=zh-CHS&sign=25FA4EFF0F453867B8D5EAD9C0EF5D07&salt=1512458805232&appKey=zhudytest123"    //源语言发音地址
}

支持的语言表

支持中文和其他几种语言的互译。

语言代码
中文zh-CHS
日文ja
英文EN
韩文ko
法文fr
俄文ru
葡萄牙文pt
西班牙文es

语音支持

格式支持:mp3(不压缩、pcm编码)。

采样率:8k或者16k。推荐16k。

编码:16bit位深的单声道

格式代码
mp3mp3

错误代码列表

错误码含义
101缺少必填的参数,出现这个情况还可能是et的值和实际加密方式不对应
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号无效
113q不能为空
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
205请求的接口与选择的接入方式不一致
301辞典查询失败
302翻译查询失败
303服务端的其它异常
401账户已经欠费
402offlinesdk不可用
411访问频率受限,请稍后访问
412超过最大请求字符数
3001不支持的语音格式
3002不支持的语音采样率
3003不支持的语音声道
3004不支持的语音上传类型
3005不支持的语言类型
3006不支持的识别类型
3007识别音频文件过大
3008识别音频时长过长
3009不支持的音频文件类型
3010不支持的发音类型
3201解密失败
3301语音识别失败
3302语音翻译失败
3303服务的异常
3411访问频率受限,请稍后访问
3412超过最大请求字符数

常见问题及注意事项

  • 返回110

应用没有绑定服务实例,可以新建服务实例,绑定服务实例。

  • 返回108

appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)

  • 返回101

首先确保必填参数齐全,然后,确认参数书写是否正确。

  • 返回202

如果确认 appKeyappSecret 的正确性,仍返回202,一般是编码问题。请确保 q 为UTF-8编码.

  • 返回205

确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。

音频转换

本部分描述如何把其他格式的音频转成符合语音识别输入要求的格式文件。

语音识别底层使用的是pcm格式,因此推荐使用pcm格式音频。音频格式转换推荐使用ffmpeg

ffmpeg简介

ffmpeg是一个自由软件,可以运行音频、视频多种格式的录影、转换、流功能,包含libavcodec--这是一个用于多个项目中的音频、视频的解码器库,以及libavformat--一个音频和视频格式转换库。

ffmpeg官网:https://www.ffmpeg.org/

ffmpeg的github地址:https://github.com/FFmpeg/FFmpeg

ffmpeg编译参数

ffmpeg默认支持wav(pcm编码)格式,额外的编译参数如下:

—enable-libopencore-amrnb 支持amr-nb(8000 采样率) 读写

—enable-libopencore-amrwb 支持amr-wb(16000 采样率) 读取

—enable-libvo-amrwbenc 支持amr-wb(16000 采样率) 写入

—enable-libmp3lame 支持mp3 写入

ffmpeg -codecs 可以查看所有的格式:

    D..... = Decoding supported  # 读取
     .E.... = Encoding supported  # 写入
    ..A... = Audio codec      # 音频编码
    ....L. = Lossy compression # 有损
    .....S = Lossless compression # 无损
    DEA..S pcm_s16le            PCM signed 16-bit little-endian
    DEA.LS wavpack              WavPack
    DEA.L. mp3  MP3 (MPEG audio layer 3)
    DEA.L. amr_nb       AMR-NB (Adaptive Multi-Rate NarrowBand)
    DEA.L. amr_wb       AMR-WB (Adaptive Multi-Rate WideBand)

主要参数

-i 设定输入流

-f 设定格式

-ss 开始时间

wav、mp3、amr格式都自带头部,包含采样率、编码、多声道等信息。而pcm为原始音频信息,没有头部信息。wav(pcm编码)就是pcm文件加了wav的头部信息。

输入wav、mp3、amr:

-i audio.wav/audio.mp3/audio.amr

输入pcm格式:pcm需要额外告知编码格式,采样率,单声道信息

-f s16le -ac 1 -ar 16000 -i 16k.pcm    //单声道、16000采样率、16bits编码的pcm文件

音频参数

-ar 设定采样率

-ac 设定声音的channel数

-acodec 设定声音编解码器,未设定时则使用与输入流相同的编解码器

-an 不处理音频

-ab 设置比特率(单位:bit/s,也许老版是kb/s),前面ac设置为立体声时要以一半的比特率来设置,比如192kbps的就设置为96,转换默认比特率都较小,转换默认比特率都较小,要听到高品质声音的话建议设到160kbps(80)以上。

在原始采样率 大于或者接近16000的时候,推荐使用16000,8000采样率会降低识别效果。

输出wav和amr时,如果没有指定声音编解码器,则会选择默认的编码器。

输出pcm:

-f s16le -ac 1 -ar 16000 16k.pcm  // 单声道 16000 采样率 16bits编码 pcm文件

输出wav:

-ar 1 -ar 16000 16k.wav //单声道 16000 采样率 16bits编码 pcm编码的wav文件

amr-nb:全称是:Adaptive Multi-Rate,自适应多速率,是一种音频编码文件格式,专用于有效地压缩语音频率。amr-nb格式只能选 8000采样率。bit rates越高音质越好,但是文件越大

bit rates 4.75k, 5.15k, 5.9k, 6.7k, 7.4k, 7.95k, 10.2k or 12.2k

输出 amr-wb 格式,采样率 16000。 bit rates越高音质越好,但是文件越大。

6600 8850 12650 14250 15850 18250 19850 23050 23850

常用参数

-y 覆盖同名文件

-v 日志输出 基本如-v ERROR -v quiet等

转换命令示例

ffmpeg {常用参数} {输入音频参数} {输出音频参数}

wav 文件转 16k 16bits 位深的单声道pcm文件

ffmpeg -y  -i 16k.wav  -acodec pcm_s16le -f s16le -ac 1 -ar 16000 16k.pcm

pcm文件转wav:

ffmpeg -y -f s16le -ar 16000 -ac 1 -acodec pcm_s16le 16k.pcm 16k.wav

m4a文件转16k 16bits 位深的单声道pcm文件

D:\ffmpeg\bin>ffmpeg -y -i test.m4a -acodec pcm_s16le -f s16le -ac 1 -ar 1600
    0 16k.pcm

PCM文件音频介绍

pcm保存的是未压缩的音频信息,没有头文件。

16bits编码是指每次采样信息用2个字节保存。

16000采样率,是指1秒采样16000次,常见的音频是44100HZ,即一秒采样44100次。

单声道: 只有一个声道。

根据这些信息,可以得出:

1ms的16采样率音频文件大小是 2*16 = 32字节 。

1ms的8采样率音频文件大小是 2*8 = 16字节,由此即可得到音频的长度。

常用语言 Demo

Java 示例
Python 示例
C# 示例
PHP 示例
package outfox.ead.openapi.speech;

import com.sun.org.apache.xml.internal.security.utils.Base64;
import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class SpeechTransDemo {
    public static void main(String args[]) throws IOException {
        /** openapiurl */
        String url = "http://openapi.youdao.com/speechtransapi";
        /** 请求参数 */
        Map<String,String> requestParams = new HashMap<String, String>();

        /** 应用参数部分 */
        /** 您的应用ID */
        String appKey = "您的应用ID";
        /** 您的应用密钥,请勿把它和appKey泄露给他人 */
        String appSecret = "您的应用密钥";

        /** 音频参数部分 */
        String q = getBase64OfFile("D:\\work\\zhiyun\\voice\\示例音频文件/16k.wav");
        /** 源语言 */
        String from = "zh-CHS";
        /** 目标语言 */
        String to = "en";
        /** 音频格式:目前支持pcm和wav(pcm编码) */
        String format = "wav";
        /** 音频采样率:目前支持16000和8000 */
        String rate = "16000";
        /** 音频频道 */
        String channel = "1";
        /** 上传类型 */
        String type = "1";
        /** 随机数,自己随机生成,建议时间戳 */
        String salt = String.valueOf(System.currentTimeMillis());
        /** 签名 */
        String sign = md5(appKey + q + salt + appSecret);

        /** 装载参数 */
        requestParams.put("q",q);
        requestParams.put("appKey",appKey);
        requestParams.put("format", format);
        requestParams.put("rate", rate);
        requestParams.put("channel", channel);
        requestParams.put("type", type);
        requestParams.put("salt", salt);
        requestParams.put("from", from);
        requestParams.put("to",to);
        requestParams.put("sign",sign);

        /** 获得请求结果 */
        String result = requestForHttp(url,requestParams);
        System.out.println(result);
    }

    /**
     * 根据文件路径获取文件的base64编码
     * @param filePath 文件路径
     * @return 文件base64编码
     */
    private static String getBase64OfFile(String filePath) {
        InputStream in = null;
        byte[] data = null;
        //读取文件字节数组
        try{
            in = new FileInputStream(filePath);
            data = new byte[in.available()];
            in.read(data);
            in.close();
        }catch (IOException e){
            e.printStackTrace();
        }
        return Base64.encode(data);
    }

    /**
     * 生成32位MD5摘要
     * @param string
     * @return
     */
    private static String md5(String string) {
        if(string == null){
            return null;
        }
        char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
                'A', 'B', 'C', 'D', 'E', 'F'};
        byte[] btInput = string.getBytes();
        try{
            /** 获得MD5摘要算法的 MessageDigest 对象 */
            MessageDigest mdInst = MessageDigest.getInstance("MD5");
            /** 使用指定的字节更新摘要 */
            mdInst.update(btInput);
            /** 获得密文 */
            byte[] md = mdInst.digest();
            /** 把密文转换成十六进制的字符串形式 */
            int j = md.length;
            char str[] = new char[j * 2];
            int k = 0;
            for (byte byte0 : md) {
                str[k++] = hexDigits[byte0 >>> 4 & 0xf];
                str[k++] = hexDigits[byte0 & 0xf];
            }
            return new String(str);
        }catch(NoSuchAlgorithmException e){
            return null;
        }
    }

    /**
     * 请求获得结果
     * @param url 目标url
     * @param requestParams 请求参数
     * @return 请求结果
     */
    private static String requestForHttp(String url,Map<String,String> requestParams) throws IOException {
        String result = null;
        CloseableHttpClient httpClient = HttpClients.createDefault();
        /**HttpPost*/
        HttpPost httpPost = new HttpPost(url);
        /** 装载参数 */
        List<NameValuePair> params = new ArrayList<NameValuePair>();
        System.out.println(requestParams.keySet().size());
        for(String key:requestParams.keySet()){
            params.add(new BasicNameValuePair(key, requestParams.get(key)));
        }
        httpPost.setEntity(new UrlEncodedFormEntity(params,"UTF-8"));
        /**HttpResponse*/
        CloseableHttpResponse httpResponse = httpClient.execute(httpPost);
        try{
            HttpEntity httpEntity = httpResponse.getEntity();
            result = EntityUtils.toString(httpEntity, "utf-8");
            EntityUtils.consume(httpEntity);
        }finally{
            try{
                if(httpResponse!=null){
                    httpResponse.close();
                }
            }catch(IOException e){
                System.out.println("## release resouce error ##" + e);
            }
        }
        return result;
    }
}
#/usr/bin/env python
#coding=utf8

import httplib
import md5
import urllib
import urllib2
import random
import json
import base64

# 您的应用ID
appKey = "您的应用ID"
# 您的应用密钥,请勿把它和appKey泄露给他人
appSecret = "您的应用密钥"


httpClient = None

try:

    # 音频参数部分
    f=open(r'D:/work/zhiyun/voice/16k.wav','rb') #二进制方式打开图文件
    q=base64.b64encode(f.read()) #读取文件内容,转换为base64编码
    f.close()
    # 源语言
    fromLan = "zh-CHS"
    # 目标语言
    to = "en"
    # 音频格式:目前支持pcm和wav(pcm编码)
    format = "wav"
    # 音频采样率:目前支持16000和8000
    rate = "16000"
    # 音频频道
    channel = "1"
    # 上传类型
    type = "1"
    # 随机数,自己随机生成,建议时间戳
    salt = random.randint(1, 65536)
    # 签名
    sign = appKey+q+str(salt)+appSecret
    m1 = md5.new()
    m1.update(sign)
    sign = m1.hexdigest()
    data = {'appKey':appKey,'q':q,'from':fromLan,'to':to,'format':format,'rate':rate,'channel':channel,'type':type,'salt':str(salt),'sign':sign}
    data = urllib.urlencode(data)
    req = urllib2.Request('http://openapi.youdao.com/speechtransapi',data)

    #response是HTTPResponse对象
    response = urllib2.urlopen(req)
    print response.read()
except Exception, e:
    print e
finally:
    if httpClient:
        httpClient.close()       
using System;
using System.Web;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Drawing;

namespace ConsoleApplication2
{
    using System;
    using System.Collections.Specialized;
    using System.IO;
    using System.Net;
    using System.Text;
    using System.Web;
    using System.Security.Cryptography;
    using System.Drawing;

    class Test
    {

        public static void Main() {

            String url = "http://openapi.youdao.com/speechtransapi";
            Dictionary dic = new Dictionary();

            string q = ImgToBase64String("d:/16k.wav");
            string appKey = "your appKey";
            string appSecret = "your appSecret";
            /** 源语言 */
            string from = "zh-CHS";
            /** 目标语言 */
            string to = "en";
            /** 音频格式:目前支持pcm和wav(pcm编码) */
            string format = "wav";
            /** 音频采样率:目前支持16000和8000 */
            string rate = "16000";
            /** 音频频道 */
            string channel = "1";
            /** 上传类型 */
            string type = "1";
            /** 随机数,自己随机生成,建议时间戳 */
            string salt = DateTime.Now.Millisecond.ToString();

            MD5 md5 = new MD5CryptoServiceProvider();
            string md5Str = appKey + q + salt + appSecret;
            byte[] output = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(md5Str));
            string sign = BitConverter.ToString(output).Replace("-", "");
            dic.Add("q", System.Web.HttpUtility.UrlEncode(q));
            dic.Add("appKey", appKey);
            dic.Add("from", from);
            dic.Add("to", to);
            dic.Add("format", format);
            dic.Add("rate", rate);
            dic.Add("channel", channel);
            dic.Add("type", type);
            dic.Add("salt", salt);
            dic.Add("sign", sign);
            string result = Post(url, dic);
            Console.WriteLine(result);

    }

       protected static string ImgToBase64String(string Imagefilename)
        {
            try
            {
                FileStream filestream = new FileStream(Imagefilename, FileMode.Open);
                byte[] arr = new byte[filestream.Length];
                ms.Position = 0;
                ms.Read(arr, 0, (int)ms.Length);
                ms.Close();
                return Convert.ToBase64String(arr);
            }
            catch (Exception ex)
            {
                return null;
            }
        }
        public static string Post(string url,Dictionary dic)
        {
            string result = "";
            HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);
            req.Method = "POST";
            req.ContentType = "application/x-www-form-urlencoded";
            #region 添加Post 参数
            StringBuilder builder = new StringBuilder();
            int i = 0;
            foreach (var item in dic)
            {
                if (i > 0)
                    builder.Append("&");
                builder.AppendFormat("{0}={1}", item.Key, item.Value);
                i++;
            }
            Console.WriteLine(builder.ToString());
            byte[] data = Encoding.UTF8.GetBytes(builder.ToString());
            req.ContentLength = data.Length;
            using (Stream reqStream = req.GetRequestStream())
            {
                reqStream.Write(data, 0, data.Length);
                reqStream.Close();
            }
            #endregion
            HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
            Stream stream = resp.GetResponseStream();
            //获取响应内容
            using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
            {
                result = reader.ReadToEnd();
            }
            return result;
        }


    }
}
        
<?php
define("CURL_TIMEOUT",   2000);
define("URL",            "http://openapi.youdao.com/speechtransapi");
define("APP_KEY",         "your app key"); //替换为您的APPKey
define("SEC_KEY",        "your app secret");//替换为您的密钥

//翻译入口
function speechtrans($q, $type, $from, $to,$format,$channel,$rate)
{
                    $args = array(
        'q' => $q,
        'appKey' => APP_KEY,
        'salt' => rand(10000,99999),
        'type' => $type,
        'from' => $from,
        'to' => $to,
        'format' => $format,
        'channel' => $channel,
        'rate' => $rate,
    );
                    $args['sign'] = buildSign(APP_KEY, $q, $args['salt'], SEC_KEY);
                    $ret = call(URL, $args);
    echo $ret;
                    $ret = json_decode($ret, true);
    return $ret;
}

//加密
function buildSign($appKey, $query, $salt, $secKey)
{/*{{{*/
                    $str = $appKey . $query . $salt . $secKey;
                    $ret = md5($str);
    return $ret;
}/*}}}*/

//发起网络请求
function call($url, $args=null, $method="post", $testflag = 0, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
                    $ret = false;
                    $i = 0;
    while($ret === false)
    {
        if($i > 1)
            break;
        if($i > 0)
        {
            sleep(1);
        }
                    $ret = callOnce($url, $args, $method, false, $timeout, $headers);
                    $i++;
    }
    return $ret;
}/*}}}*/

function callOnce($url, $args=null, $method="post", $withCookie = false, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
                    $ch = curl_init();
    if($method == "post")
    {
                    $data = convert($args);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_POST, 1);
    }
    else
    {
                    $data = convert($args);
        if($data)
        {
            if(stripos($url, "?") > 0)
            {
                    $url .= "&$data";
            }
            else
            {
                    $url .= "?$data";
            }
        }
    }
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    if(!empty($headers))
    {
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    }
    if($withCookie)
    {
        curl_setopt($ch, CURLOPT_COOKIEJAR, $_COOKIE);
    }
                    $r = curl_exec($ch);
    curl_close($ch);
    return $r;
}/*}}}*/

function convert(&$args)
{/*{{{*/
                    $data = '';
    if (is_array($args))
    {
        foreach ($args as $key=>$val)
        {
            if (is_array($val))
            {
                foreach ($val as $k=>$v)
                {
                    $data .= $key.'['.$k.']='.rawurlencode($v).'&';
                }
            }
            else
            {
                    $data .="$key=".rawurlencode($val)."&";
            }
        }
        return trim($data, "&");
    }
    return $args;
}/*}}}*/
                    $file="d:/16k.wav";
                    $fp=fopen($file,"r")or die("Can't open file");
                    $q=chunk_split(base64_encode(fread($fp,filesize($file))));//base64编码
fclose($fp);
//调用翻译
speechtrans($q,"1","zh-CHS","en","wav","1","16000");
?>

有道智云图片翻译API说明文档

有道智云图片翻译API简介

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

有道智云OCR API HTTP地址:

http://openapi.youdao.com/ocrtransapi

有道智云OCR API HTTPS地址:

https://openapi.youdao.com/ocrtransapi

接口调用参数

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

符号含义必填举例
type文件上传类型,目前支持base64true1
from源语言,支持的语言参见语言列表trueauto
to目标语言,支持的语言参见语言列表trueen
appKey创建api类型的应用获得的应用IDtruetestKey
sign签名,sign由客户端算好后传递,具体生成规则,见附注truewhatever
salt随机值,建议北京当前时间戳truewhatever
q要识别的图片,type为1时必填,图片的base64编码true在type为1的情况下必填
docType服务器响应类型,目前只支持jsonfalsejson

签名生成方法如下: 1、将请求参数中的 appKey(应用ID), 1 (注意为图片的Base64编码), 随机数 salt应用密钥 按照 appKey+q+salt+应用密钥 的顺序拼接得到字符串 str 。 2、对字符串 str 做 md5,得到32位大写的 sign (参考Java生成MD5示例)

注意:

  1. 请先将需要识别的图片转换为 Base64 编码。
  2. 在发送HTTP请求之前需要对各字段做 URL encode。
  3. 在生成签名拼接 appKey+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翻译结果

注:resRegions是一个json列表,表示图中多个区域对应的翻译结果,每个json中有6个参数:boundingBox、linesCount、lineheight、context、linespace、tranContent。

示例

返回结果示例:

{
    "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": "一个好的实验(坏的实验比没有实验更糟糕)需要一个人做以下的事情:首先,确定要测试的行动过程;叫它治疗。“治疗”可以是警察的策略,也可以是学校里的,或者是福利项目。其次,确定治疗的影响。"
    }]
}

支持的语言表

语言代码
中文zh-CHS
日文ja
英文en
韩文ko
法文fr
俄文ru
葡萄牙文pt
西班牙文es

错误代码列表

错误码含义
101缺少必填的参数,出现这个情况还可能是et的值和实际加密方式不对应
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号异常
113请求q不能为空
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
205创建的应用(Android、iOS、Web)与调用接口不一致
301辞典查询失败
302小语种查询失败
303服务端的其它异常
401账户已经欠费停
411访问频率受限,请稍后访问
412大图片请求过于频繁,请稍后访问
5001无效的OCR类型
5002不支持的OCR image类型
5003不支持的语言类型
5004识别图片过大
5201图片base64解密失败
5301OCR段落识别失败
5411访问频率受限
5412超过最大识别流量

常见问题及注意事项

  • 返回110

应用没有绑定服务实例,可以新建服务实例,绑定服务实例。

  • 返回108

appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)

  • 返回101

首先确保必填参数齐全,然后,确认参数书写是否正确。

  • 返回202

如果确认 appKeyappSecret 的正确性,仍返回202,一般是编码问题。请确保 q 为UTF-8编码.

  • 返回205

确保接入方式(Android SDK、IOS SDK、API)与创建的应用平台类型一致。

常用语言 Demo

Java 示例
Python 示例
C# 示例
PHP 示例
package outfox.ead.openapi;

import net.coobird.thumbnailator.Thumbnails;
import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.*;

/**
*
* 图片翻译Api Demo
* 1.构建参数
* 2.请求api接口
* 3.处理结果
*/
public class TransOCRApiDemo1 {

    private static Logger logger = LoggerFactory.getLogger(TransOCRApiDemo1.class);

    public static void main(String[] args) throws IOException {

        String appKey = &quot;您的应用ID&quot;;
        String appSecret = &quot;您的应用密钥&quot;;
        String filePath = &quot;您的图片地址&quot;;
        String tempFilePath = &quot;压缩图片临时地址&quot;;
        ocrtrans(appKey,appSecret,filePath,tempFilePath);
    }

    /**
    *
    * @param appKey 应用ID
    * @param appSecret 应用密钥
    * @param filePath 图片路径
    * @param tmpFilePath 压缩后文件临时保存路径
    */
    public static void ocrtrans(String appKey,String appSecret,String filePath,String tmpFilePath) throws IOException {
        /** 图片翻译接口地址 */
        String url = &quot;http://openapi.youdao.com/ocrtransapi&quot;;

        /** 构建参数 */
        Map&lt;String,String&gt; params = new HashMap&lt;String,String&gt;();

        File file = new File(filePath);
        if(!file.exists()){
            logger.error(&quot;文件不存在&quot;);
            return;
        }
        /** 压缩图片 */
        long maxSize = 1 * 1024 * 1024;
        float quality = 0.7f;
        if(file.length() &gt; maxSize){
            /** 设置图片大小和质量 */
            Thumbnails.of(filePath).scale(1f).outputQuality(quality).toFile(new File(tmpFilePath));
            File tmpFile = new File(tmpFilePath);
            filePath = tmpFilePath;
            /** 连续压缩 */
            while(tmpFile.length() &gt; maxSize){
                quality -= 0.2;
                Thumbnails.of(filePath).scale(1f).outputQuality(quality).toFile(tmpFile);
                tmpFile = new File(tmpFilePath);
            }
        }
        System.out.println(file.length());

        String salt = String.valueOf(System.currentTimeMillis());
        String from = &quot;auto&quot;;
        String to = &quot;zh-CHS&quot;;
        String type = &quot;1&quot;;
        String sign = null;
        params.put(&quot;appKey&quot;,appKey);
        params.put(&quot;salt&quot;,salt);
        params.put(&quot;from&quot;,from);
        params.put(&quot;to&quot;,to);
        params.put(&quot;type&quot;,type);


        /** 请求图片翻译 */
        File imgFile = new File(filePath);
        String result = null;
        String q = getBase64OfFile(imgFile);
        params.put(&quot;q&quot;, q);
        sign = md5(appKey + q + salt +appSecret);
        params.put(&quot;sign&quot;,sign);
        result = requestForHttp(url,params);

        /** 处理结果 */
        System.out.println(result);
    }

    public static String requestForHttp(String url,Map&lt;String,String&gt; params) throws IOException {
        String result = &quot;&quot;;

        /** 创建HttpClient */
        CloseableHttpClient httpClient = HttpClients.createDefault();

        /** httpPost */
        HttpPost httpPost = new HttpPost(url);
        List&lt;NameValuePair&gt; paramsList = new ArrayList&lt;NameValuePair&gt;();
        Iterator&lt;Map.Entry&lt;String,String&gt;&gt; it = params.entrySet().iterator();
        while(it.hasNext()){
            Map.Entry&lt;String,String&gt; en = it.next();
            String key = en.getKey();
            String value = en.getValue();
            paramsList.add(new BasicNameValuePair(key,value));
        }
        httpPost.setEntity(new UrlEncodedFormEntity(paramsList,&quot;UTF-8&quot;));
        CloseableHttpResponse httpResponse = httpClient.execute(httpPost);
        try{
            HttpEntity httpEntity = httpResponse.getEntity();
            result = EntityUtils.toString(httpEntity,&quot;UTF-8&quot;);
            EntityUtils.consume(httpEntity);
        }finally {
            try{
                if(httpResponse!=null){
                    httpResponse.close();
                }
            }catch(IOException e){
                logger.info(&quot;## release resouce error ##&quot; + e);
            }
        }
        return result;
    }


    /**
    * 生成32位MD5摘要
    * @param string
    * @return
    */
    public static String md5(String string) {
        if(string == null){
            return null;
        }
        char hexDigits[] = {&#x27;0&#x27;, &#x27;1&#x27;, &#x27;2&#x27;, &#x27;3&#x27;, &#x27;4&#x27;, &#x27;5&#x27;, &#x27;6&#x27;, &#x27;7&#x27;, &#x27;8&#x27;, &#x27;9&#x27;,
        &#x27;A&#x27;, &#x27;B&#x27;, &#x27;C&#x27;, &#x27;D&#x27;, &#x27;E&#x27;, &#x27;F&#x27;};
        byte[] btInput = string.getBytes();
        try{
            /** 获得MD5摘要算法的 MessageDigest 对象 */
            MessageDigest mdInst = MessageDigest.getInstance(&quot;MD5&quot;);
            /** 使用指定的字节更新摘要 */
            mdInst.update(btInput);
            /** 获得密文 */
            byte[] md = mdInst.digest();
            /** 把密文转换成十六进制的字符串形式 */
            int j = md.length;
            char str[] = new char[j * 2];
            int k = 0;
            for (byte byte0 : md) {
                str[k++] = hexDigits[byte0 &gt;&gt;&gt; 4 &amp; 0xf];
                str[k++] = hexDigits[byte0 &amp; 0xf];
            }
            return new String(str);
        }catch(NoSuchAlgorithmException e){
            return null;
        }
    }

    public static String getBase64OfFile(File file){
        byte[] data = null;
        InputStream in = null;
        try{
            in = new BufferedInputStream(new FileInputStream(file));
            data = new byte[in.available()];
            in.read(data);

        }catch (Exception e){
            e.printStackTrace();
        }
        return com.sun.org.apache.xml.internal.security.utils.Base64.encode(data);
    }
}
#/usr/bin/env python
#coding=utf8

import httplib
import md5
import urllib
import urllib2
import random
import json
import base64

# 您的应用ID
appKey = "您的应用ID"
# 您的应用密钥,请勿把它和appKey泄露给他人
appSecret = "您的应用密钥"


httpClient = None

try:

    # 参数部分
    f=open(r'D:/test111.jpg','rb') #二进制方式打开图文件
    q=base64.b64encode(f.read()) #读取文件内容,转换为base64编码
    f.close()
    # 源语言
    fromLan = "en"
    # 目标语言
    to = "zh-CHS"
    # 上传类型
    type = "1"
    # 随机数,自己随机生成,建议时间戳
    salt = random.randint(1, 65536)
    # 签名
    sign = appKey+q+str(salt)+appSecret
    m1 = md5.new()
    m1.update(sign)
    sign = m1.hexdigest()
    data = {'appKey':appKey,'q':q,'from':fromLan,'to':to,'type':type,'salt':str(salt),'sign':sign}
    data = urllib.urlencode(data)
    req = urllib2.Request('http://openapi.youdao.com/ocrtransapi',data)

    #response是HTTPResponse对象
    response = urllib2.urlopen(req)
    print response.read()
except Exception, e:
    print e
finally:
    if httpClient:
        httpClient.close()
using System;
using System.Web;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Drawing;

namespace ConsoleApplication2
{
using System;
using System.Collections.Specialized;
using System.IO;
using System.Net;
using System.Text;
using System.Web;
using System.Security.Cryptography;
using System.Drawing;

class Test
{

public static void Main() {

String url = "http://openapi.youdao.com/ocrapi";
Dictionary dic = new Dictionary();

string img = ImgToBase64String("d:/1.png");
string appKey = "your appKey";
string detectType = "10012";
string langType = "en";
String imageType = "1";
string salt = DateTime.Now.Millisecond.ToString();
string appSecret = "your appSecret";
MD5 md5 = new MD5CryptoServiceProvider();
string md5Str = appKey + img + salt + appSecret;
byte[] output = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(md5Str));
string sign = BitConverter.ToString(output).Replace("-", "");
dic.Add("img", System.Web.HttpUtility.UrlEncode(img));
dic.Add("appKey", appKey);
dic.Add("langType", langType);
dic.Add("detectType", detectType);
dic.Add("imageType", imageType);
dic.Add("salt", salt);
dic.Add("sign", sign);
string result = Post(url, dic);
Console.WriteLine(result);

}

protected static string ImgToBase64String(string Imagefilename)
{
try
{
System.Drawing.Bitmap bmp = new System.Drawing.Bitmap(Imagefilename);

MemoryStream ms = new MemoryStream();
bmp.Save(ms, System.Drawing.Imaging.ImageFormat.Jpeg);
byte[] arr = new byte[ms.Length];
ms.Position = 0;
ms.Read(arr, 0, (int)ms.Length);
ms.Close();
return Convert.ToBase64String(arr);
}
catch (Exception ex)
{
return null;
}
}
public static string Post(string url,Dictionary dic)
{
string result = "";
HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);
req.Method = "POST";
req.ContentType = "application/x-www-form-urlencoded";
#region 添加Post 参数
StringBuilder builder = new StringBuilder();
int i = 0;
foreach (var item in dic)
{
if (i > 0)
builder.Append("&");
builder.AppendFormat("{0}={1}", item.Key, item.Value);
i++;
}
Console.WriteLine(builder.ToString());
byte[] data = Encoding.UTF8.GetBytes(builder.ToString());
req.ContentLength = data.Length;
using (Stream reqStream = req.GetRequestStream())
{
reqStream.Write(data, 0, data.Length);
reqStream.Close();
}
#endregion
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
Stream stream = resp.GetResponseStream();
//获取响应内容
using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
{
result = reader.ReadToEnd();
}
return result;
}


}
}

&lt;?php
define(&quot;CURL_TIMEOUT&quot;,   2000);
define(&quot;URL&quot;,            &quot;http://openapi.youdao.com/ocrtransapi&quot;);
define(&quot;APP_KEY&quot;,         &quot;您的应用ID&quot;); //替换为您的应用ID
define(&quot;SEC_KEY&quot;,        &quot;您的应用密钥&quot;);//替换为您的密钥

function ocrtrans($q, $type, $from, $to)
{
    $args = array(
        &#x27;q&#x27; =&gt; $q,
        &#x27;appKey&#x27; =&gt; APP_KEY,
        &#x27;salt&#x27; =&gt; rand(10000,99999),
        &#x27;type&#x27; =&gt; $type,
        &#x27;from&#x27; =&gt; $from,
        &#x27;to&#x27; =&gt; $to
    );
    $args[&#x27;sign&#x27;] = buildSign(APP_KEY, $q, $args[&#x27;salt&#x27;], SEC_KEY);
    $ret = call(URL, $args);
    echo $ret;
    $ret = json_decode($ret, true);
    return $ret;
}

//加密
function buildSign($appKey, $query, $salt, $secKey)
{/*{{{*/
    $str = $appKey . $query . $salt . $secKey;
    $ret = md5($str);
    return $ret;
}/*}}}*/

//发起网络请求
function call($url, $args=null, $method=&quot;post&quot;, $testflag = 0, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
    $ret = false;
    $i = 0;
    while($ret === false)
    {
        if($i &gt; 1)
         break;
        if($i &gt; 0)
        {
            sleep(1);
        }
        $ret = callOnce($url, $args, $method, false, $timeout, $headers);
        $i++;
    }
    return $ret;
}/*}}}*/

function callOnce($url, $args=null, $method=&quot;post&quot;, $withCookie = false, $timeout = CURL_TIMEOUT, $headers=array())
{/*{{{*/
    $ch = curl_init();
    if($method == &quot;post&quot;)
    {
        $data = convert($args);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_POST, 1);
    }
    else
    {
        $data = convert($args);
        if($data)
        {
            if(stripos($url, &quot;?&quot;) &gt; 0)
            {
              $url .= &quot;&amp;$data&quot;;
            }
            else
            {
                $url .= &quot;?$data&quot;;
            }
        }
    }
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    if(!empty($headers))
    {
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    }
    if($withCookie)
    {
        curl_setopt($ch, CURLOPT_COOKIEJAR, $_COOKIE);
    }
    $r = curl_exec($ch);
    curl_close($ch);
    return $r;
}/*}}}*/

function convert(&amp;$args)
{/*{{{*/
    $data = &#x27;&#x27;;
    if (is_array($args))
    {
        foreach ($args as $key=&gt;$val)
        {
            if (is_array($val))
            {
                foreach ($val as $k=&gt;$v)
                {
                    $data .= $key.&#x27;[&#x27;.$k.&#x27;]=&#x27;.rawurlencode($v).&#x27;&amp;&#x27;;
                }
            }
            else
            {
                $data .=&quot;$key=&quot;.rawurlencode($val).&quot;&amp;&quot;;
            }
        }
        return trim($data, &quot;&amp;&quot;);
    }
    return $args;
}/*}}}*/
$file=&quot;d:/test111.jpg&quot;;
$fp=fopen($file,&quot;r&quot;) or die(&quot;Can&#x27;t open file&quot;);
$q=chunk_split(base64_encode(fread($fp,filesize($file))));//base64编码
fclose($fp);
//调用asr
ocrtrans($q,&quot;1&quot;,&quot;en&quot;,&quot;zh-CHS&quot;);
?&gt;
?>

文档是否有帮助解决问题?

如有其它疑问,可在此提交意见和反馈
详细描述(选填)
联系邮箱(选填)
 
有道智云平台介绍
网易有道旗下一个为开发者、企业和政府机构等提供自然语言翻译、文字识别OCR等服务以及行业解决方案的云服务平台,致力于提供安全、可靠和高效的云服务。
联系方式
联系电话:010-8255-8901
商务合作:
投诉反馈:
地址:北京市海淀区西北旺东路10号院 中关村软件园二期西区7号 网易(北京)公司
微信公众号
微信小程序
 
 
 
©2017 网易公司 京ICP证080268号