机器翻译(新) API
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
http[s]: //itrans.xf-yun.com/v1/its
接口说明
机器翻译(新) demo java语言
机器翻译(新) demo python语言
内容 | 说明 |
---|---|
传输方式 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http[s]: //itrans.xf-yun.com/v1/its 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求行 | POST /v1/its HTTP/1.1 |
接口鉴权 | 签名机制,详情请参照下方接口说明 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器,请在后端调用接口 |
文本长度 | 单次文本长度不得超过5000个字符 |
文本大小 | 不得超过5000个字符,汉字不超过15000个字节,英文不超过5000字节 |
文本语言 | 支持多种语种,详细请参照语种列表 |
#鉴权说明
通过在请求地址后面加上鉴权相关参数的方式,请注意影响鉴权结果的值有url、apiSecret、apiKey、date,如果调试鉴权,请务必按照示例中给的值进行调试,具体参数如下:
http示例url:
https://itrans.xf-yun.com/v1/its?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iZjFKQXJBNmt0aGVOUG9mUDRXWDgyNjRxTkZOQkE4SFpCMzFPL2RlSmN1Yz0i&host=itrans.xf-yun.com&date=Thu%2C+18+Nov+2021+03%3A05%3A18+GMT
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
host | string | 是 | 请求主机 | itrans.xf-yun.com |
date | string | 是 | 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") | Thu, 18 Nov 2021 03:05:18 GMT |
authorization | string | 是 | 使用base64编码的签名相关信息(签名基于hamc-sha256计算) | 参考下方详细生成规则 |
服务端会对date进行时钟偏移检查,最大允许300秒的偏差,超出偏差的请求都将被拒绝。
在讯飞开放平台控制台,创建一个应用后打开OCR中英文字识别页面可以获取,均为32位字符串。
2)参数authorization base64编码前(authorization_origin)的格式如下。
api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串,详见下方。
拼接的格式为(\n为换行符,’:’后面有一个空格):
host: $host\ndate: $date\n$request-line
请求url = "https://itrans.xf-yun.com/v1/its"
date = "Thu, 18 Nov 2021 03:05:18 GMT"
host: itrans.xf-yun.com
date: Thu, 18 Nov 2021 03:05:18 GMT
POST /v1/its HTTP/1.1
signature_sha=hmac-sha256(signature_origin,$apiSecret)
signature=base64(signature_sha)
APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"
date = "Thu, 18 Nov 2021 03:05:18 GMT"
signature="f1JArA6ktheNPofP4WX8264qNFNBA8HZB31O/deJcuc="
api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="f1JArA6ktheNPofP4WX8264qNFNBA8HZB31O/deJcuc="
authorization = base64(authorization_origin)
示例结果为:
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iZjFKQXJBNmt0aGVOUG9mUDRXWDgyNjRxTkZOQkE4SFpCMzFPL2RlSmN1Yz0i
#鉴权结果
HTTP Code | 说明 | 错误描述信息 | 解决方法 |
---|---|---|---|
401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
401 | 签名参数解析失败 | {“message”:”HMAC signature cannot be verified”} | 检查签名的各个参数是否有缺失是否正确,特别确认下复制的api_key是否正确 |
401 | 签名校验失败 | {“message”:”HMAC signature does not match”} | 签名验证失败,可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host,date,request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。 |
403 | 时钟偏移校验失败 | {“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”} | 检查服务器时间是否标准,相差5分钟以上会报此错误 |
HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
"message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}
{
"trans_result": {
"dst": "This is a public place, please don't smoke",
"src": "这是公共场合,请勿吸烟"
},
"from": "cn",
"to": "en"
}
参数名 | 类型 | 描述 |
---|---|---|
trans_result | object | 翻译结果 |
trans_result.dst | string | 目标文本 |
trans_result.src | string | 源文本 |
from | string | 源语种 |
to | string | 目标语种 |
#语种列表
语种 | 参数 | 语种 | 参数 | 语种 | 参数 |
---|---|---|---|---|---|
英语 | en | 捷克语 | cs | 豪萨语 | ha |
日语 | ja | 罗马尼亚语 | ro | 匈牙利语 | hu |
韩语 | ko | 瑞典语 | sv | 斯瓦希里语 | sw |
泰语 | th | 荷兰语 | nl | 乌兹别克语 | uz |
俄语 | ru | 波兰语 | pl | 祖鲁语 | zu |
保加利亚语 | bg | 阿拉伯语 | ar | 希腊语 | el |
乌克兰语 | uk | 波斯语 | fa | 希伯来语 | he |
越南语 | vi | 普什图语 | ps | 亚美尼亚语 | hy |
马来语 | ms | 乌尔都语 | ur | 格鲁吉亚语 | ka |
印尼语 | id | 印地语 | hi | 广东话 | yue |
菲律宾语 | tl | 孟加拉语 | bn | 彝语 | ii |
德语 | de | 外蒙语 | nm | 壮语 | zua |
西班牙语 | es | 外哈语 | kk | 内蒙语 | mn |
法语 | fr | 土耳其语 | tr | 内哈萨克语 | kka |
#常见问题
#机器翻译(新)的新特性有哪些?
答:比如调用接口返回时长上的优化、通过个性化术语资源使用可以做到词语个性化翻译、后面会支持更多的翻译语种。
#机器翻译(新)的主要功能是什么?
答:支持文本到文本的机器翻译。
#机器翻译(新)支持的文本长度是多少?
答:不能超过5000个字符,即汉语不超过15000个字节,英文不超过5000个字节。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://dev-cn.your-api-server.comhttp[s]: //itrans.xf-yun.com/v1/its' \
--header 'Content-Type: application/json' \
--data-raw '{
"header": {
"app_id": "your_app_id",
"status": 3,
"res_id": "your_res_id"
},
"parameter": {
"its": {
"from": "cn",
"to": "en",
"result": {
}
}
},
"payload": {
"input_data": {
"encoding": "utf8",
"status": 3,
"text": "56eR5aSn6K6v6aOe55qE"
}
}
}'
响应示例响应示例
{
"header": {
"code": 0,
"message": "string",
"sid": "string"
},
"payload": {
"result": {
"seq": "string",
"status": "string",
"text": "string"
}
}
}
请求参数
Body 参数application/json
返回响应
修改于 2023-12-19 08:13:27