長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)簡(jiǎn)介
說(shuō)明
Hi,您好,歡迎使用有道智云長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)接口服務(wù)。
本文檔主要針對(duì)需要集成HTTP API的技術(shù)開(kāi)發(fā)工程師,詳細(xì)描述長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務(wù)合作的需求,可以通過(guò)以下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對(duì)文檔內(nèi)容有任何疑問(wèn),可以通過(guò)以下幾種方式聯(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
溫馨提示:
- 本文檔主要針對(duì)開(kāi)發(fā)人員,接入測(cè)試前需要獲取應(yīng)用ID和應(yīng)用密鑰,并綁定實(shí)例;如果您還沒(méi)有,請(qǐng)按照 新手指南 獲取。
- 平臺(tái)向每個(gè)賬戶(hù)贈(zèng)送50元的體驗(yàn)金,供用戶(hù)集成前測(cè)試所用。
接口說(shuō)明
長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)服務(wù),將一小時(shí)內(nèi)的音頻數(shù)據(jù)轉(zhuǎn)換成文本數(shù)據(jù),為信息處理和數(shù)據(jù)挖掘提供基礎(chǔ)。您只需要通過(guò)調(diào)用長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě) API就可以將音頻數(shù)據(jù)轉(zhuǎn)換成文本數(shù)據(jù)。
協(xié)議須知
調(diào)用方在集成長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)API時(shí),請(qǐng)遵循以下規(guī)則。
規(guī)則 | 描述 |
---|
傳輸方式 | HTTPS |
請(qǐng)求方式 | POST |
字符編碼 | 統(tǒng)一使用UTF-8 編碼 |
請(qǐng)求格式 | 表單 |
響應(yīng)格式 | JSON |
接口調(diào)用參數(shù)
長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě)線(xiàn)上調(diào)用地址:
http://openapi.youdao.com
音頻格式
格式支持:wav(不壓縮,pcm編碼,采樣率:推薦16k ,編碼:16bit位深的單聲道),aac,mp3
支持的語(yǔ)種
語(yǔ)種名稱(chēng) | 代碼 | 支持的時(shí)長(zhǎng)限制 |
---|
中文 | zh-CHS | 4h |
日文 | ja | 1h |
英文 | en | 4h |
韓文 | ko | 1h |
粵語(yǔ) | yue | 1h |
西班牙語(yǔ) | es | 1h |
葡萄牙語(yǔ) | pt | 1h |
法語(yǔ) | fr | 1h |
德語(yǔ) | de | 1h |
俄語(yǔ) | ru | 1h |
文件上傳接口定義
預(yù)處理接口
接口參數(shù):
參數(shù)名稱(chēng) | 類(lèi)型 | 含義 | 是否必填 | 示例 |
---|
salt | text | uuid(唯一通用識(shí)別碼) | True | uuid,唯一通用識(shí)別碼 |
type | text | 上傳類(lèi)型, 僅支持base64上傳,請(qǐng)?zhí)顚?xiě)固定值1 | True | 1 |
appKey | text | 應(yīng)用ID | True | 可在 應(yīng)用管理 查看 |
sliceNum | string | 文件分片數(shù)目(建議分片大小為10M,若文件<10M,則slice_num=1 | True | 1 |
name | text | 文件名稱(chēng) | True | test |
fileSize | text | 文件大小,注意:文件大小限制為500M,取值范圍為:1024-589824000 byte | True | 15234 |
curtime | text | 時(shí)間戳 | True | 秒數(shù) |
langType | text | 源語(yǔ)言 | True | 支持語(yǔ)言列表 |
sign | text | 簽名 | True | sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰) |
signType | text | 簽名版本 | True | v4 |
format | text | 語(yǔ)音文件的格式,wav | True | mp3/wav/aac/m4a/amr |
noitn | text | 是否進(jìn)行阿拉伯?dāng)?shù)字轉(zhuǎn)換,日期轉(zhuǎn)換的操作。如 "十點(diǎn)五分" 到 “10:05” 的轉(zhuǎn)換。傳1是漢字,傳0是阿拉伯?dāng)?shù)字。 | false | 0/1(不傳默認(rèn)為0) |
needSpeakerId | text | 是否需要返回說(shuō)話(huà)人id (1:是, 0:否) | false | 0/1(默認(rèn)為0) |
speakerNum | text | 說(shuō)話(huà)人人數(shù)(0 自動(dòng)識(shí)別,范圍:[0-10]) | false | (默認(rèn)為0) |
hotWords | String | 1、熱詞總長(zhǎng)度:5000(總長(zhǎng)度限制較大,實(shí)際到不了5000);2、單個(gè)熱詞內(nèi)容:長(zhǎng)度限制1 - 20 ;3、權(quán)重取值目前只能是1; 4、熱詞與熱詞之間 用 , (英文逗號(hào))分隔 | false | 1、熱詞格式示例:熱詞/權(quán)重; 2、目前模型僅支持中文或單個(gè)英文字母生效,如果傳其他文本會(huì)導(dǎo)致熱詞不生效,但不會(huì)有錯(cuò)誤信息;3、傳空字符串表示不使用熱詞,不會(huì)報(bào)錯(cuò);4、中文傳參為langType="zh-CHS2" |
文件分片上傳接口
- 接口uri:/api/audio/upload
- 接口說(shuō)明:
預(yù)處理成功,調(diào)用文件上傳接口;按預(yù)處理設(shè)置的分片信息(sliceNum)依次上傳音頻切片(文件以二進(jìn)制方式multipart讀取上傳),
直到全部切片上傳成功(如預(yù)處理時(shí) sliceNum=2,則需將音頻切分成兩部分,sliceId=1和2,并按順序調(diào)用該接口);
上一切片成功上傳,才可進(jìn)行下一切片的上傳操作。調(diào)用過(guò)程中若出現(xiàn)異常,可重試若干次。
參數(shù)名稱(chēng) | 類(lèi)型 | 含義 | 是否必填 | 示例 |
---|
q | text | taskid | True | 任務(wù)id |
appKey | text | 應(yīng)用ID | True | 可在 應(yīng)用管理 查看 |
salt | text | UUID(唯一識(shí)別通用碼) | True | UUID |
curtime | text | 時(shí)間戳(秒) | True | 秒 |
sign | text | 簽名 | True | sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰) |
signType | text | 簽名版本 | True | v4 |
sliceId | text | 語(yǔ)音文件分片的Id | True | 1 |
file | text | 文件 | True | multipart的name為file |
type | text | 上傳的類(lèi)型 | false | 1 |
{????
"errorCode":?"0",?//錯(cuò)誤碼????
"msg":?"success",?//信息說(shuō)明????
"result":?null?//返回的任務(wù)ID
}
合并文件
- 接口uri:/api/audio/merge
- 接口說(shuō)明:
全部文件切片上傳成功后,調(diào)用該接口,通知服務(wù)端進(jìn)行文件合并與轉(zhuǎn)寫(xiě)操作。 該接口不會(huì)返回轉(zhuǎn)寫(xiě)結(jié)果,而是通知服務(wù)端將任務(wù)列入轉(zhuǎn)寫(xiě)計(jì)劃。轉(zhuǎn)寫(xiě)的結(jié)果通過(guò) getResult 接口獲取。
參數(shù)名稱(chēng) | 類(lèi)型 | 含義 | 是否必填 | 示例 |
---|
q | text | taskid | True | 任務(wù)id |
appKey | text | 應(yīng)用ID | True | 可在 應(yīng)用管理 查看 |
salt | text | UUID(唯一識(shí)別通用碼) | True | UUID |
curtime | text | 時(shí)間戳(秒) | True | 秒 |
sign | text | 簽名 | True | sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰) |
signType | text | 簽名版本 | True | v4 |
{
????"errorCode":?"0",?//錯(cuò)誤碼
????"msg":?"success",?//信息說(shuō)明
????"result":?null?//返回的任務(wù)ID
}
查詢(xún)轉(zhuǎn)寫(xiě)進(jìn)度
- 接口uri:/api/audio/get_progress
- 接口說(shuō)明:
在調(diào)用方發(fā)出合并文件請(qǐng)求后,服務(wù)端已將任務(wù)列入計(jì)劃。在獲取結(jié)果前,調(diào)用方需輪詢(xún)?cè)摻涌诓樵?xún)?nèi)蝿?wù)當(dāng)前狀態(tài)。 當(dāng)且僅當(dāng)任務(wù)狀態(tài)=(轉(zhuǎn)寫(xiě)結(jié)果上傳完成),才可調(diào)用獲取結(jié)果接口獲取轉(zhuǎn)寫(xiě)結(jié)果。 輪詢(xún)策略由調(diào)用方?jīng)Q定,建議每隔10分鐘輪詢(xún)一次。狀態(tài)碼說(shuō)明見(jiàn)附錄。
參數(shù)名稱(chēng) | 類(lèi)型 | 含義 | 是否必填 | 示例 |
---|
q | text | taskid | True | 任務(wù)id |
appKey | text | 應(yīng)用ID | True | 可在 應(yīng)用管理 查看 |
salt | text | UUID(唯一識(shí)別通用碼) | True | UUID |
curtime | text | 時(shí)間戳(秒) | True | 秒 |
sign | text | 簽名 | True | sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰) |
signType | text | 簽名版本 | True | v4 |
{
????"errorCode":?"0",?//錯(cuò)誤碼
????"msg":?"success",?//信息說(shuō)明
????"result": [{"status":"9","taskId":"xxxx"}]//處理狀態(tài):processing;complete
}
查詢(xún)轉(zhuǎn)寫(xiě)結(jié)果
- 接口uri:/api/audio/get_result
- 接口說(shuō)明:
當(dāng)任務(wù)處理進(jìn)度狀態(tài)為完成時(shí)(見(jiàn)查詢(xún)處理進(jìn)度接口),調(diào)用該接口獲取轉(zhuǎn)寫(xiě)結(jié)果。這是轉(zhuǎn)寫(xiě)流程的最后一步。 轉(zhuǎn)寫(xiě)結(jié)果各字段的詳細(xì)說(shuō)明見(jiàn)轉(zhuǎn)寫(xiě)結(jié)果說(shuō)明文檔。 服務(wù)端也支持主動(dòng)回調(diào),轉(zhuǎn)寫(xiě)完成之后主動(dòng)發(fā)送轉(zhuǎn)寫(xiě)結(jié)果到用戶(hù)配置的回調(diào)地址
參數(shù)名稱(chēng) | 類(lèi)型 | 含義 | 是否必填 | 示例 |
---|
q | text | taskid | True | 任務(wù)id |
appKey | text | 應(yīng)用ID | True | 可在 應(yīng)用管理 查看 |
salt | text | UUID(唯一識(shí)別通用碼) | True | UUID |
curtime | text | 時(shí)間戳(秒) | True | 秒 |
sign | text | 簽名 | True | sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰) |
signType | text | 簽名版本 | True | v4 |
{
"result": [{
"sentence": "Have a good day.",
"vad_id": 1,
"word_timestamps": [70, 270, 390, 710],
"word_timestamps_eds": [190, 390, 510, 830],
"words": ["Have", "a", "good", "day."],
"speaker": 1,
"partial": false}],
"errorCode": "0"
}
常用語(yǔ)言demo
java示例
長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě) python demo
python3 示例
長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě) python demo
go 示例
長(zhǎng)語(yǔ)音轉(zhuǎn)寫(xiě) go demo
任務(wù)狀態(tài)碼
狀態(tài)ID | 狀態(tài)描述 |
---|
0 | 任務(wù)創(chuàng)建成功 |
1 | 音頻上傳完成 |
2 | 音頻合并完成 |
3 | 音頻轉(zhuǎn)寫(xiě)中 |
4 | 轉(zhuǎn)寫(xiě)結(jié)果處理中 |
5 | 轉(zhuǎn)寫(xiě)完成 |
6 | 音頻轉(zhuǎn)寫(xiě)失敗,需要重試 |
9 | 轉(zhuǎn)寫(xiě)結(jié)果上傳完成 |
12 | 音頻轉(zhuǎn)碼失敗 |
13 | 音頻時(shí)長(zhǎng)超過(guò)限制 |
21 | 包含不合時(shí)宜詞匯 |
狀態(tài)碼
狀態(tài)碼 | 狀態(tài)碼含義 |
---|
101 | 缺少必填的參數(shù),首先確保必填參數(shù)齊全,然后,確認(rèn)參數(shù)書(shū)寫(xiě)是否正確。 |
102 | 不支持的語(yǔ)言類(lèi)型 |
103 | 翻譯文本過(guò)長(zhǎng) |
104 | 不支持的API類(lèi)型 |
105 | 不支持的簽名類(lèi)型 |
106 | 不支持的響應(yīng)類(lèi)型 |
107 | 不支持的傳輸加密類(lèi)型 |
108 | 應(yīng)用ID無(wú)效,注冊(cè)賬號(hào),登錄后臺(tái)創(chuàng)建應(yīng)用和實(shí)例并完成綁定,可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
109 | batchLog格式不正確 |
110 | 無(wú)相關(guān)服務(wù)的有效應(yīng)用,應(yīng)用沒(méi)有綁定服務(wù)。注:某些服務(wù)的結(jié)果發(fā)音需要tts服務(wù),需要在控制臺(tái)創(chuàng)建語(yǔ)音合成實(shí)例綁定應(yīng)用后方能使用。 |
111 | 開(kāi)發(fā)者賬號(hào)無(wú)效 |
112 | 請(qǐng)求服務(wù)無(wú)效 |
113 | q不能為空 |
114 | 不支持的圖片傳輸方式 |
201 | 解密失敗,可能為DES,BASE64,URLDecode的錯(cuò)誤 |
202 | 簽名檢驗(yàn)失敗,如果確認(rèn)應(yīng)用ID和應(yīng)用密鑰的正確性,仍返回202,一般是編碼問(wèn)題。請(qǐng)確保翻譯文本 q 為UTF-8編碼. |
203 | 訪(fǎng)問(wèn)IP地址不在可訪(fǎng)問(wèn)IP列表 |
205 | 請(qǐng)求的接口與應(yīng)用的平臺(tái)類(lèi)型不一致,確保接入方式(Android SDK、IOS SDK、API)與創(chuàng)建的應(yīng)用平臺(tái)類(lèi)型一致。如有疑問(wèn)請(qǐng)參考入門(mén)指南 |
206 | 因?yàn)闀r(shí)間戳無(wú)效導(dǎo)致簽名校驗(yàn)失敗 |
207 | 重放請(qǐng)求 |
16001 | noitn參數(shù)錯(cuò)誤 |
4000000 | q不正確 |
4000001 | 文件大小不匹配 |
4000002 | 文件為空 |
4000003 | 文件名稱(chēng)為空 |
4000004 | 不支持的格式 |
4000005 | sliceNum不正確 |
4000006 | sliceId不正確 |
4000007 | 不支持的文件大小 |
4000008 | 不支持的語(yǔ)言 |
4000009 | 任務(wù)不存在 |
4000010 | 文件上傳失敗 |
4000011 | 文件大小校驗(yàn)錯(cuò)誤 |
4000017 | 熱詞非法 |
4035001 | 轉(zhuǎn)寫(xiě)結(jié)果下載失敗 |