前期準備
DashScope Python SDK 版本需要不低於1.25.11。
快速開始
請求參數
下述請求參數可以通過QwenTtsRealtime的構造方法進行設定。
參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
model | str | 是 | 模型名稱。參見支援的模型。 |
url | str | 是 | 華北2(北京)地區: 新加坡地區: |
參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
voice | str | 是 | 語音合成所使用的音色。參見支援的音色。 支援系統音色和專屬音色:
|
language_type | str | 否 | 指定合成音訊語種,預設為
|
mode | str | 否 | 互動模式,可選值:
|
format | str | 否 | |
sample_rate | int | 否 | |
speech_rate | float | 否 | |
volume | int | 否 | |
pitch_rate | float | 否 | |
bit_rate | int | 否 | |
instructions | str | 否 | 設定指令,參見指令控制。 預設值:無預設值,不設定不生效。 長度限制:長度不得超過 1600 Token。 支援語言:僅支援中文和英文。 適用範圍:該功能僅適用於千問3-TTS-Instruct-Flash-Realtime系列模型。 |
optimize_instructions | bool | 否 | 是否對 預設值:False 行為說明:當設定為 True 時,系統將對 適用情境:推薦在追求高品質、精細化語音表達的情境下開啟。 依賴關係:此參數依賴於 適用範圍:該功能僅適用於千問3-TTS-Instruct-Flash-Realtime系列模型。 |
關鍵介面
QwenTtsRealtime類
QwenTtsRealtime通過from dashscope.audio.qwen_tts_realtime import QwenTtsRealtime方法引入。
| 方法簽名 | 服務端響應事件(通過回調下發) | 說明 |
|---|---|---|
session.created會話已建立session.updated 會話配置已更新 | 和服務端建立串連。 | |
session.updated會話配置已更新 | 更新本次會話互動的預設配置。參數配置請參考《請求參數》章節。在您建立連結,服務端會及時返回用於此會話的預設輸出輸入配置。如果您需要更新預設會話配置,我們也推薦您總是在建立連結後即刻調用此介面。服務端在收到session.update事件後,會進行參數校正,如果參數不合法則返回錯誤,否則更新服務端側的會話配置。 | |
| 無 | 將文本片段追加到雲端輸入文本緩衝區。 緩衝區是你可以寫入並稍後提交的臨時儲存。
| |
input_text_buffer.cleared清空服務端收到的文本 | 刪除當前雲端緩衝區的文本。 | |
input_text_buffer.committed提交文本並觸發語音合成response.output_item.added 響應時有新的輸出內容response.content_part.added 新的輸出內容添加到assistant message 項response.audio.delta 模型增量產生的音頻response.audio.done 完成音頻產生response.content_part.done Assistant message 的音頻內容流式輸出完成response.output_item.done Assistant message 的整個輸出項串流完成response.done 響應完成 | 提交之前通過append添加到雲端緩衝區的文本,並立刻合成所有文本。如果輸入的文本緩衝區為空白將產生錯誤。
| |
session.finished響應完成 | 終止任務。 | |
| 無 | 關閉串連。 | |
| 無 | 擷取當前任務的session_id。 | |
| 無 | 擷取最近一次response的response_id。 | |
| 無 | 擷取首包音頻延遲。 |
回調介面(QwenTtsRealtimeCallback)
服務端會通過回調的方式,將服務端響應事件和資料返回給用戶端。您需要實現回調方法,處理服務端返回的資訊或者資料。
通過from dashscope.audio.qwen_tts_realtime import QwenTtsRealtimeCallback引入。
| 方法 | 參數 | 傳回值 | 描述 |
|---|---|---|---|
| 無 | 無 | 當和服務端建立串連完成後,該方法立刻被回調。 | |
| message:服務端響應事件。 | 無 | 包括對介面調用的回複響應和模型產生的文本和音頻。具體可以參考:服務端事件 | |
| close_status_code:關閉WebSocket的狀態代碼。close_msg:關閉WebSocket的關閉資訊。 | 無 | 當服務已經關閉串連後進行回調。 |