Paraformer real-time speech recognition server-side events

Paraformer models are available only in the China North 2 (Beijing) region. Use an API key created in that region. See Regions and endpoints.

User guide: For model details and selection guidance, see Speech-to-text. Event interaction flow: For the event sequence diagram, see WebSocket API.

task-started

Description: The task has started successfully. The client can begin sending audio data.

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

Parameter	Type	Description
header	object
header.task_id	string	Client-generated task ID (UUID format).
header.event	string	Event type. Always `task-started`.
header.attributes	object	Additional attributes. Typically empty.
payload	object	Always `{}`.

result-generated

Description: Recognition result. Includes intermediate results (sentence_end=false) and final results (sentence_end=true).

{
  "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
    }
  }
}

Parameter	Type	Description
header	object
header.task_id	string	Client-generated task ID (UUID format).
header.event	string	Event type. Always `result-generated`.
payload	object
payload.output	object
payload.output.usage	object	When `payload.output.sentence.sentence_end` is `false` (the current sentence has not ended), `usage` is `null`. When `payload.output.sentence.sentence_end` is `true` (the current sentence has ended), `usage.duration` indicates the billable duration of the current task.
payload.output.usage.duration	integer	Billable task duration, in seconds.
payload.output.sentence	object
payload.output.sentence.begin_time	integer	Sentence start time, in milliseconds.
payload.output.sentence.end_time	integer	Sentence end time, in milliseconds.
payload.output.sentence.text	string	Recognized text.
payload.output.sentence.heartbeat	boolean	If true, you can skip this result (heartbeat packet).
payload.output.sentence.sentence_end	boolean	Whether the sentence has ended (true=final result, false=intermediate result).
payload.output.sentence.emo_tag	string	Tip: - Only paraformer-realtime-8k-v2 supports this feature. This feature requires semantic segmentation to be disabled. Set `semantic_punctuation_enabled` to false in the run-task event. The emotion recognition result is returned only when `payload.output.sentence.sentence_end` is `true`. Sentiment of the current sentence: positive: Positive sentiment, such as happy or satisfied. negative: Negative sentiment, such as angry or dejected. neutral: No distinct sentiment.
payload.output.sentence.emo_confidence	float	Tip: - Only paraformer-realtime-8k-v2 supports this feature. This feature requires semantic segmentation to be disabled. Set `semantic_punctuation_enabled` to false in the run-task event. The emotion recognition result is returned only when `payload.output.sentence.sentence_end` is `true`. Emotion confidence score in the range [0.0, 1.0]. A higher value indicates greater confidence.
payload.output.sentence.words	array[object]	Word-level timestamp information.
payload.output.sentence.words.begin_time	integer	Word start time, in milliseconds.
payload.output.sentence.words.end_time	integer	Word end time, in milliseconds.
payload.output.sentence.words.text	string	Recognized text.
payload.output.sentence.words.punctuation	string	Punctuation mark.

task-finished

Description: The task ended normally. You can close the connection or reuse it.

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

Parameter	Type	Description
header	object
header.task_id	string	Client-generated task ID (UUID format).
header.event	string	Event type. Always `task-finished`.
header.attributes	object	Additional attributes. Typically empty.
payload	object	The contents can be ignored. Typically `{}`.

task-failed

Description: The task failed. The connection is closed and cannot be reused.

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

Parameter	Type	Description
header	object
header.task_id	string	Client-generated task ID (UUID format).
header.event	string	Event type. Always `task-failed`.
header.error_code	string	Description of the error type.
header.error_message	string	Specific cause of the error.
header.attributes	object	Additional attributes. Typically empty.
payload	object	Always `{}`.

​task-started

​result-generated

​task-finished

​task-failed

task-started

result-generated

task-finished

task-failed