本文介紹Qwen-Audio-3.0-ASR-Flash-Streaming/Fun-ASR-Realtime即時語音辨識Python SDK的參數和介面細節。
使用者指南:關於模型介紹和選型建議請參見語音辨識。
Recognition類提供了非流式調用和雙向流式調用等介面。請根據實際需求選擇合適的調用方式:
提交單個語音即時轉寫任務,通過傳入本地檔案的方式同步阻塞地拿到轉寫結果。
執行個體化Recognition類綁定請求參數,調用
提交單個語音即時轉寫任務,通過實現回調介面的方式流式輸出即時識別結果。
SDK的介面地址需在初始化前設定為下方地址(包含WorkspaceId)。如需切換到其他地區,請修改
切換到新加坡地區:
請求參數通過Recognition類的構造方法(init)進行設定。
以下參數通過
雙向流式調用時,服務端會通過回調的方式,將關鍵流程資訊和資料返回給用戶端。您需要實現回調方法,處理服務端返回的資訊或者資料。
Sentence類成員如下:
Word類成員如下:
如遇報錯問題,請參見錯誤碼進行排查。
若問題仍未解決,請加入開發人員群反饋遇到的問題,並提供Request ID,以便進一步排查問題。
將請求參數
可使用FFmpeg工具,更多用法請參見FFmpeg官網。
識別本地檔案有兩種方式:
前提條件
快速開始
Recognition類提供了非流式調用和雙向流式調用等介面。請根據實際需求選擇合適的調用方式:
- 非流式調用:針對本地檔案進行識別,並一次性返回完整的處理結果。適合處理錄製好的音頻。
- 雙向流式調用:可直接對音頻流進行識別,並即時輸出結果。音頻流可以來自外部裝置(如麥克風)或從本地檔案讀取。適合需要即時反饋的情境。
非流式調用
提交單個語音即時轉寫任務,通過傳入本地檔案的方式同步阻塞地拿到轉寫結果。
執行個體化Recognition類綁定請求參數,調用call進行識別/翻譯並最終擷取識別結果(RecognitionResult)。
點擊查看完整樣本
點擊查看完整樣本
雙向流式調用
提交單個語音即時轉寫任務,通過實現回調介面的方式流式輸出即時識別結果。
-
啟動流式語音辨識
執行個體化Recognition類綁定請求參數和回調介面(RecognitionCallback),調用
start方法啟動流式語音辨識。 -
串流
迴圈調用Recognition類的
send_audio_frame方法,將從本地檔案或裝置(如麥克風)讀取的二進位音頻流分段發送至服務端。 在發送音頻資料的過程中,服務端會通過回調介面(RecognitionCallback)的on_event方法,將識別結果即時返回給用戶端。 建議每次發送的音頻時間長度約為100毫秒,資料大小保持在1KB至16KB之間。 -
結束處理
調用Recognition類的
stop方法結束語音辨識。 該方法會阻塞當前線程,直到回調介面(RecognitionCallback)的on_complete或者on_error回調觸發後才會釋放線程阻塞。
點擊查看完整樣本
點擊查看完整樣本
介面地址
SDK的介面地址需在初始化前設定為下方地址(包含WorkspaceId)。如需切換到其他地區,請修改 dashscope.base_websocket_api_url為對應地區的URL。
- 新加坡
- 華北2(北京)
wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api-ws/v1/inference調用時請將{WorkspaceId}替換為真實的Workspace ID。請求參數
請求參數通過Recognition類的構造方法(init)進行設定。
| 參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| model | str | 是 | 指定模型名。支援Qwen-Audio-3.0-ASR-Flash-Streaming和Fun-ASR-Realtime系列模型,詳情請參見支援的模型與地區。 |
| sample_rate | int | 是 | 採樣率(Hz)。取值範圍:8k模型僅支援 8000 Hz,其他模型支援任意採樣率。 |
| format | str | 是 | 音頻格式。取值範圍:
|
| vocabulary_id | str | 否 | 先行編譯熱詞列表 ID。需預先調用建立熱詞列表介面產生,識別時傳入該 ID 即可使用列表中的熱詞。適用於詞彙已知且相對穩定、需要跨請求複用同一詞表的情境。使用方法請參見先行編譯熱詞。 |
| vocabulary | dict | 否 | 即時熱詞。以索引值對形式傳入,鍵為熱詞文本(string),值為熱詞權重(integer),無需預先建立熱詞列表。權重取值範圍為 [1, 5] 或 50:取 [1, 5] 時值越大模型越傾向輸出該詞;取 50 時為超級熱詞,召回率大幅提升,但超級熱詞數量最多不超過 50 個。適用於臨時性、會話層級的熱詞最佳化。與先行編譯熱詞同時配置時,僅即時熱詞生效。使用方法請參見即時熱詞。樣本: |
| semantic_punctuation_enabled | bool | 否 | 是否啟用語義斷句。預設值:False。
|
| max_sentence_silence | int | 否 | VAD 斷句靜音閾值(ms)。當一段語音後的靜音時間長度超過該閾值時,系統會判定該句子已結束。當semantic_punctuation_enabled為true時,不作為sentence_end返回依據,但設定過小可能會影響識別效果。預設值:1300。取值範圍:[200, 6000]。 |
| multi_threshold_mode_enabled | bool | 否 | 是否啟用多閾值模式。啟用後可防止 VAD 斷句切割過長。預設值:False。 |
| punctuation_prediction_enabled | bool | 否 | 設定是否在識別結果中自動添加標點:
|
| heartbeat | bool | 否 | 是否啟用心跳包。預設值:False。
|
| language_hints | list[str] | 否 | 待識別音頻語種。無預設值,不設定時模型自動識別。對於 Qwen-Audio-3.0-ASR-Flash-Streaming 系列模型,最多支援設定 4 個值,即便設定超出 4 個,也僅前 4 個生效;對於 Fun-ASR-Realtime 系列模型,僅支援設定 1 個值,即便設定多個,也僅第一個生效。
點擊查看支援的語言代碼
|
| speech_noise_threshold | float | 否 | 語音與噪音的判定閾值,用於調整語音活動檢測(VAD)的靈敏度。取值範圍:[-1.0, 1.0]。取值說明:
|
| special_word_filter | str | 否 | 指定在語音辨識過程中需要處理的敏感詞,並支援對不同敏感詞設定不同的處理方式。詳情請參見敏感詞過濾。 |
| callback | RecognitionCallback | 否 | 回調介面(RecognitionCallback)。 |
Recognition執行個體的call或start方法的關鍵字參數傳入。
| 參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| raw_input | dict | 否 | 輸入對象,用於傳入對話上下文(context)。上下文用於輔助識別、提升專有詞彙的識別準確率。使用方法詳見快速開始。dict 中需包含 context 鍵,值為訊息列表(list[dict]),每條訊息包含以下欄位:
使用該欄位時,SDK版本不能低於1.25.23。 raw_input通過Recognition執行個體的start或call方法傳入: |
關鍵介面
Recognition類
Recognition通過“from dashscope.audio.asr import *”方式引入。
| 成員方法 | 方法簽名 | 說明 |
|---|---|---|
| call | 基於本地檔案的非流式調用,該方法會阻塞當前線程直到全部音頻讀完,該方法要求所識別檔案具有可讀許可權。識別結果以RecognitionResult類型資料返回。 | |
| start | 開始語音辨識。基於回調形式的流式即時識別,該方法不會阻塞當前線程。需要配合send_audio_frame和stop使用。 | |
| send_audio_frame | 推送音頻。每次推送的音頻流不宜過大或過小,建議每包音頻時間長度為100ms左右,大小在1KB~16KB之間。識別結果通過回調介面(RecognitionCallback)的on_event方法擷取。 | |
| stop | 停止語音辨識,阻塞到服務將收到的音頻都識別後結束任務。 | |
| get_last_request_id | 擷取request_id,在建構函式調用(建立對象)後可以使用。 | |
| get_first_package_delay | 擷取首包延遲,從發送第一包音頻到收到首包識別結果延遲,在任務完成後使用。 | |
| get_last_package_delay | 獲得尾包延遲,發送stop指令到最後一包識別結果下發耗時,在任務完成後使用。 | |
| get_response | 擷取最後一次報文,可以用於擷取task-failed報錯。 |
回調介面(RecognitionCallback)
雙向流式調用時,服務端會通過回調的方式,將關鍵流程資訊和資料返回給用戶端。您需要實現回調方法,處理服務端返回的資訊或者資料。
點擊查看樣本
點擊查看樣本
| 方法 | 參數 | 傳回值 | 描述 |
|---|---|---|---|
| 無 | 無 | 當和服務端建立串連完成後,該方法立刻被回調。 | |
result:識別結果(RecognitionResult) | 無 | 當服務有回複時會被回調。 | |
| 無 | 無 | 當所有識別結果全部返回後進行回調。 | |
result:識別結果(RecognitionResult) | 無 | 發生異常時該方法被回調。 | |
| 無 | 無 | 當服務已經關閉串連後進行回調。 |
響應結果
識別結果(RecognitionResult)
RecognitionResult代表雙向流式調用中一次即時識別或非流式調用的識別結果。
| 成員方法 | 方法簽名 | 說明 |
|---|---|---|
| get_sentence | 擷取當前識別的句子及時間戳記資訊。回調中返回的是單句資訊,所以此方法傳回型別為Dict[str, Any]。詳情請參見單句資訊(Sentence)。 | |
| get_request_id | 擷取請求的request_id。 | |
| is_sentence_end | 判斷給定句子是否已經結束。該方法通過檢查 sentence 中 end_time 欄位是否為 None 來判定——end_time 不為 None 時表示句子已結束。調用方式為 RecognitionResult.is_sentence_end(sentence),其中 sentence 為 get_sentence() 返回的單句資訊 dict,而非 Sentence 執行個體的布爾欄位。 |
單句資訊(Sentence)
Sentence類成員如下:
參數 | 類型 | 說明 |
|---|---|---|
begin_time | int | 句子開始時間,單位為ms。 |
end_time | int | 句子結束時間,單位為ms。 |
text | str | 識別文本。 |
words | 字時間戳記資訊(Word)的list集合 | 字時間戳記資訊。 |
字時間戳記資訊(Word)
Word類成員如下:
參數 | 類型 | 說明 |
|---|---|---|
begin_time | int | 字開始時間,單位為ms。 |
end_time | int | 字結束時間,單位為ms。 |
text | str | 字。 |
punctuation | str | 標點。 |
錯誤碼
如遇報錯問題,請參見錯誤碼進行排查。
若問題仍未解決,請加入開發人員群反饋遇到的問題,並提供Request ID,以便進一步排查問題。
常見問題
功能特性
Q:在長時間靜默的情況下,如何保持與服務端長串連?
將請求參數heartbeat設定為true,並持續向服務端發送靜音音頻。
靜音音頻指的是在音頻檔案或資料流中沒有聲音訊號的內容。靜音音頻可以通過多種方法產生,例如使用音頻編輯軟體如Audacity或Adobe Audition,或者通過命令列工具如FFmpeg。
Q:如何將音頻格式轉換為滿足要求的格式?
可使用FFmpeg工具,更多用法請參見FFmpeg官網。
Q:如何識別本地檔案(錄音檔案)?
識別本地檔案有兩種方式:
-
直接傳入本地檔案路徑:此種方式在最終識別結束後擷取完整識別結果,不適合即時反饋的情境。
參見非流式調用,在Recognition類的
call方法中傳入檔案路徑對錄音檔案直接進行識別。 -
將本地檔案轉成二進位流進行識別:此種方式一邊識別檔案一邊流式擷取識別結果,適合即時反饋的情境。
參見雙向流式調用,通過Recognition類的
send_audio_frame方法向服務端發送二進位流對其進行識別。
故障排查
Q:無法識別語音(無識別結果)是什麼原因?
-
請檢查請求參數中的音頻格式(
format)和採樣率(sampleRate/sample_rate)設定是否正確且符合參數約束。以下為常見錯誤樣本:- 音頻副檔名為 .wav,但實際為 MP3 格式,而請求參數
format設定為 mp3(參數設定錯誤)。 - 音頻採樣率為 3600Hz,但請求參數
sampleRate/sample_rate設定為 48000(參數設定錯誤)。
- 音頻副檔名為 .wav,但實際為 MP3 格式,而請求參數
- 若以上檢查均無問題,可通過定製熱詞提升對特定詞語的識別效果。