Skip to main content

リアルタイム音声認識のサーバー送信イベント（Paraformer）

Paraformer リアルタイム音声認識サービスが WebSocket を介してクライアントにプッシュするサーバー送信イベントのリファレンスです。本トピックでは、task-started、result-generated、task-finished、task-failed の4つのイベントタイプのデータ構造とフィールドの意味について説明します。

ユーザーガイド： モデルの詳細と選択のガイダンスについては、音声文字変換を参照してください。 イベントインタラクションフロー： イベントシーケンス図については、WebSocket APIを参照してください。

task-started

説明：タスクが正常に開始されました。クライアントはオーディオデータの送信を開始できます。
headerobject

プロパティ

task_idstringクライアント生成のタスク ID（UUID 形式）。eventstringイベントタイプ。常に task-started です。attributesobject追加属性。通常は空です。
payloadobject常に {} です。
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-started",
        "attributes": {}
    },
    "payload": {}
}

result-generated

説明：認識結果です。中間結果（sentence_end=false）と最終結果（sentence_end=true）が含まれます。
headerobject

プロパティ

task_idstringクライアント生成のタスク ID（UUID 形式）。eventstringイベントタイプ。常に result-generated です。
payloadobject

プロパティ

outputobject

プロパティ

usageobjectpayload.output.sentence.sentence_end が false の場合（現在の文が終了していない）、usage は null になります。payload.output.sentence.sentence_end が true の場合（現在の文が終了している）、usage.duration は現在のタスクの課金対象期間を示します。

プロパティ

durationinteger課金対象のタスク期間（秒単位）。

プロパティ

sentenceobject

プロパティ

begin_timeinteger文の開始時刻（ミリ秒単位）。end_timeinteger文の終了時刻（ミリ秒単位）。textstring認識されたテキスト。heartbeatbooleantrue の場合、この結果（ハートビートパケット）をスキップできます。sentence_endboolean文が終了したかどうか（true=最終結果、false=中間結果）。emo_tagstring
  • この機能は paraformer-realtime-8k-v2 のみがサポートしています。
  • この機能を使用するには、セマンティックセグメンテーションを無効にする必要があります。run-task イベントで semantic_punctuation_enabled を false に設定してください。
  • 感情認識結果は、payload.output.sentence.sentence_end が true の場合にのみ返されます。
現在の文の感情：
  • positive：喜びや満足などのポジティブな感情。
  • negative：怒りや落胆などのネガティブな感情。
  • neutral：明確な感情はありません。
emo_confidencefloat
  • この機能は paraformer-realtime-8k-v2 のみがサポートしています。
  • この機能を使用するには、セマンティックセグメンテーションを無効にする必要があります。run-task イベントで semantic_punctuation_enabled を false に設定してください。
  • 感情認識結果は、payload.output.sentence.sentence_end が true の場合にのみ返されます。
[0.0, 1.0] の範囲の感情信頼度スコア。値が高いほど信頼度が高いことを示します。wordsarray[object]単語レベルのタイムスタンプ情報。

プロパティ

begin_timeinteger単語の開始時刻（ミリ秒単位）。end_timeinteger単語の終了時刻（ミリ秒単位）。textstring認識されたテキスト。punctuationstring句読点。
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": null,
        "text": "Okay, I got it.",
        "heartbeat": false,
        "sentence_end": true,
        "words": [
          {
            "begin_time": 170,
            "end_time": 295,
            "text": "Okay",
            "punctuation": ","
          },
          {
            "begin_time": 295,
            "end_time": 503,
            "text": "I",
            "punctuation": ""
          },
          {
            "begin_time": 503,
            "end_time": 711,
            "text": "got",
            "punctuation": ""
          },
          {
            "begin_time": 711,
            "end_time": 920,
            "text": "it",
            "punctuation": ""
          }
        ]
      }
    },
    "usage": {
      "duration": 3
    }
  }
}

task-finished

説明：タスクは正常に終了しました。接続を閉じるか、再利用できます。
headerobject

プロパティ

task_idstringクライアント生成のタスク ID（UUID 形式）。eventstringイベントタイプ。常に task-finished です。attributesobject追加属性。通常は空です。
payloadobject内容は無視できます。通常は {} です。
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-finished",
        "attributes": {}
    },
    "payload": {
        "output": {},
        "usage": null
    }
}

task-failed

説明：タスクが失敗しました。接続は閉じられ、再利用できません。
headerobject

プロパティ

task_idstringクライアント生成のタスク ID（UUID 形式）。eventstringイベントタイプ。常に task-failed です。error_codestringエラータイプの説明。error_messagestringエラーの具体的な原因。attributesobject追加属性。通常は空です。
payloadobject常に {} です。
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-failed",
        "error_code": "CLIENT_ERROR",
        "error_message": "request timeout after 23 seconds.",
        "attributes": {}
    },
    "payload": {}
}