Référence des événements client CosyVoice : champs de run-task, continue-task et finish-task, ordre d’envoi et événements serveur correspondants.
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.
run-task
Immédiatement après l’établissement de la connexion, le client envoie run-task pour démarrer la tâche de synthèse vocale et définir le modèle, la voix, la fréquence d’échantillonnage et les autres paramètres.
headerobjectObligatoireactionstringObligatoireType de commande. Définissez la valeur sur
run-task.task_idstringObligatoireID de tâche généré par le client au format UUID. Cet ID permet de corréler les événements suivants et doit correspondre au
task_id dans les commandes continue-task et finish-task.streamingstringObligatoireDéfinissez la valeur sur
duplex.payloadobjectObligatoiretask_groupstringObligatoireGroupe de tâches. Définissez la valeur sur
audio.taskstringObligatoireType de tâche. Définissez la valeur sur
tts.functionstringObligatoireType de fonction. Définissez la valeur sur
SpeechSynthesizer.modelstringObligatoireLe nom du modèle.
parametersobjectObligatoireParamètres de synthèse vocale.
text_typestringObligatoireDéfinissez la valeur sur
PlainText.voicestringObligatoireVoix utilisée pour la synthèse vocale.
- Voix système : Consultez la liste des voix CosyVoice
- Voix clonées : Voix personnalisées créées par clonage vocal
- Voix personnalisées : Voix personnalisées créées par conception vocale
formatstringFacultatifFormat d'encodage audio.Valeurs valides :
pcmwavmp3(par défaut)opus
sample_rateintegerFacultatifFréquence d'échantillonnage audio en Hz.Valeurs valides : 8000, 16000, 22050 (par défaut), 24000, 44100, 48000.
volumeintegerFacultatifNiveau de volume.Valeur par défaut : 50.Valeurs valides : [0, 100].
ratefloatFacultatifVitesse de parole.Valeur par défaut : 1.0.Valeurs valides : [0,5, 2,0].
pitchfloatFacultatifHauteur tonale.Valeur par défaut : 1.0.Valeurs valides : [0,5, 2,0].
bit_rateintegerFacultatifDébit binaire audio en kbps. Lorsque le format audio est
mp3 ou opus, utilisez bit_rate pour ajuster le débit binaire.Valeur par défaut : 32.Valeurs valides : [6, 510].enable_ssmlbooleanFacultatifIndique s'il faut activer SSML.Valeur par défaut : Pour connaître les restrictions d'utilisation de SSML (modèles, voix et API pris en charge), consultez la section Limitations.
false.Lorsque la valeur est définie sur
true, une seule commande continue-task est autorisée.word_timestamp_enabledbooleanFacultatifIndique s'il faut activer les horodatages au niveau des mots.Valeur par défaut :
false.Disponible uniquement en mode de sortie en streaming. Voix prises en charge : voix clonées de cosyvoice-v3.5-plus, cosyvoice-v3.5-flash, cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2, ainsi que les voix système marquées comme prises en charge dans la liste des voix CosyVoice. Les voix clonées d'autres modèles ne prennent pas en charge cette fonctionnalité.
seedintegerFacultatifGraine aléatoire permettant de contrôler la variation dans la sortie de synthèse. Lorsque la version du modèle, le texte, la voix et les autres paramètres restent inchangés, l'utilisation de la même graine produit des résultats identiques.Valeur par défaut : 0.Valeurs valides : [0, 65535].
language_hintsarray[string]Facultatif- Ce paramètre est un tableau, mais la version actuelle ne traite que le premier élément. Transmettez une seule valeur.
- Ce paramètre spécifie la langue cible pour la synthèse vocale. Il n'est pas lié à la langue de l'échantillon audio utilisé lors du clonage vocal. Pour définir la langue source d'une tâche de clonage, consultez la référence de l'API de clonage vocal.
- Prononciation inattendue des chiffres : « hello, this is 110 » est lu « hello, this is one zero » au lieu de la prononciation chinoise attendue
- Prononciation imprécise des symboles : « @ » est lu comme l'équivalent chinois au lieu de « at »
- Mauvaise qualité de synthèse pour les langues minoritaires avec des résultats peu naturels
Valeurs valides
Valeurs valides
- zh : chinois
- en : anglais
- fr : français
- de : allemand
- ja : japonais
- ko : coréen
- ru : russe
- pt : portugais
- th : thaï
- id : indonésien
- vi : vietnamien
- es : espagnol
- it : italien
- ms : malais
- fil : philippin
- ar : arabe
instructionstringFacultatifDéfinit une instruction pour contrôler le dialecte, l'émotion ou le caractère de la voix pendant la synthèse. Pour une utilisation détaillée, consultez la section Contrôle par instruction.
enable_aigc_tagbooleanFacultatifIndique s'il faut intégrer un filigrane AIGC dans l'audio généré. Lorsque la valeur est définie sur
true, le filigrane est intégré dans les fichiers audio aux formats pris en charge (wav/mp3/opus).Valeur par défaut : false.Seuls cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 prennent en charge cette fonctionnalité.
aigc_propagatorstringFacultatifDéfinit le champ
ContentPropagator dans le filigrane AIGC, identifiant le propagateur de contenu. Prend effet uniquement lorsque enable_aigc_tag est défini sur true.Valeur par défaut : UID Alibaba Cloud.Seuls cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 prennent en charge cette fonctionnalité.
aigc_propagate_idstringFacultatifDéfinit le champ
PropagateID dans le filigrane AIGC, identifiant de manière unique une action de propagation spécifique. Prend effet uniquement lorsque enable_aigc_tag est défini sur true.Valeur par défaut : ID de requête de la demande de synthèse vocale actuelle.Seuls cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 prennent en charge cette fonctionnalité.
hot_fixobjectFacultatifConfigure les corrections de prononciation et les remplacements de texte appliqués avant la synthèse.Paramètres :
Cette fonctionnalité n'est pas prise en charge par cosyvoice-v2.
- pronunciation : Prononciation personnalisée. Spécifie les annotations phonétiques pour les mots afin de corriger les prononciations par défaut incorrectes.
- replace : Remplacement de texte. Remplace les mots spécifiés par le texte cible avant la synthèse. Le texte remplacé sert d'entrée réelle pour la synthèse.
enable_markdown_filterbooleanFacultatifSeules les voix clonées de cosyvoice-v3-flash prennent en charge cette fonctionnalité.
false.Valeurs valides :true: Activer le filtrage Markdownfalse: Désactiver le filtrage Markdown
inputobjectObligatoireDéfinissez la valeur sur un objet vide
{}. Envoyez le texte à synthétiser via la commande continue-task.Requête
Réponse
continue-task
Après réception de task-started, le client envoie continue-task pour soumettre le texte à synthétiser. Le texte peut être envoyé en une fois ou en segments successifs.
headerobjectObligatoireactionstringObligatoireType de commande. Définissez la valeur sur
continue-task.task_idstringObligatoireID de tâche au format UUID. Doit correspondre au
task_id dans run-task.streamingstringObligatoireDéfinissez la valeur sur
duplex.payloadobjectObligatoireinputobjectObligatoireContient le texte à synthétiser.
textstringObligatoireTexte à synthétiser. Maximum de 20 000 caractères par message et 200 000 caractères au total.
L'intervalle d'envoi ne doit pas dépasser 23 secondes ; sinon, la connexion expire.
Requête
Réponse
finish-task
Immédiatement après l’envoi de tout le texte, le client envoie finish-task pour notifier la fin de l’entrée et demander la fin de la tâche. Pour annuler le tour de synthèse en cours, définissez directive sur cancel dans input.
headerobjectObligatoireactionstringObligatoireType de commande. Définissez la valeur sur
finish-task.task_idstringObligatoireID de tâche au format UUID. Doit correspondre au
task_id dans run-task.streamingstringObligatoireDéfinissez la valeur sur
duplex.payloadobjectObligatoireinputobjectObligatoireDéfinissez la valeur sur
{} pour une finalisation normale de la tâche. Incluez directive pour annuler le tour de synthèse actuel.directivestringFacultatifContrôle la manière dont la tâche se termine. Actuellement, seule la valeur
cancel est prise en charge. Lorsque la valeur est définie sur cancel, le tour de synthèse actuel est annulé et le serveur renvoie immédiatement un événement task-finished sans produire d'autre audio.Après l'annulation, vous pouvez démarrer une nouvelle tâche de synthèse sur la même connexion WebSocket en envoyant un nouvel événement run-task sans vous reconnecter.- Fin normale
- Annuler la tâche
Requête
Réponse