Server-sent events untuk pengenalan ucapan real-time (Paraformer) - Alibaba Cloud Model Studio

Referensi untuk server-sent events yang didorong oleh layanan pengenalan ucapan real-time Paraformer ke klien melalui WebSocket. Topik ini mendokumentasikan struktur data dan semantik bidang dari empat jenis event: task-started, result-generated, task-finished, dan task-failed.

Panduan pengguna: Untuk detail model dan panduan pemilihan, lihat Speech-to-text.

Alur interaksi event: Untuk diagram sekuens event, lihat WebSocket API.

task-started

Deskripsi: Tugas telah berhasil dimulai. Klien dapat mulai mengirim data audio.

headerobject

Properties

task_idstring

ID tugas yang dihasilkan klien (format UUID).

eventstring

Jenis event. Selalu task-started.

attributesobject

Atribut tambahan. Biasanya kosong.

payloadobject

Selalu {}.

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

result-generated

Deskripsi: Hasil pengenalan, mencakup hasil antara (sentence_end=false) dan hasil akhir (sentence_end=true).

headerobject

Properties

task_idstring

ID tugas yang dihasilkan klien (format UUID).

eventstring

Jenis event. Selalu result-generated.

payloadobject

Properties

outputobject

Properties

usageobject

Ketika payload.output.sentence.sentence_end bernilai false (kalimat saat ini belum berakhir), usage bernilai null.

Ketika payload.output.sentence.sentence_end bernilai true (kalimat saat ini telah berakhir), usage.duration menunjukkan durasi tagihan tugas saat ini.

Properties

durationinteger

Durasi tugas yang dikenai biaya, dalam satuan detik.

Properties

sentenceobject

Properties

begin_timeinteger

Waktu mulai kalimat, dalam milidetik.

end_timeinteger

Waktu akhir kalimat, dalam milidetik.

textstring

Teks yang dikenali.

heartbeatboolean

Jika bernilai true, Anda dapat melewati hasil ini (paket heartbeat).

sentence_endboolean

Apakah kalimat telah berakhir (true=hasil akhir, false=hasil antara).

emo_tagstring

Penting

Hanya paraformer-realtime-8k-v2 yang mendukung fitur ini.
Fitur ini memerlukan segmentasi semantik dinonaktifkan. Atur semantic_punctuation_enabled ke false pada event run-task.
Hasil pengenalan emosi hanya dikembalikan ketika payload.output.sentence.sentence_end bernilai true.

Sentimen dari kalimat saat ini:

positive: Sentimen positif, seperti senang atau puas.
negative: Sentimen negatif, seperti marah atau kecewa.
neutral: Tidak ada sentimen yang jelas.

emo_confidencefloat

Penting

Hanya paraformer-realtime-8k-v2 yang mendukung fitur ini.
Fitur ini memerlukan segmentasi semantik dinonaktifkan. Atur semantic_punctuation_enabled ke false pada event run-task.
Hasil pengenalan emosi hanya dikembalikan ketika payload.output.sentence.sentence_end bernilai true.

Skor kepercayaan emosi dalam rentang [0.0, 1.0]. Nilai yang lebih tinggi menunjukkan kepercayaan yang lebih besar.

wordsarray[object]

Informasi timestamp tingkat kata.

Properties

begin_timeinteger

Waktu mulai kata, dalam milidetik.

end_timeinteger

Waktu akhir kata, dalam milidetik.

textstring

Teks yang dikenali.

punctuationstring

Tanda baca.

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

Deskripsi: Tugas berakhir secara normal. Anda dapat menutup koneksi atau menggunakannya kembali.

headerobject

Properties

task_idstring

ID tugas yang dihasilkan klien (format UUID).

eventstring

Jenis event. Selalu task-finished.

attributesobject

Atribut tambahan. Biasanya kosong.

payloadobject

Isinya dapat diabaikan. Biasanya {}.

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

task-failed

Deskripsi: Tugas gagal. Koneksi ditutup dan tidak dapat digunakan kembali.

headerobject

Properties

task_idstring

ID tugas yang dihasilkan klien (format UUID).

eventstring

Jenis event. Selalu task-failed.

error_codestring

Deskripsi jenis error.

error_messagestring

Penyebab spesifik dari error tersebut.

attributesobject

Atribut tambahan. Biasanya kosong.

payloadobject

Selalu {}.

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