CosyVoice server events - Alibaba Cloud Model Studio - Centre de documentation Alibaba Cloud

task-started

Après l'envoi de la commande run-task par le client, le serveur retourne un événement task-started pour signaler le démarrage de la tâche. Le client ne peut envoyer les commandes suivantes qu'après réception de cet événement.

header.task_id string

ID de tâche généré par le client.

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

header.event string

Type d'événement. Valeur fixe : task-started.

payload object

Objet vide.

result-generated

Après l'envoi du texte par le client, le serveur retourne en continu des événements result-generated. Chaque événement contient des métadonnées au niveau de la phrase.

header.task_id string

ID de tâche généré par le client.

sentence-begin

{
  "header": {
    "task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "index": 0,
        "words": []
      },
      "type": "sentence-begin",
      "original_text": "Before my bed, moonlight shines bright,"
    }
  }
}

sentence-synthesis

{
    "header": {
        "task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
        "event": "result-generated",
        "attributes": {}
    },
    "payload": {
        "output": {
            "sentence": {
                "index": 0,
                "words": []
            },
            "type": "sentence-synthesis"
        }
    }
}

sentence-end

{
  "header": {
    "task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "index": 0,
        "words": [
          {
            "text": "Before",
            "begin_index": 0,
            "end_index": 1,
            "begin_time": 0,
            "end_time": 263
          }
        ]
      },
      "type": "sentence-end",
      "original_text": "Before my bed, moonlight shines bright,"
    },
    "usage": {
      "characters": 6
    }
  }
}

header.event string

Type d'événement. Valeur fixe : result-generated.

payload.output object

Informations de sortie.

Propriétés

type string

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.

sentence.index integer

Index de la phrase, commençant à 0.

sentence.words array

Tableau des horodatages au niveau des mots.

Propriétés des éléments words

text string

Contenu textuel du mot.

begin_index integer

Index du caractère de début du mot dans la phrase. Commence à 0.

end_index integer

Index du caractère de fin du mot dans la phrase. Commence à 1.

begin_time integer

Heure de début de l'audio correspondant au mot, en millisecondes.

end_time integer

Heure de fin de l'audio correspondant au mot, en millisecondes.

original_text string

Texte de la phrase tel que segmenté pour la synthèse.

payload.usage object

Informations de facturation, retournées dans l'événement sentence-end.

Propriétés

characters integer

Nombre cumulé de caractères facturés.

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.

header.task_id string

ID de tâche généré par le client.

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "task-finished",
    "attributes": {
      "request_uuid": "0a9dba9e-d3a6-45a4-be6d-xxxxxxxxxxxx"
    }
  },
  "payload": {
    "usage": {
      "characters": 13
    }
  }
}

header.event string

Type d'événement. Valeur fixe : task-finished.

payload.usage.characters integer

Nombre cumulé de caractères facturés.

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.

header.task_id string

ID de tâche généré par le client.

{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "task-failed",
    "error_code": "InvalidParameter",
    "error_message": "[tts:]Engine return error code: 418",
    "attributes": {}
  },
  "payload": {}
}

header.event string

Type d'événement. Valeur fixe : task-failed.

header.error_code string

Code d'erreur.

header.error_message string

Message d'erreur détaillé.