Copy

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

task-started

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

headerobject

Properties

task_idstringThe task ID generated by the client (in UUID format).eventstringThe event type. This value is always task-started.attributesobjectAdditional attributes. This value is usually empty.

payloadobjectThis value is always {}.

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

result-generated

Description: The recognition result. It includes intermediate results (sentence_end=false) and final results (sentence_end=true). The first intermediate result for a new sentence includes sentence_begin=true.

headerobject

Properties

task_idstringThe task ID generated by the client (in UUID format).eventstringThe event type. This value is always result-generated.

payloadobject

Properties

outputobject

Properties

usageobjectWhen 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 is the billed duration of the current task.

Properties

durationintegerThe billed task duration, in seconds.

Properties

sentenceobject

Properties

begin_timeintegerThe start time of the sentence, in milliseconds.end_timeintegerThe end time of the sentence, in milliseconds.textstringThe recognized text.heartbeatbooleanIf this value is true, the result is a heartbeat packet and can be ignored.sentence_beginbooleanIndicates the start of a sentence.sentence_endbooleanWhether the sentence has ended (true = final result, false = intermediate result).sentence_idintegerThe sequence identifier of the sentence. In normal recognition results, sentence_id increments from 1. When heartbeat is true (that is, a heartbeat packet), sentence_id is always 0.wordsarray[object]Word-level timestamp information.

Properties

begin_timeintegerThe start time of the word, in milliseconds.end_timeintegerThe end time of the word, in milliseconds.textstringThe recognized text.punctuationstringThe punctuation mark.

Sentence-start result:

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 0,
        "end_time": null,
        "text": "",
        "sentence_begin": true,
        "sentence_end": false,
        "sentence_id": 1,
        "words": []
      }
    },
    "usage": null
  }
}

Final result:

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": 920,
        "text": "OK, got it.",
        "heartbeat": false,
        "sentence_end": true,
        "sentence_id": 1,
        "words": [
          {
            "begin_time": 170,
            "end_time": 295,
            "text": "OK",
            "punctuation": ","
          },
          {
            "begin_time": 295,
            "end_time": 503,
            "text": "got",
            "punctuation": ""
          },
          {
            "begin_time": 503,
            "end_time": 711,
            "text": "it",
            "punctuation": ""
          },
          {
            "begin_time": 711,
            "end_time": 920,
            "text": "",
            "punctuation": "."
          }
        ]
      }
    },
    "usage": {
      "duration": 3
    }
  }
}

task-finished

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

headerobject

Properties

task_idstringThe task ID generated by the client (in UUID format).eventstringThe event type. This value is always task-finished.attributesobjectAdditional attributes. This value is usually empty.

payloadobjectYou can ignore this field. This value is usually {}.

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

task-failed

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

headerobject

Properties

task_idstringThe task ID generated by the client (in UUID format).eventstringThe event type. This value is always task-failed.error_codestringA description of the error type.error_messagestringThe specific cause of the error.attributesobjectAdditional attributes. This value is usually empty.

payloadobjectThis value is always {}.

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

​task-started

​result-generated

​task-finished

​task-failed

task-started

result-generated

task-finished

task-failed