Skip to main content

WebSocket API

WebSocket 接続を介して Paraformer リアルタイム音声認識サービスにアクセスできます。本トピックでは、サービスエンドポイント、リクエストヘッダー、およびインタラクションフローについて説明します。

Alibaba Cloud Model Studio は、中国 (北京) リージョン向けにワークスペース専用ドメインをリリースしました。この新しい専用ドメインは、推論リクエストに対して優れたパフォーマンスと高い安定性を提供します。そのため、dashscope.aliyuncs.com から {WorkspaceId}.cn-beijing.maas.aliyuncs.com への移行を推奨します。{WorkspaceId} は、ご利用のワークスペース ID に置き換えてください。既存のドメインは引き続き完全に機能します。
本ドキュメントは、中国 (北京) リージョンにのみ適用されます。モデルを使用するには、中国 (北京) リージョンの API キー を使用する必要があります。
ユーザーガイド： モデルの概要および選定ガイドについては、「音声認識」をご参照ください。サンプルコードについては、「リアルタイム音声認識」をご参照ください。 DashScope SDK は現在、Java および Python のみをサポートしています。その他の言語の場合は、WebSocket を介して直接サービスに接続してください。

サービスエンドポイント

Paraformer は中国 (北京) リージョンでのみ利用可能です。WebSocket URL は以下のとおり固定されています。 wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference {WorkspaceId} は、ご利用のワークスペース ID に置き換えてください。
URL は wss:// プロトコルを使用する必要があります。認証情報は Authorization リクエストヘッダーで指定してください（「リクエストヘッダー」を参照）。

リクエストヘッダー

リクエストヘッダーに以下のフィールドを追加してください。

パラメーター

タイプ

必須

説明

Authorization

文字列

はい

Bearer <your_api_key> 形式の認証トークンです。<your_api_key> は、ご利用の API キーに置き換えてください。

user-agent

文字列

いいえ

クライアント識別子です。サーバーが受信リクエストのソースを識別するのに役立ちます。

X-DashScope-WorkSpace

文字列

いいえ

Alibaba Cloud Model Studio のワークスペース ID です。

X-DashScope-DataInspection

文字列

いいえ

データ検査を有効にするかどうかを指定します。デフォルトではこのヘッダーを省略し、必要な場合にのみ enable に設定してください。

Authorization ヘッダーは WebSocket ハンドシェイク中に検証されます。API キーが無効または欠落している場合、ハンドシェイクは HTTP 401 または 403 エラーで失敗します。

インタラクションフロー

クライアント側およびサーバー側のイベントの詳細については、「クライアントイベント」および「サーバー送信イベント」をご参照ください。 クライアントとサーバーは、以下のシーケンスでやり取りを行います。
  1. 接続の確立：クライアントがサーバーに対して WebSocket 接続を開きます。
  2. タスクの開始：クライアントが run-task 命令を送信します。サーバーは task-started イベントを返してタスクが開始されたことを確認し、その後のステップに進みます。
  3. 音声ストリームの送信：クライアントがモノラルのバイナリ音声をストリーミングします。サーバーは認識結果を含む result-generated イベントを返します。
  4. タスク終了の通知：クライアントが finish-task 命令を送信し、引き続きサーバーから result-generated イベントを受信します。
  5. タスクの終了：クライアントがサーバーから task-finished イベントを受信し、タスクが終了したことを示します。
  6. 接続の終了：クライアントが WebSocket 接続を閉じます。