實(shí)時(shí)短語(yǔ)音識(shí)別 API 簡(jiǎn)介
概念解釋
實(shí)時(shí)短語(yǔ)音識(shí)別：針對(duì)短音頻（時(shí)長(zhǎng)小于等于 60 秒），實(shí)時(shí)返回結(jié)果。適用于簡(jiǎn)短的語(yǔ)音指令、快速的消息記錄，或其他類型的短語(yǔ)音片段，確保了在各種短語(yǔ)音交互場(chǎng)景下的高準(zhǔn)確率和穩(wěn)定性。
說明
Hi，您好，歡迎使用有道智云實(shí)時(shí)短語(yǔ)音識(shí)別API接口服務(wù)。
如果您想快速體驗(yàn)服務(wù)，建議您前往 語(yǔ)音識(shí)別體驗(yàn)中心 或者在體驗(yàn)中心右下側(cè)找到小程序二維碼，掃描進(jìn)行體驗(yàn)。
本文檔主要針對(duì)需要集成API的技術(shù)開發(fā)工程師，詳細(xì)描述實(shí)時(shí)短語(yǔ)音識(shí)別能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務(wù)合作的需求，可以通過以下方式聯(lián)系我們：
商務(wù)郵箱： AIcloud_Business@corp.youdao.com
如果您對(duì)文檔內(nèi)容有任何疑問，可以通過以下幾種方式聯(lián)系我們：
客服QQ：1906538062
智云語(yǔ)音技術(shù)交流QQ群：861723255
聯(lián)系郵箱： zhiyun@corp.youdao.com
溫馨提示：
接口說明
接口地址：
wss://openapi.youdao.com/stream_shortasropenapi?{請(qǐng)求參數(shù)}
語(yǔ)音支持：
格式支持：wav（不壓縮、pcm編碼）
采樣率：推薦16k。
編碼：16bit位深的單聲道
注：
發(fā)送時(shí)，第一幀需要為WAV HEADER 信息。
接口調(diào)用參數(shù)
服務(wù)接口的調(diào)用分為認(rèn)證、實(shí)時(shí)通信兩階段。
1. 認(rèn)證階段
請(qǐng)求參數(shù)格式：
key1=value1&key2=value2&key3=value3&key4=value4
參數(shù)說明：
| 參數(shù) |
類型 |
必填 |
說明 |
示例 |
| appKey |
String |
是 |
已申請(qǐng)的應(yīng)用ID |
ID |
| salt |
String |
是 |
UUID |
uuid，唯一通用識(shí)別碼 |
| curtime |
String |
是 |
時(shí)間戳（秒） |
TimeStamp |
| sign |
String |
是 |
加密數(shù)字簽名。 |
sha256 |
| signType |
String |
是 |
數(shù)字簽名類型 |
v4 |
| langType |
String |
是 |
語(yǔ)言選擇，參考支持語(yǔ)言列表 |
zh-CHS |
| format |
String |
是 |
音頻格式，支持wav |
wav |
| channel |
String |
是 |
聲道，支持1（單聲道） |
1 |
| version |
String |
是 |
api版本 |
v1 |
| rate |
String |
是 |
采樣率 |
16000 |
簽名sign生成方法如下：
signType=v4；
sign=sha256(應(yīng)用ID+salt+curtime+應(yīng)用密鑰)。
服務(wù)端通過 text message 返回 json字符串的認(rèn)證結(jié)果，參數(shù)示例：
成功：
{
"result": [],
"action": "started",
"errorCode": "0"
}
失敗：
{
"result": "[]",
"action": "error",
"errorCode": "202"
}
參數(shù)說明：
| 參數(shù) |
類型 |
說明 |
| errorCode |
String |
狀態(tài)碼，詳見 錯(cuò)誤代碼列表 |
| action |
String |
狀態(tài)標(biāo)識(shí)。started：握手；recognition：識(shí)別；error：錯(cuò)誤,若輸出為sensitive：包含不合時(shí)宜詞匯，請(qǐng)根據(jù)實(shí)際返回結(jié)果按需處理 |
| result |
String |
識(shí)別結(jié)果數(shù)據(jù) |
2 實(shí)時(shí)通信階段
認(rèn)證成功之后，進(jìn)入實(shí)時(shí)通信階段，此階段客戶端發(fā)送音頻流和結(jié)束標(biāo)識(shí)，并接收轉(zhuǎn)寫結(jié)果或錯(cuò)誤。
2.1 發(fā)送音頻流
此階段客戶端通過 binary message 發(fā)送音頻流，內(nèi)容為音頻的二進(jìn)制數(shù)據(jù)，此過程的發(fā)送頻率將影響文字結(jié)果展示的實(shí)時(shí)性。
建議以 200ms 間隔發(fā)送音頻數(shù)據(jù)，若間隔超時(shí) 15s 以上，服務(wù)端將停止識(shí)別。
2.2 發(fā)送結(jié)束標(biāo)識(shí)
客戶端完成所有音頻數(shù)據(jù)的發(fā)送后，需發(fā)送一個(gè)特殊的 binary message 到服務(wù)端作為音頻流發(fā)送結(jié)束的標(biāo)識(shí)，內(nèi)容為：
{"end": "true"}
注：該標(biāo)識(shí)大小寫敏感。
2.3 接收轉(zhuǎn)寫結(jié)果
交互過程中，服務(wù)端不斷通過 text message 返回實(shí)時(shí)識(shí)別結(jié)果到客戶端，響應(yīng)結(jié)果是以json形式輸出（為text message）。
識(shí)別結(jié)果示例：
{
"result": [{
"st": [{
"bg": 30,
"ed": 480,
"ws": [{
"w": "Have",
"wb": 30,
"we": 240
}, {
"w": "a",
"wb": 240,
"we": 270
}, {
"w": "good",
"wb": 270,
"we": 480
}, {
"w": "day.",
"wb": 480,
"we": 480
}]
}],
"seg_id": 0
}],
"errorCode": "0",
"action": "recognition"
}
識(shí)別結(jié)果 result 參數(shù)說明：
| 參數(shù) |
含義 |
說明 |
| bg |
分句開始時(shí)間 |
單位毫秒/ms |
| ed |
分句結(jié)束時(shí)間 |
單位毫秒/ms |
| w |
詞（字）識(shí)別結(jié)果 |
|
| wb |
詞（字）開始時(shí)間 |
單位毫秒/ms |
| we |
詞（字）結(jié)束時(shí)間 |
單位毫秒/ms |
| type |
識(shí)別結(jié)果類型 |
0：最終結(jié)果，1：中間結(jié)果 |
| seg_id |
分句 id |
從 0 開始遞增 |
支持語(yǔ)言
| language |
語(yǔ)種（中文） |
語(yǔ)言代碼 |
| English (United States) |
英語(yǔ) |
en |
| Chinese, Mandarin (Simplified, China) |
中文、普通話(簡(jiǎn)體、中國(guó)) |
zh-CHS |
服務(wù)配置
| 支持格式 |
免費(fèi)用戶最大支持并發(fā) |
單次最大請(qǐng)求時(shí)長(zhǎng)（s） |
每小時(shí)最大音頻時(shí)長(zhǎng)（s） |
每小時(shí)最大連接次數(shù) |
支持語(yǔ)言 |
| wav |
10 |
3600 |
60000 |
3000 |
中/英等，參考詳細(xì)語(yǔ)言列表 |
注意：如需上調(diào)調(diào)用量請(qǐng)聯(lián)系技術(shù)人員咨詢。
錯(cuò)誤代碼列表
| 錯(cuò)誤碼 |
含義 |
| 101 |
缺少必填的參數(shù)，首先確保必填參數(shù)齊全，然后，確認(rèn)參數(shù)書寫是否正確 |
| 102 |
不支持的語(yǔ)言類型 |
| 103 |
翻譯文本過長(zhǎng) |
| 104 |
不支持的API類型 |
| 105 |
不支持的簽名類型 |
| 106 |
不支持的響應(yīng)類型 |
| 107 |
不支持的傳輸加密類型 |
| 108 |
應(yīng)用ID無效，注冊(cè)賬號(hào)，登錄后臺(tái)創(chuàng)建應(yīng)用和實(shí)例并完成綁定，可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
| 109 |
batchLog格式不正確 |
| 110 |
無相關(guān)服務(wù)的有效實(shí)例，應(yīng)用沒有綁定服務(wù)實(shí)例，可以新建服務(wù)實(shí)例，綁定服務(wù)實(shí)例。注：某些服務(wù)的結(jié)果發(fā)音需要tts實(shí)例，需要在控制臺(tái)創(chuàng)建語(yǔ)音合成實(shí)例綁定應(yīng)用后方能使用。 |
| 111 |
開發(fā)者賬號(hào)無效 |
| 112 |
請(qǐng)求服務(wù)無效 |
| 113 |
q不能為空 |
| 114 |
不支持的圖片傳輸方式 |
| 201 |
解密失敗，可能為DES,BASE64,URLDecode的錯(cuò)誤 |
| 202 |
簽名檢驗(yàn)失敗，請(qǐng)確認(rèn)應(yīng)用ID和應(yīng)用密鑰的正確性。 |
| 203 |
訪問IP地址不在可訪問IP列表 |
| 205 |
請(qǐng)求的接口與應(yīng)用的平臺(tái)類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應(yīng)用平臺(tái)類型一致。如有疑問請(qǐng)參考入門指南 |
| 206 |
因?yàn)闀r(shí)間戳無效導(dǎo)致簽名校驗(yàn)失敗 |
| 207 |
重放請(qǐng)求 |
| 301 |
辭典查詢失敗 |
| 302 |
翻譯查詢失敗 |
| 303 |
服務(wù)端的其它異常 |
| 304 |
會(huì)話閑置太久超時(shí) |
| 401 |
賬戶已經(jīng)欠費(fèi)停 |
| 402 |
offlinesdk不可用 |
| 411 |
訪問頻率受限,請(qǐng)稍后訪問 |
| 412 |
長(zhǎng)請(qǐng)求過于頻繁，請(qǐng)稍后訪問 |
| 1001 |
無效的OCR類型 |
| 1002 |
不支持的OCR image類型 |
| 1003 |
不支持的OCR Language類型 |
| 1004 |
識(shí)別圖片過大 |
| 1201 |
圖片base64解密失敗 |
| 1301 |
OCR段落識(shí)別失敗 |
| 1411 |
訪問頻率受限 |
| 1412 |
超過最大識(shí)別字節(jié)數(shù) |
| 2003 |
不支持的語(yǔ)言識(shí)別Language類型 |
| 2004 |
合成字符過長(zhǎng) |
| 2005 |
不支持的音頻文件類型 |
| 2006 |
不支持的發(fā)音類型 |
| 2201 |
解密失敗 |
| 2301 |
服務(wù)的異常 |
| 2411 |
訪問頻率受限,請(qǐng)稍后訪問 |
| 2412 |
超過最大請(qǐng)求字符數(shù) |
| 3001 |
不支持的語(yǔ)音格式 |
| 3002 |
不支持的語(yǔ)音采樣率 |
| 3003 |
不支持的語(yǔ)音聲道 |
| 3004 |
不支持的語(yǔ)音上傳類型 |
| 3005 |
不支持的語(yǔ)言類型 |
| 3006 |
不支持的識(shí)別類型 |
| 3007 |
識(shí)別音頻文件過大 |
| 3008 |
識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng) |
| 3009 |
不支持的音頻文件類型 |
| 3010 |
不支持的發(fā)音類型 |
| 3201 |
解密失敗 |
| 3301 |
語(yǔ)音識(shí)別失敗 |
| 3302 |
語(yǔ)音翻譯失敗 |
| 3303 |
服務(wù)的異常 |
| 3411 |
訪問頻率受限,請(qǐng)稍后訪問 |
| 3412 |
超過最大請(qǐng)求字符數(shù) |
| 4001 |
不支持的語(yǔ)音識(shí)別格式 |
| 4002 |
不支持的語(yǔ)音識(shí)別采樣率 |
| 4003 |
不支持的語(yǔ)音識(shí)別聲道 |
| 4004 |
不支持的語(yǔ)音上傳類型 |
| 4005 |
不支持的語(yǔ)言類型 |
| 4006 |
識(shí)別音頻文件過大 |
| 4007 |
識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng) |
| 4201 |
解密失敗 |
| 4301 |
語(yǔ)音識(shí)別失敗 |
| 4303 |
服務(wù)的異常 |
| 4411 |
訪問頻率受限,請(qǐng)稍后訪問 |
| 4412 |
超過最大請(qǐng)求時(shí)長(zhǎng) |
| 5001 |
無效的OCR類型 |
| 5002 |
不支持的OCR image類型 |
| 5003 |
不支持的語(yǔ)言類型 |
| 5004 |
識(shí)別圖片過大 |
| 5005 |
不支持的圖片類型 |
| 5006 |
文件為空 |
| 5201 |
解密錯(cuò)誤，圖片base64解密失敗 |
| 5301 |
OCR段落識(shí)別失敗 |
| 5411 |
訪問頻率受限 |
| 5412 |
超過最大識(shí)別流量 |
| 9001 |
不支持的語(yǔ)音格式 |
| 9002 |
不支持的語(yǔ)音采樣率 |
| 9003 |
不支持的語(yǔ)音聲道 |
| 9004 |
不支持的語(yǔ)音上傳類型 |
| 9005 |
不支持的語(yǔ)音識(shí)別 Language類型 |
| 9301 |
ASR識(shí)別失敗 |
| 9303 |
服務(wù)器內(nèi)部錯(cuò)誤 |
| 9411 |
訪問頻率受限（超過最大調(diào)用次數(shù)） |
| 9412 |
超過最大處理語(yǔ)音長(zhǎng)度 |
| 10001 |
無效的OCR類型 |
| 10002 |
不支持的OCR image類型 |
| 10004 |
識(shí)別圖片過大 |
| 10201 |
圖片base64解密失敗 |
| 10301 |
OCR段落識(shí)別失敗 |
| 10411 |
訪問頻率受限 |
| 10412 |
超過最大識(shí)別流量 |
| 11001 |
不支持的語(yǔ)音識(shí)別格式 |
| 11002 |
不支持的語(yǔ)音識(shí)別采樣率 |
| 11003 |
不支持的語(yǔ)音識(shí)別聲道 |
| 11004 |
不支持的語(yǔ)音上傳類型 |
| 11005 |
不支持的語(yǔ)言類型 |
| 11006 |
識(shí)別音頻文件過大 |
| 11007 |
識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng)， |
| 11201 |
解密失敗 |
| 11301 |
語(yǔ)音識(shí)別失敗 |
| 11303 |
服務(wù)的異常 |
| 11411 |
訪問頻率受限,請(qǐng)稍后訪問 |
| 11412 |
超過最大請(qǐng)求時(shí)長(zhǎng) |
| 12001 |
圖片尺寸過大 |
| 12002 |
圖片base64解密失敗 |
| 12003 |
引擎服務(wù)器返回錯(cuò)誤 |
| 12004 |
圖片為空 |
| 12005 |
不支持的識(shí)別圖片類型 |
| 12006 |
圖片無匹配結(jié)果 |
| 13001 |
不支持的角度類型 |
| 13002 |
不支持的文件類型 |
| 13003 |
表格識(shí)別圖片過大 |
| 13004 |
文件為空 |
| 13301 |
表格識(shí)別失敗 |
| 15001 |
需要圖片 |
| 15002 |
圖片過大（1M） |
| 15003 |
服務(wù)調(diào)用失敗 |
| 17001 |
需要圖片 |
| 17002 |
圖片過大（1M） |
| 17003 |
識(shí)別類型未找到 |
| 17004 |
不支持的識(shí)別類型 |
| 17005 |
服務(wù)調(diào)用失敗 |
常見語(yǔ)言Demo
Java 示例
實(shí)時(shí)短語(yǔ)音識(shí)別 java demo
Python 示例
實(shí)時(shí)短語(yǔ)音識(shí)別 python3 demo
C# 示例
實(shí)時(shí)短語(yǔ)音識(shí)別 c# demo
Php 示例
實(shí)時(shí)短語(yǔ)音識(shí)別 php demo
go 示例
實(shí)時(shí)短語(yǔ)音識(shí)別 go demo
