大模型翻譯 API 簡介
概念解釋
大型模型翻譯：翻譯的好助手，使用此服務(wù)可以完成翻譯、潤色、擴(kuò)寫等功能。API可以處理各種復(fù)雜的語言結(jié)構(gòu)、詞匯和語境，提供高質(zhì)量的翻譯結(jié)果。 同時(shí)，可以根據(jù)用戶的需 求和偏好進(jìn)行定制化的翻譯。用戶可以通過調(diào)整參數(shù)、提供上下文信息或者進(jìn)行反饋，使翻譯結(jié)果更符合個(gè)人或特 定領(lǐng)域的要求，從而實(shí)現(xiàn)更加精準(zhǔn)、個(gè)性化的翻譯體驗(yàn)。
說明
Hi，您好，歡迎使用有道智云翻譯API接口服務(wù)。如果您想快速體驗(yàn)服務(wù)，建議您前往翻譯體驗(yàn)中心 或者在體驗(yàn)中心右下側(cè)找到小程序二維碼，掃描進(jìn)行體驗(yàn)。
本文檔主要針對需要集成HTTP API的技術(shù)開發(fā)工程師，詳細(xì)描述大模型翻譯能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務(wù)合作的需求，可以通過以下方式聯(lián)系我們：
商務(wù)郵箱： AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問，可以通過以下幾種方式聯(lián)系我們：
客服QQ：1906538062
智云翻譯技術(shù)交流QQ 1群: 652880659
智云翻譯技術(shù)交流QQ 2群: 669384425
智云翻譯技術(shù)交流QQ 3群: 807539209
智云翻譯技術(shù)交流QQ 4群: 936752411
聯(lián)系郵箱： zhiyun@corp.youdao.com
溫馨提示：
- 本文檔主要針對開發(fā)人員，接入測試前需要獲取
應(yīng)用ID 和 應(yīng)用密鑰 ，請按照新手指南 獲取。
- 平臺向每個(gè)賬戶贈送10元的體驗(yàn)金，實(shí)名再贈送40元體驗(yàn)金，供用戶集成前測試所用，具體資費(fèi)規(guī)則詳見 大模型翻譯服務(wù)報(bào)價(jià) 。
接口說明
大模型翻譯API接口提供有道的翻譯服務(wù)，包含了中英翻譯、潤色、擴(kuò)寫功能。您只需要通過調(diào)用大模型翻譯API，傳入待處理的文本，并指定要翻譯的源語言（支持源語言語種自動檢測）和目標(biāo)語言種類，就可以得到相應(yīng)的翻譯結(jié)果。
大模型翻譯API HTTPS地址：
https://openapi.youdao.com/llm_trans
協(xié)議須知
調(diào)用方在集成大模型翻譯API時(shí)，請遵循以下規(guī)則。
| 規(guī)則 |
描述 |
| 傳輸方式 |
HTTPS |
| 請求方式 |
GET/POST |
| 字符編碼 |
統(tǒng)一使用UTF-8 編碼 |
| 請求格式 |
表單 |
| 響應(yīng)格式 |
text/event-stream |
接口調(diào)用參數(shù)
調(diào)用API需要向接口發(fā)送以下字段來訪問服務(wù)。
| 字段名 |
類型 |
含義 |
必填 |
備注 |
| i |
text |
待翻譯文本 |
True |
必須是UTF-8編碼，限制5000字符 |
| prompt |
text |
提示詞 |
False |
必須是UTF-8編碼，限制1200字符、400單詞 |
| from |
text |
源語言 |
True |
參考下方支持語言 (可設(shè)置為auto) |
| to |
text |
目標(biāo)語言 |
True |
參考下方支持語言 |
| streamType |
text |
流式返回類型 |
False |
參考下方 流式返回類型 |
| appKey |
text |
應(yīng)用ID |
True |
可在應(yīng)用管理 查看 |
| salt |
text |
隨機(jī)字符串，可使用UUID進(jìn)行生產(chǎn) |
True |
uuid (可使用uuid生成) |
| sign |
text |
簽名 |
True |
sha256(應(yīng)用ID+input+salt+curtime+應(yīng)用密鑰) |
| signType |
text |
簽名類型 |
True |
v3 |
| curtime |
text |
當(dāng)前UTC時(shí)間戳(秒) |
True |
TimeStamp |
| handleOption |
text |
處理模式選項(xiàng) |
False |
參考下方 處理模式選項(xiàng) |
| polishOption |
text |
潤色選項(xiàng) |
False |
參考下方 潤色選項(xiàng) |
| expandOption |
text |
擴(kuò)寫選項(xiàng) |
False |
參考下方 擴(kuò)寫選項(xiàng) |
簽名生成方法如下：
signType=v3；
sign=sha256(應(yīng)用ID+input+salt+curtime+應(yīng)用密鑰)；
其中，input的計(jì)算方式為：input=i前10個(gè)字符 + i長度 + i后10個(gè)字符（當(dāng)i長度大于20）或 input=i字符串（當(dāng)i長度小于等于20）；
不同語言獲取時(shí)間戳，請參看此鏈接
如果對簽名有疑問，可以參看各語言demo。
處理模式選項(xiàng)
| handleOption取值 |
含義 |
| 0 |
有道子曰翻譯pro版本(14B)處理請求，通用pro翻譯模型僅提供翻譯功能，參數(shù)中的 prompt 僅對通用翻譯模型(handleOption=0/3)生效 |
| 1 |
專業(yè)翻譯模型處理請求，專業(yè)翻譯模型可提供翻譯、潤色、擴(kuò)寫功能，注意：當(dāng)用戶指定from、to為具體語種時(shí)，效果更好 |
| 2 |
潤色擴(kuò)寫模型處理請求，潤色擴(kuò)寫模型可提供翻譯、潤色、擴(kuò)寫功能，并且最終翻譯結(jié)果優(yōu)于專業(yè)翻譯模型，推薦使用。注意：當(dāng)用戶指定from、to為具體語種時(shí)，效果更好 |
| 3 |
有道子曰翻譯lite版本(1.5B)處理請求，lite翻譯模型僅提供翻譯功能，參數(shù)中的 prompt 僅對通用翻譯模型(handleOption=0/3)生效 |
- “handleOption”參數(shù)在handleOption、polishOption、expandOption中優(yōu)先級最高，即如果需要潤色和擴(kuò)寫功能時(shí)，需要設(shè)置handleOption = “1” 或者 “2”。
潤色選項(xiàng)
| polishOption取值 |
含義 |
polishOption取值 |
含義 |
| 0 |
不潤色 |
|
|
| 1 |
專業(yè)化潤色 |
2 |
專業(yè)化翻譯 |
| 3 |
口語化潤色 |
4 |
口語化翻譯 |
| 5 |
簡潔化潤色 |
6 |
簡潔化翻譯 |
| 7 |
豐富化潤色 |
8 |
豐富化翻譯 |
| 9 |
計(jì)算機(jī)領(lǐng)域潤色 |
10 |
計(jì)算機(jī)領(lǐng)域翻譯 |
| 11 |
醫(yī)學(xué)領(lǐng)域潤色 |
12 |
醫(yī)學(xué)領(lǐng)域翻譯 |
| 13 |
生物領(lǐng)域潤色 |
14 |
生物領(lǐng)域翻譯 |
| 15 |
機(jī)械領(lǐng)域潤色 |
16 |
機(jī)械領(lǐng)域翻譯 |
擴(kuò)寫選項(xiàng)
| expandOption取值 |
含義 |
| 0 |
不擴(kuò)寫 |
| 1 |
論文發(fā)表 |
| 2 |
正式郵件 |
- 潤色和擴(kuò)寫不會同時(shí)生效，如果潤色參數(shù)和擴(kuò)寫參數(shù)均存在時(shí)，潤色優(yōu)先。
流式返回類型
| streamType取值 |
含義 |
| increment |
譯文文本按照“增量形式”返回，默認(rèn)按此方式返回。 |
| full |
譯文文本按照“全量形式”返回。 |
| all |
同時(shí)返回“增量形式”、“全量形式”譯文。 |
- “增量形式”，“全量形式”可參考下方輸出結(jié)果理解。如果使用專業(yè)翻譯模型和潤色擴(kuò)寫模型，僅支持增量返回。
輸出結(jié)果
- 輸出結(jié)果為流式的ServerSentEvent。
正常結(jié)果的格式
| 部分 |
event類型 |
data結(jié)構(gòu) |
說明 |
| 第1部分 |
begin |
一個(gè)data示例：
{
"requestId": "1",
"type": "zh-CHS2en"
}
其中：
- type字段表示翻譯語言方向
|
一個(gè)正常返回結(jié)果中，有且僅有一個(gè)begin event。 |
| 第2部分 |
message |
一個(gè)data示例：
{
"transFull": "The weather",
"transIncre": "her"
}
其中：
- transFull字段表示“全量形式”譯文
- transIncre字段表示“增量形式”譯文
|
一個(gè)正常返回結(jié)果中，可能會有一個(gè)或一個(gè)以上的message event。 |
| 第3部分 |
end |
一個(gè)data示例：
{
"requestId": "1",
"type": "zh-CHS2en",
"eventTokenUsage": {
"inputToken": 5,
"outputToken": 7,
"totalToken": 12
}
}
其中：
- type表示翻譯的語言方向
- eventTokenUsage中記錄了token的用量
- inputToken表示輸入token用量（prompt和i的token用量合計(jì)）
- output表示輸出token用量
- totalToken表示總計(jì)token用量
|
一個(gè)正常返回結(jié)果中，有且僅有一個(gè)end event。 |
正常結(jié)果的示例
示例一：“增量形式”譯文
event:begin
data:{"requestId":"11","type":"zh-CHS2en"}
event:message
data:{"transFull":null,"transIncre":"The"}
event:message
data:{"transFull":null,"transIncre":" w"}
event:message
data:{"transFull":null,"transIncre":"eat"}
event:message
data:{"transFull":null,"transIncre":"her"}
event:message
data:{"transFull":null,"transIncre":" is"}
event:message
data:{"transFull":null,"transIncre":" really"}
event:message
data:{"transFull":null,"transIncre":" nice"}
event:message
data:{"transFull":null,"transIncre":" today"}
event:message
data:{"transFull":null,"transIncre":"."}
event:end
data:{"requestId":"11","type":"zh-CHS2en","eventTokenUsage":{"inputToken":5,"outputToken":7,"totalToken":12}}
示例二：“全量形式”譯文
event:begin
data:{"requestId":"12","type":"zh-CHS2en"}
event:message
data:{"transFull":"The","transIncre":null}
event:message
data:{"transFull":"The w","transIncre":null}
event:message
data:{"transFull":"The weat","transIncre":null}
event:message
data:{"transFull":"The weather","transIncre":null}
event:message
data:{"transFull":"The weather is","transIncre":null}
event:message
data:{"transFull":"The weather is really","transIncre":null}
event:message
data:{"transFull":"The weather is really nice","transIncre":null}
event:message
data:{"transFull":"The weather is really nice today","transIncre":null}
event:message
data:{"transFull":"The weather is really nice today.","transIncre":null}
event:end
data:{"requestId":"12","type":"zh-CHS2en","eventTokenUsage":{"inputToken":5,"outputToken":7,"totalToken":12}}
示例三：“增量形式”譯文 + “全量形式”譯文
event:begin
data:{"requestId":"13","type":"zh-CHS2en"}
event:message
data:{"transFull":"The","transIncre":"The"}
event:message
data:{"transFull":"The w","transIncre":" w"}
event:message
data:{"transFull":"The weat","transIncre":"eat"}
event:message
data:{"transFull":"The weather","transIncre":"her"}
event:message
data:{"transFull":"The weather is","transIncre":" is"}
event:message
data:{"transFull":"The weather is really","transIncre":" really"}
event:message
data:{"transFull":"The weather is really nice","transIncre":" nice"}
event:message
data:{"transFull":"The weather is really nice today","transIncre":" today"}
event:message
data:{"transFull":"The weather is really nice today.","transIncre":"."}
event:end
data:{"requestId":"13","type":"zh-CHS2en","eventTokenUsage":{"inputToken":5,"outputToken":7,"totalToken":12}}
異常結(jié)果的格式
一個(gè)異常返回的結(jié)果由以下三個(gè)部分組成：
| 部分 |
event類型 |
data結(jié)構(gòu) |
說明 |
| 第1部分 |
begin |
一個(gè)data示例：
{
"requestId": "1",
"type": "zh-CHS2en"
}
其中：
- type字段表示翻譯語言方向，在異常返回時(shí)，type有可能是null
|
一個(gè)異常返回結(jié)果中，有且僅有一個(gè)begin event。 |
| 第2部分 |
message |
一個(gè)data示例：
{
"transFull": "The weather",
"transIncre": "her"
}
其中：
- transFull字段表示“全量形式”譯文
- transIncre字段表示“增量形式”譯文
|
一個(gè)異常返回結(jié)果中，可能會有零個(gè)、一個(gè)或一個(gè)以上的message event。 |
| 第3部分 |
error |
一個(gè)data示例：
{
"code": "40",
"msg": "不支持的語言方向！",
"eventTokenUsage": {
"inputToken": 2,
"outputToken": 3,
"totalToken": 5
}
}
其中：
- code表示錯(cuò)誤碼
- msg表示錯(cuò)誤信息
- eventTokenUsage中記錄了token的用量
- inputToken表示輸入token用量（prompt和i的token用量合計(jì)）
- output表示輸出token用量
- totalToken表示總計(jì)token用量
當(dāng)異常返回時(shí)，可能發(fā)生token使用，也可能沒有token使用。
|
一個(gè)異常返回結(jié)果中，有且僅有一個(gè)error event。 |
異常結(jié)果的示例
event:begin
data:{"requestId":"14","type":null}
event:error
data:{"code":"40","msg":"不支持的語言方向！","eventTokenUsage":{"inputToken":0,"outputToken":0,"totalToken":0}}
支持語言
下表為各語言對應(yīng)代碼：
| 英文名 |
中文名 |
代碼 |
| English |
英語 |
en |
| Chinese |
簡體中文 |
zh-CHS |
| auto |
自動識別 |
auto |
注意：
其中auto可以識別中文、英文，其他語種無法識別。
服務(wù)配置
| 單次查詢最大字符數(shù) |
并發(fā)限制 |
支持語言 |
| 5000 |
5qps |
中、英 |
錯(cuò)誤代碼列表
| 錯(cuò)誤碼 |
含義 |
| 101 |
缺少必填的參數(shù),首先確保必填參數(shù)齊全，然后確認(rèn)參數(shù)書寫是否正確。 |
| 102 |
不支持的語言類型 |
| 103 |
翻譯文本過長 |
| 104 |
不支持的API類型 |
| 105 |
不支持的簽名類型 |
| 106 |
不支持的響應(yīng)類型 |
| 107 |
不支持的傳輸加密類型 |
| 108 |
應(yīng)用ID無效，注冊賬號，登錄后臺創(chuàng)建應(yīng)用并完成綁定，可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
| 109 |
batchLog格式不正確 |
| 110 |
無相關(guān)服務(wù)的有效應(yīng)用,應(yīng)用沒有綁定服務(wù)應(yīng)用，可以新建服務(wù)應(yīng)用。注：某些服務(wù)的翻譯結(jié)果發(fā)音需要tts服務(wù)，需要在控制臺創(chuàng)建語音合成服務(wù)綁定應(yīng)用后方能使用。 |
| 111 |
開發(fā)者賬號無效 |
| 112 |
請求服務(wù)無效 |
| 113 |
q不能為空 |
| 114 |
不支持的圖片傳輸方式 |
| 116 |
strict字段取值無效，請參考文檔填寫正確參數(shù)值 |
| 201 |
解密失敗，可能為DES,BASE64,URLDecode的錯(cuò)誤 |
| 202 |
簽名檢驗(yàn)失敗,如果確認(rèn)應(yīng)用ID和應(yīng)用密鑰的正確性，仍返回202，一般是編碼問題。請確保翻譯文本 q 為UTF-8編碼. |
| 203 |
訪問IP地址不在可訪問IP列表 |
| 205 |
請求的接口與應(yīng)用的平臺類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應(yīng)用平臺類型一致。如有疑問請參考入門指南 |
| 206 |
因?yàn)闀r(shí)間戳無效導(dǎo)致簽名校驗(yàn)失敗 |
| 207 |
重放請求 |
| 301 |
辭典查詢失敗 |
| 302 |
翻譯查詢失敗 |
| 303 |
服務(wù)端的其它異常 |
| 304 |
翻譯失敗，請聯(lián)系技術(shù)同學(xué) |
| 308 |
rejectFallback參數(shù)錯(cuò)誤 |
| 309 |
domain參數(shù)錯(cuò)誤 |
| 310 |
未開通領(lǐng)域翻譯服務(wù) |
| 401 |
賬戶已經(jīng)欠費(fèi)，請進(jìn)行賬戶充值 |
| 402 |
offlinesdk不可用 |
| 411 |
訪問頻率受限,請稍后訪問 |
| 412 |
長請求過于頻繁，請稍后訪問 |
| 2 |
原文為空 |
| 20 |
原文超過長度限制 |
| 30 |
暫時(shí)無法完成翻譯，請稍后重試！ |
| 40 |
不支持的語言方向 |
| 2101 |
沒有有效的底層服務(wù)節(jié)點(diǎn) |
| 3401 |
涉及敏感內(nèi)容 |
| 4001 |
prompt長度超過限制 |
| 500 |
未知錯(cuò)誤，請?zhí)峁┰敿?xì)數(shù)據(jù)信息，聯(lián)系技術(shù)人員協(xié)助排查 |
常用語言 Demo
Java 示例
大模型翻譯 Java demo
Python3 示例
大模型翻譯 python3 demo
go 示例
大模型翻譯 go demo
