Fun-ASR server events

The Fun-ASR real-time speech recognition service delivers four types of server-side events to the client over WebSocket: task-started, result-generated, task-finished, and task-failed. User guide: For model details and selection guidance, see Speech-to-text models. Event flow: For the event interaction sequence, see WebSocket API.

task-started

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

Example

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

object

body

Message header.

Show properties

string

body

Task ID generated by the client (UUID format).

string

body

Event type. Fixed value: task-started.

object

body

Additional attributes. Typically empty.

object

body

Always {}.

result-generated

Description: A recognition result. Includes interim results (sentence_end=false) and final results (sentence_end=true).

Example

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": 920,
        "text": "Okay, I got it.",
        "heartbeat": false,
        "sentence_end": true,
        "sentence_id": 1,
        "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
    }
  }
}

object

body

Message header.

Show properties

string

body

Task ID generated by the client (UUID format).

string

body

Event type. Fixed value: result-generated.

object

body

Message payload.

Show properties

object

body

Recognition output.

Show properties

object

body

Sentence-level result.

Show properties

integer

body

Sentence start time, in milliseconds.

integer

body

Sentence end time, in milliseconds.

string

body

Recognized text.

boolean

body

If true, the result is a heartbeat packet and can be skipped.

boolean

body

Indicates whether the sentence has ended. true = final result; false = interim result.

integer

body

Sentence sequence identifier. For regular recognition results, sentence_id starts at 1 and increments. When heartbeat is true (heartbeat packet), sentence_id is fixed at 0.

array[object]

body

Word-level timestamp information.

Show properties

integer

body

Word start time, in milliseconds.

integer

body

Word end time, in milliseconds.

string

body

Recognized text.

string

body

Punctuation mark.

object

body

When payload.output.sentence.sentence_end is false (the current sentence has not yet ended), usage is null. When sentence_end is true (the current sentence has ended), usage.duration reports the billable duration of the current task.

Show properties

integer

body

Billable duration of the task, in seconds.

task-finished

Description: The task ended normally. The connection can be closed or reused.

Example

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

object

body

Message header.

Show properties

string

body

Task ID generated by the client (UUID format).

string

body

Event type. Fixed value: task-finished.

object

body

Additional attributes. Typically empty.

object

body

Typically {}; the contents are not relevant.

task-failed

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

Example

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

object

body

Message header.

Show properties

string

body

Task ID generated by the client (UUID format).

string

body

Event type. Fixed value: task-failed.

string

body

Error type description.

string

body

Detailed error message.

object

body

Additional attributes. Typically empty.

object

body

Always {}.

​task-started

​result-generated

​task-finished

​task-failed

task-started

result-generated

task-finished

task-failed