Skip to main content

Paraformer リアルタイム音声認識クライアントイベント

2 つの WebSocket クライアントイベントが、Paraformer リアルタイム音声認識タスクを制御します。 run-task はモデルおよび音声設定を使用してタスクを開始し、 finish-task は音声ストリームの完了後にタスクを終了します。このページでは、両方のイベントのメッセージ構造とフィールドセマンティクスについて説明します。

ユーザーガイド： モデルの詳細および選択に関するガイダンスについては、「Speech-to-text」をご参照ください。 イベントフロー： イベントのインタラクションシーケンスについては、「WebSocket API」をご参照ください。

run-task

説明： 音声認識タスクを開始し、モデル、音声フォーマット、サンプルレートなどのパラメーターを設定します。 送信タイミング： WebSocket 接続確立直後です。 応答イベント： 音声データを送信する前に、サーバーは必ず「task-started」イベントを返す必要があります。
headerobject（必須）

プロパティ

actionstring（必須）操作タイプです。run-task に設定します。task_idstring（必須）UUID 形式のクライアント生成タスク ID です。このタスクに関連する後続のイベントを関連付けるために使用されます。streamingstring（必須）duplex に設定します。
payloadobject（必須）

プロパティ

task_groupstring（必須）タスクグループです。audio に設定します。taskstring（必須）タスクタイプです。asr に設定します。functionstring（必須）関数タイプです。recognition に設定します。modelstring（必須）モデル名です。inputobject（必須）{} に設定します。parametersobject（必須）音声認識パラメーターです。

プロパティ

formatstring（必須）音声フォーマットです。有効な値：
  • pcm
  • wav
  • mp3
  • opus
  • speex
  • aac
  • amr
Paraformer は以下の制約を適用します。
  • opus および speex：Ogg カプセル化を使用する必要があります。
  • wav：PCM エンコーディングを使用する必要があります。
  • amr：AMR-NB のみサポートされます。
sample_rateinteger（必須）サンプルレート（Hz 単位）です。有効な値：
  • Paraformer（モデルによって異なります）：
    • paraformer-realtime-v2：任意のサンプルレート
    • paraformer-realtime-8k-v2：8000 Hz のみ
vocabulary_idstring（オプション）ホットワード語彙 ID です。disfluency_removal_enabledboolean（オプション）
このパラメーターは Paraformer のみがサポートします。
フィラー語をフィルターで除外するかどうかを指定します。デフォルト：falselanguage_hintsarray[string]（オプション）認識対象の音声言語です。デフォルト値はありません。設定しない場合、モデルが自動的に言語を検出します。有効な値：
  • Paraformer：
    • zh：中国語
    • en：英語
    • ja：日本語
    • yue：広東語
    • ko：韓国語
    • de：ドイツ語
    • fr：フランス語
    • ru：ロシア語
semantic_punctuation_enabledboolean（オプション）
このパラメーターは Paraformer v2 のみがサポートします。
セマンティクスに基づく文分割を有効にするかどうかを指定します。デフォルト：false
  • true：セマンティクスに基づく分割を有効にし、VAD に基づく分割を無効にします。
  • false（デフォルト）：VAD に基づく分割を有効にし、セマンティクスに基づく分割を無効にします。
セマンティクスに基づく分割は精度が高く、会議の文字起こしに適しています。VAD に基づく（Voice Activity Detection）分割は遅延が低く、インタラクティブなシナリオに適しています。max_sentence_silenceinteger（オプション）
  • このパラメーターは Paraformer v2 のみがサポートします。
  • semantic_punctuation_enabled が false に設定されている場合にのみ有効になります。
VAD に基づく文分割のサイレンスしきい値（ミリ秒単位）です。音声セグメント後のサイレンスがこのしきい値を超えると、現在の文が終了します。デフォルト：1300有効範囲：[200, 6000]multi_threshold_mode_enabledboolean（オプション）
  • このパラメーターは Paraformer v2 のみがサポートします。
  • semantic_punctuation_enabled が false に設定されている場合にのみ有効になります。
マルチしきい値モードを有効にするかどうかを指定します。有効にすると、このモードにより VAD に基づく分割で過度に長いセグメントが生成されるのを防ぎます。デフォルト：falsepunctuation_prediction_enabledboolean（オプション）
このパラメーターは Paraformer v2 のみがサポートします。
認識結果に句読点を追加するかどうかを指定します。デフォルト：trueheartbeatboolean（オプション）
このパラメーターは Paraformer v2 のみがサポートします。
ハートビートパケットを有効にするかどうかを指定します。デフォルト：false
  • true：サイレント音声のみを送信している場合でも接続を維持します。
  • false（デフォルト）：サイレント音声を継続的に送信していても、一定時間経過後に接続がタイムアウトして閉じられます。
inverse_text_normalization_enabledboolean（オプション）
このパラメーターは Paraformer v2 のみがサポートします。
Inverse Text Normalization（ITN）を有効にするかどうかを指定します。有効にすると、漢数字がアラビア数字に変換されます。デフォルト：true
{
    "header": {
        "action": "run-task",
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "streaming": "duplex"
    },
    "payload": {
        "task_group": "audio",
        "task": "asr",
        "function": "recognition",
        "model": "paraformer-realtime-v2",
        "parameters": {
            "format": "pcm",
            "sample_rate": 16000,
            "disfluency_removal_enabled": false,
            "language_hints": [
                "en"
            ]
        },
        "input": {}
    }
}

finish-task

説明： すべての音声データの送信が完了したことをサーバーに通知し、タスクの終了をリクエストします。 送信タイミング： すべての音声データの送信後です。 応答イベント： サーバーは「task-finished」イベントを返します。
headerobject（必須）

プロパティ

actionstring（必須）操作タイプです。finish-task に設定します。task_idstring（必須）UUID 形式のクライアント生成タスク ID です。「run-task」イベントで使用した task_id と一致している必要があります。streamingstring（必須）duplex に設定します。
payloadobject（必須）

プロパティ

inputobject（必須）{} に設定します。
{
    "header": {
        "action": "finish-task",
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "streaming": "duplex"
    },
    "payload": {
        "input": {}
    }
}