Skip to main content

Événements serveur CosyVoice

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

  1. Envoyez run-task pour démarrer et configurer la tâche, puis attendez task-started.
  2. Après réception de task-started, envoyez le texte par continue-task tout en recevant result-generated et l’audio synthétisé.
  3. 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.
Attendez task-started avant d’envoyer continue-task. run-task démarre et configure la tâche. Envoyez le texte à synthétiser par continue-task.
headerobject
task_idstring
ID de tâche généré par le client.
eventstring
Type d'événement. Valeur fixe : task-started.
payloadobject
Objet vide.
Requête
{
  "header": {
    "action": "run-task",
    "task_id": "b6e6cdf6-e9fa-429c-b1c1-cd231977c918",
    "streaming": "duplex"
  },
  "payload": {
    "input": {},
    "task_group": "audio",
    "task": "tts",
    "function": "SpeechSynthesizer",
    "model": "cosyvoice-v3-plus",
    "parameters": {
      "text_type": "PlainText",
      "voice": "longanyang",
      "format": "mp3",
      "sample_rate": 22050
    }
  }
}
Réponse
{
  "header": {
    "task_id": "b6e6cdf6-e9fa-429c-b1c1-cd231977c918",
    "task_uuid": "1dd2b10b644e45b798f58ef96405215e",
    "event": "task-started",
    "attributes": {}
  },
  "payload": {}
}

result-generated

Renvoie les métadonnées des phrases : débuts de phrases, marqueurs de blocs audio et fins de phrases.
sentence-end marque la fin de la synthèse d’une phrase, pas de la tâche entière. La tâche se termine avec task-finished. L’audio est renvoyé par des trames binaires WebSocket ou une Audio Track AOQ.
headerobject
task_idstring
ID de tâche généré par le client.
eventstring
Type d'événement. Valeur fixe : result-generated.
payloadobject
outputobject
Informations de sortie.
sentenceobject
indexinteger
Index de la phrase, commençant à 0.
wordsarray
Tableau des horodatages au niveau des mots.
textstring
Contenu textuel du mot.
begin_indexinteger
Index du caractère de début du mot dans la phrase. Commence à 0.
end_indexinteger
Index du caractère de fin du mot dans la phrase. Commence à 1.
begin_timeinteger
Heure de début de l'audio correspondant au mot, en millisecondes.
end_timeinteger
Heure de fin de l'audio correspondant au mot, en millisecondes.
typestring
Type 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_textstring
Texte de la phrase tel que segmenté pour la synthèse.
usageobject
Informations 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.
charactersinteger
Nombre 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
{
  "header": {
    "action": "continue-task",
    "task_id": "3785722c-8fb0-42cf-9fbe-21dd8d8c29bf",
    "streaming": "duplex"
  },
  "payload": {
    "input": {
      "text": "Welcome to the speech synthesis service."
    }
  }
}
Réponse
{
  "header": {
    "task_id": "3785722c-8fb0-42cf-9fbe-21dd8d8c29bf",
    "event": "result-generated",
    "attributes": {
      "x-dashscope-inner-response-type": "ws"
    }
  },
  "payload": {
    "output": {
      "sentence": {
        "index": 0,
        "words": [
          {
            "text": "Welcome",
            "begin_index": 0,
            "end_index": 1,
            "begin_time": 0,
            "end_time": 560
          }
        ]
      },
      "type": "sentence-begin",
      "original_text": "Welcome to the speech synthesis service.",
      "normalized_text": "Welcome to the speech synthesis service."
    }
  }
}

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.
headerobject
task_idstring
ID de tâche généré par le client.
eventstring
Type d'événement. Valeur fixe : task-finished.
payloadobject
usageobject
charactersinteger
Nombre cumulé de caractères facturés.
Requête
{
  "header": {
    "action": "finish-task",
    "task_id": "b6e6cdf6-e9fa-429c-b1c1-cd231977c918",
    "streaming": "duplex"
  },
  "payload": {
    "input": {}
  }
}
Réponse
{
  "header": {
    "task_id": "b6e6cdf6-e9fa-429c-b1c1-cd231977c918",
    "event": "task-finished",
    "attributes": {
      "x-dashscope-inner-response-type": "ws"
    }
  },
  "payload": {
    "output": {},
    "usage": {
      "characters": 40
    }
  }
}

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.
headerobject
task_idstring
ID de tâche généré par le client.
eventstring
Type d'événement. Valeur fixe : task-failed.
error_codestring
Code d'erreur.
error_messagestring
Message 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
{
  "header": {
    "action": "run-task",
    "task_id": "27928f57-cf3b-4f3d-a245-aef64895a3c9",
    "streaming": "duplex"
  },
  "payload": {
    "input": {},
    "task_group": "audio",
    "task": "tts",
    "function": "SpeechSynthesizer",
    "model": "cosyvoice-v3-plus",
    "parameters": {
      "text_type": "PlainText",
      "voice": "longanyang",
      "format": "invalid-format",
      "sample_rate": 22050
    }
  }
}
Réponse
{
  "header": {
    "task_id": "27928f57-cf3b-4f3d-a245-aef64895a3c9",
    "event": "task-failed",
    "error_code": "InvalidParameter",
    "error_message": "Request format is invalid!"
  },
  "payload": {}
}