Referensi peristiwa server CosyVoice: bidang awal tugas, sintesis kalimat, penyelesaian, kegagalan, dan permintaan terkait.
Alur peristiwa
- Kirim run-task untuk memulai dan mengonfigurasi tugas, lalu tunggu task-started.
- Setelah menerima
task-started, kirim teks melalui continue-task sambil menerima result-generated dan audio hasil sintesis. - Setelah semua teks terkirim, kirim finish-task dan terus terima sisa hasil serta audio hingga task-finished diterima. Tugas yang gagal mengembalikan task-failed.
result-generated mengembalikan metadata kalimat. Audio dikirim secara terpisah melalui frame biner WebSocket atau Audio Track AOQ. Untuk koneksi, autentikasi, dan transmisi audio, lihat API WebSocket atau akses AOQ.
task-started
Menunjukkan bahwa tugas berhasil dimulai dan klien dapat mulai mengirim teks untuk sintesis.
headerobjecttask_idstringID tugas yang dihasilkan oleh klien.
eventstringJenis event. Nilai tetap:
task-started.payloadobjectObjek kosong.
Permintaan:
Respons:
result-generated
Mengembalikan metadata kalimat, termasuk awal kalimat, penanda potongan data audio, dan akhir kalimat.
headerobjecttask_idstringID tugas yang dihasilkan oleh klien.
eventstringJenis event. Nilai tetap:
result-generated.payloadobjectoutputobjectInformasi output.
sentenceobjectindexintegerIndeks kalimat, dimulai dari 0.
wordsarrayArray timestamp tingkat kata.
textstringKonten teks kata tersebut.
begin_indexintegerIndeks karakter awal kata dalam kalimat. Dimulai dari 0.
end_indexintegerIndeks karakter akhir kata dalam kalimat. Dimulai dari 1.
begin_timeintegerWaktu mulai audio yang sesuai dengan kata tersebut, dalam milidetik.
end_timeintegerWaktu akhir audio yang sesuai dengan kata tersebut, dalam milidetik.
typestringJenis sub-event. Nilai yang valid:
sentence-begin: Awal kalimat. Mengembalikan teks yang akan disintesis.sentence-synthesis: Menandai satu frame audio. Satu frame audio dikirimkan melalui saluran biner WebSocket segera setelah setiap event.sentence-end: Akhir kalimat. Mengembalikan konten teks dan jumlah kumulatif karakter.
original_textstringTeks kalimat sebagaimana telah disegmentasi untuk sintesis.
usageobjectInformasi penagihan, dikembalikan dalam event
sentence-end.usage berisi penggunaan kumulatif tugas saat ini. Jangan menjumlahkan nilai usage dari beberapa peristiwa. Setelah tugas selesai, gunakan penggunaan kumulatif akhir dalam task-finished.charactersintegerJumlah kumulatif karakter yang ditagih.
Contoh berikut mengatur
word_timestamp_enabled=true saat memulai tugas.- sentence-begin
- sentence-synthesis
- sentence-end
Permintaan:
Respons:
task-finished
Server mengembalikan event task-finished ketika tugas selesai. Klien kemudian dapat menutup koneksi WebSocket atau menggunakannya kembali untuk memulai tugas baru.
headerobjecttask_idstringID tugas yang dihasilkan oleh klien.
eventstringJenis event. Nilai tetap:
task-finished.payloadobjectusageobjectcharactersintegerJumlah kumulatif karakter yang ditagih.
Permintaan:
Respons:
task-failed
Server mengembalikan event task-failed ketika tugas gagal. Saat menerima event ini, klien harus menutup koneksi WebSocket dan menangani kesalahan tersebut.
headerobjecttask_idstringID tugas yang dihasilkan oleh klien.
eventstringJenis event. Nilai tetap:
task-failed.error_codestringKode kesalahan.
error_messagestringPesan kesalahan detail.
Contoh ini menggunakan format audio yang tidak didukung. Setelah tugas dimulai dan teks dikirim, server mengembalikan kesalahan. Kode dan pesan kesalahan bergantung pada penyebab kegagalan.
Permintaan:
Respons: