即時語音辨識（Paraformer）服務端事件 - Alibaba Cloud Model Studio

本文介紹 Paraformer 即時語音辨識服務通過 WebSocket 推送給用戶端的服務端事件，包括 task-started、result-generated、task-finished、task-failed 四類事件的資料結構與欄位含義。

使用者指南：關於模型介紹和選型建議請參見語音辨識。

事件互動流程：如需瞭解事件互動時序，請參見WebSocket API。

task-started

說明：任務啟動成功，用戶端可開始發送音頻資料。

header object

屬性

task_id string

用戶端產生的任務 ID（UUID 格式）。

event string

事件類型，固定為 task-started。

attributes object

附加屬性（通常為空白）。

{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-started",
        "attributes": {}
    },
    "payload": {}
}

payload object

固定為{}。

result-generated

說明：識別結果，包含中間結果（sentence_end=false）和最終結果（sentence_end=true）。

header object

屬性

task_id string

用戶端產生的任務 ID（UUID 格式）。

event string

事件類型，固定為 result-generated。

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": null,
        "text": "好，我知道了",
        "heartbeat": false,
        "sentence_end": true,
        "words": [
          {
            "begin_time": 170,
            "end_time": 295,
            "text": "好",
            "punctuation": "，"
          },
          {
            "begin_time": 295,
            "end_time": 503,
            "text": "我",
            "punctuation": ""
          },
          {
            "begin_time": 503,
            "end_time": 711,
            "text": "知道",
            "punctuation": ""
          },
          {
            "begin_time": 711,
            "end_time": 920,
            "text": "了",
            "punctuation": ""
          }
        ]
      }
    },
    "usage": {
      "duration": 3
    }
  }
}

payload object

屬性

output object

屬性

usage object

當payload.output.sentence.sentence_end為false（當前句子未結束）時，usage為null。

當payload.output.sentence.sentence_end為true（當前句子已結束）時，usage.duration為當前任務計費時間長度。

屬性

duration integer

任務計費時間長度（s）。

屬性

sentence object

屬性

begin_time integer

句子開始時間（ms）。

end_time integer

句子結束時間（ms）。

text string

識別文本。

heartbeat boolean

若為 true，可跳過該結果（心跳包）。

sentence_end boolean

是否句子結束（true=最終結果，false=中間結果）。

emo_tag string

重要

僅 paraformer-realtime-8k-v2 支援該功能
必須關閉語義斷句（將run-task事件的semantic_punctuation_enabled設為false）才支援該功能
只有在payload.output.sentence.sentence_end的值為true時才顯示情感識別結果

當前句子的情感：

positive：正面情感，如開心、滿意
negative：負面情感，如憤怒、沉悶
neutral：無明顯情感

emo_confidence float

重要

僅 paraformer-realtime-8k-v2 支援該功能
必須關閉語義斷句（將run-task事件的semantic_punctuation_enabled設為false）才支援該功能
只有在payload.output.sentence.sentence_end的值為true時才顯示情感識別結果

情感信賴度，取值範圍為[0.0, 1.0]，值越大表示信賴度越高。

words array[object]

字時間戳記資訊。

屬性

begin_time integer

字開始時間（ms）。

end_time integer

字結束時間（ms）。

text string

識別文本。

punctuation string

標點符號。

task-finished

說明：任務正常結束，可關閉串連或複用串連。

header object

屬性

task_id string

用戶端產生的任務 ID（UUID 格式）。

event string

事件類型，固定為 task-finished。

attributes object

附加屬性（通常為空白）。

{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-finished",
        "attributes": {}
    },
    "payload": {
        "output": {},
        "usage": null
    }
}

payload object

無需關注其中內容，通常為{}。

task-failed

說明：任務失敗，串連會被關閉，無法複用。

header object

屬性

task_id string

用戶端產生的任務 ID（UUID 格式）。

event string

事件類型，固定為 task-failed。

error_code string

錯誤類型描述。

error_message string

具體錯誤原因。

attributes object

附加屬性（通常為空白）。

{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-failed",
        "error_code": "CLIENT_ERROR",
        "error_message": "request timeout after 23 seconds.",
        "attributes": {}
    },
    "payload": {}
}

payload object

固定為{}。