このトピックでは、DashScope Python SDK を使用して Qwen-TTS-Realtime シリーズのモデルを呼び出す際の、主要なインターフェースとリクエストパラメーターを説明します。
前提条件
DashScope Python SDK のバージョンは 2.0.1 以降である必要があります。
クイックスタート
import os
import base64
import time
from concurrent.futures import ThreadPoolExecutor
import dashscope
text_to_synthesize = [
'Right? I love supermarkets like this.',
'Especially during Chinese New Year,',
'I go shopping at supermarkets.',
'And I feel',
'absolutely thrilled!',
'I want to buy so many things!'
]
# API キーは、シンガポールリージョンと北京リージョンで異なります。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
# 環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えてください: api_key="sk-xxx"
client = dashscope.Client(
api_key=os.getenv("DASHSCOPE_API_KEY"),
# 以下はシンガポール (ap-southeast-1) リージョンの設定です。呼び出す際に、"{WorkspaceId}" を実際のワークスペース ID に置き換えてください。設定はリージョンによって異なります。
workspace="{WorkspaceId}",
region="ap-southeast-1",
)
# 受信スレッド:サーバーイベントを反復処理し、音声をファイルに増分書き込みします
def receive_events(session):
with open('result_24k.pcm', 'wb') as f:
for event in session.events():
event_type = event.get('type')
if event_type == 'session.created':
print('start session: {}'.format(event['session']['id']))
elif event_type == 'response.audio.delta':
f.write(base64.b64decode(event['delta']))
elif event_type == 'response.done':
print(f'response {session.last_response_id} done')
elif event_type == 'session.finished':
print('session finished')
if __name__ == '__main__':
print('Initializing ...')
# リアルタイム音声合成セッションを作成します:with コンテキストに入ると自動的に接続が確立されます
with client.audio.realtime.connect(
model='qwen3-tts-flash-realtime',
) as session:
session.update_session(
output_modalities=['audio'],
voice='Cherry',
response_format='pcm',
sample_rate=24000,
mode='server_commit'
)
with ThreadPoolExecutor(max_workers=1) as pool:
receiver = pool.submit(receive_events, session)
for text_chunk in text_to_synthesize:
print(f'send text: {text_chunk}')
session.send_event({'type': 'input_text_buffer.append', 'text': text_chunk})
time.sleep(0.1)
# サーバーに入力完了を通知します (server_commit モードでは、サーバーが合成タイミングを決定します)
session.end_session()
receiver.result()
print('[Metric] session: {}, first audio delay: {}'.format(
session.session_id,
session.last_first_audio_delay,
))
import os
import base64
import time
from concurrent.futures import ThreadPoolExecutor
import dashscope
text_to_synthesize = [
'This is the first sentence.',
'This is the second sentence.',
'This is the third sentence.',
]
# API キーは、シンガポールリージョンと北京リージョンで異なります。API キーの取得: https://www.alibabacloud.com/help/model-studio/get-api-key
# 環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えてください: api_key="sk-xxx"
client = dashscope.Client(
api_key=os.getenv("DASHSCOPE_API_KEY"),
# 以下はシンガポール (ap-southeast-1) リージョンの設定です。呼び出す際に、"{WorkspaceId}" を実際のワークスペース ID に置き換えてください。設定はリージョンによって異なります。
workspace="{WorkspaceId}",
region="ap-southeast-1",
)
# 受信スレッド:サーバーイベントを反復処理し、音声をファイルに増分書き込みします
def receive_events(session):
with open('result_24k.pcm', 'wb') as f:
for event in session.events():
event_type = event.get('type')
if event_type == 'session.created':
print('start session: {}'.format(event['session']['id']))
elif event_type == 'response.audio.delta':
f.write(base64.b64decode(event['delta']))
elif event_type == 'response.done':
print(f'response {session.last_response_id} done')
elif event_type == 'session.finished':
print('session finished')
if __name__ == '__main__':
print('Initializing ...')
# リアルタイム音声合成セッションを作成します:with コンテキストに入ると自動的に接続が確立されます
with client.audio.realtime.connect(
model='qwen3-tts-flash-realtime',
) as session:
session.update_session(
output_modalities=['audio'],
voice='Cherry',
response_format='pcm',
sample_rate=24000,
mode='commit'
)
with ThreadPoolExecutor(max_workers=1) as pool:
receiver = pool.submit(receive_events, session)
for text in text_to_synthesize:
print(f'send text: {text}')
session.send_event({'type': 'input_text_buffer.append', 'text': text})
# commit モードでは、クライアントが合成をトリガーします
session.send_event({'type': 'input_text_buffer.commit'})
time.sleep(0.1)
session.end_session()
receiver.result()
print('[Metric] session: {}, first audio delay: {}'.format(
session.session_id,
session.last_first_audio_delay,
))
詳細については、GitHub にアクセスして、追加のサンプルコードをダウンロードしてください。
リクエストパラメーター
以下のリクエストパラメーターは client.audio.realtime の connect メソッドで設定します。
パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
model | str | はい | モデル名 (「サポートされているモデル」をご参照ください)。 |
ws_url | str | いいえ | セッションエンドポイントです。省略した場合、Client の構築パラメーター |
以下のリクエストパラメーターはセッションの update_session メソッドで設定します(具名パラメーターは直接渡され、その他のパラメーターは session.update イベントの session オブジェクトに透過されます)。
パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
voice | str | はい | 音声合成に使用する音声です。詳細については、「Qwen-TTS ボイスリスト」をご参照ください。 |
language_type | str | いいえ | 合成オーディオの言語です。デフォルト値は
|
mode | str | いいえ | インタラクションパターンです。有効な値は以下のとおりです。
|
response_format | str | いいえ | モデルからのオーディオ出力フォーマットです。 サポートされるフォーマット:
|
sample_rate | int | いいえ | モデルからのオーディオ出力のサンプルレート (Hz) です。 サポートされるサンプルレート:
|
speech_rate | float | いいえ | オーディオの話速です。1.0 が通常速度です。1.0 未満は低速、1.0 より大きい値は高速になります。 デフォルト値:1.0 有効範囲:[0.5, 2.0] |
volume | int | いいえ | オーディオのボリュームです。 有効範囲:[0, 100] |
pitch_rate | float | いいえ | 合成オーディオのピッチです。 デフォルト値:1.0 有効範囲:[0.5, 2.0] |
bit_rate | int | いいえ | ビットレート (kbps) です。ビットレートが高いほどオーディオ品質が向上し、ファイルサイズも大きくなります。このパラメーターは、オーディオフォーマット ( デフォルト値:128 有効範囲:[6, 510] |
API リファレンス
セッション(RealtimeSession)
リアルタイム音声合成セッションは client.audio.realtime.connect(model=...) で作成されます。with コンテキストに入ると自動的に接続が確立されます(セッションの connect() メソッドを手動で呼び出すこともできます)。
メソッドシグネチャ | サーバー応答イベント( | 説明 |
|---|---|---|
|
| サーバーとの接続を作成します。 |
|
| デフォルトのセッション構成を更新します。パラメーターの詳細については、「Request parameters」をご参照ください。 接続後、サーバーはデフォルトの入力構成と出力構成を返します。接続直後にこのメソッドを呼び出し、これらのデフォルト設定を更新します。 サーバーは session.update イベントを受信した時点でパラメーターを検証します。検証に失敗した場合はエラーを返し、成功した場合はセッション構成を更新します。 |
| None | 生のイベントを送信します。テキスト入力は
|
|
|
|
|
| クラウドバッファー内のテキストをすべてコミットし、直ちに音声合成します。バッファーが空の場合はエラーを返します。
|
|
| session.finish イベントを送信してタスクを終了します。その後も |
| None | 接続を閉じます。 |
| None | 現在のタスクの session_id を取得します。 |
| None | 直近の response の response_id を取得します。 |
| None | 最初の音声パケットの遅延を取得します。 |
イベント反復(events())
サーバーは、イベントを通じてサーバー応答イベントとデータをクライアントに返します。受信スレッドでセッションの events() を反復処理してサーバーイベントを処理します。session.finished イベントの後に反復が終了します。error イベントは DashScopeError 例外としてスローされるため、try/except で捕捉できます。
メソッド | パラメーター | 戻り値 | 説明 |
|---|---|---|---|
| event:サーバー応答イベント( | 反復子 | API 呼び出しへの応答とモデルが生成したテキスト、オーディオが含まれます。 |
| event:サーバー応答イベント( | イベントまたは | サーバーイベントを 1 件読み取ります。正常に閉じられた後は |