Référence des événements serveur CosyVoice : démarrage de tâche, synthèse de phrases, fin, échec et requêtes correspondantes.
Séquence des événements
- Envoyez run-task pour démarrer et configurer la tâche, puis attendez task-started.
- Après réception de
task-started, envoyez le texte par continue-task tout en recevant result-generated et l’audio synthétisé. - Après l’envoi de tout le texte, envoyez finish-task et continuez à recevoir les résultats et l’audio restants jusqu’à task-finished. Une tâche en échec renvoie task-failed.
result-generated renvoie les métadonnées des phrases. L’audio est transmis séparément par des trames binaires WebSocket ou une Audio Track AOQ. Pour la connexion, l’authentification et le transport audio, consultez l’API WebSocket ou l’accès AOQ.
task-started
Indique que la tâche a démarré et que le client peut commencer à envoyer le texte à synthétiser.
headerobjecttask_idstringID de tâche généré par le client.
eventstringType d'événement. Valeur fixe :
task-started.payloadobjectObjet vide.
Requête
Réponse
result-generated
Renvoie les métadonnées des phrases : débuts de phrases, marqueurs de blocs audio et fins de phrases.
headerobjecttask_idstringID de tâche généré par le client.
eventstringType d'événement. Valeur fixe :
result-generated.payloadobjectoutputobjectInformations de sortie.
sentenceobjectindexintegerIndex de la phrase, commençant à 0.
wordsarrayTableau des horodatages au niveau des mots.
textstringContenu textuel du mot.
begin_indexintegerIndex du caractère de début du mot dans la phrase. Commence à 0.
end_indexintegerIndex du caractère de fin du mot dans la phrase. Commence à 1.
begin_timeintegerHeure de début de l'audio correspondant au mot, en millisecondes.
end_timeintegerHeure de fin de l'audio correspondant au mot, en millisecondes.
typestringType de sous-événement. Valeurs valides :
sentence-begin: début de phrase. Retourne le texte à synthétiser.sentence-synthesis: marque une trame audio. Une trame audio est transmise sur le canal binaire WebSocket immédiatement après chaque événement.sentence-end: fin de phrase. Retourne le contenu textuel et le nombre cumulé de caractères.
original_textstringTexte de la phrase tel que segmenté pour la synthèse.
usageobjectInformations de facturation, retournées dans l'événement
sentence-end.usage contient l’utilisation cumulée de la tâche actuelle. N’additionnez pas les valeurs de usage des événements. Après la fin de la tâche, utilisez le cumul final dans task-finished.charactersintegerNombre cumulé de caractères facturés.
Les exemples suivants définissent
word_timestamp_enabled=true au démarrage de la tâche.- sentence-begin
- sentence-synthesis
- sentence-end
Requête
Réponse
task-finished
Le serveur retourne un événement task-finished lorsque la tâche est terminée. Le client peut alors fermer la connexion WebSocket ou la réutiliser pour démarrer une nouvelle tâche.
headerobjecttask_idstringID de tâche généré par le client.
eventstringType d'événement. Valeur fixe :
task-finished.payloadobjectusageobjectcharactersintegerNombre cumulé de caractères facturés.
Requête
Réponse
task-failed
Le serveur retourne un événement task-failed en cas d'échec de la tâche. À la réception de cet événement, le client doit fermer la connexion WebSocket et gérer l'erreur.
headerobjecttask_idstringID de tâche généré par le client.
eventstringType d'événement. Valeur fixe :
task-failed.error_codestringCode d'erreur.
error_messagestringMessage d'erreur détaillé.
Cet exemple utilise un format audio non pris en charge. Après le démarrage de la tâche et l’envoi du texte, le serveur renvoie une erreur. Le code et le message dépendent de la cause de l’échec.
Requête
Réponse