Référence des server-sent events que le service de reconnaissance vocale en temps réel Paraformer transmet aux clients via WebSocket. Cette rubrique détaille la structure des données et la sémantique des champs des quatre types d'événements : task-started, result-generated, task-finished et task-failed.
Guide utilisateur : Pour plus de détails sur les modèles et des conseils de sélection, consultez Speech-to-text.
Flux d'interaction des événements : Pour consulter le diagramme de séquence des événements, reportez-vous à WebSocket API.
task-started
Description : La tâche a démarré avec succès. Le client peut commencer à envoyer des données audio.
headerobject Properties task_idstring ID de tâche généré par le client (format UUID). eventstring Type d'événement. Toujours task-started. attributesobject Attributs supplémentaires. Généralement vide. | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-started",
"attributes": {}
},
"payload": {}
}
|
payloadobject Toujours {}. |
result-generated
Description : Résultat de la reconnaissance. Comprend les résultats intermédiaires (sentence_end=false) et les résultats finaux (sentence_end=true).
headerobject Properties task_idstring ID de tâche généré par le client (format UUID). eventstring Type d'événement. Toujours result-generated. | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "result-generated",
"attributes": {}
},
"payload": {
"output": {
"sentence": {
"begin_time": 170,
"end_time": null,
"text": "Okay, I got it.",
"heartbeat": false,
"sentence_end": true,
"words": [
{
"begin_time": 170,
"end_time": 295,
"text": "Okay",
"punctuation": ","
},
{
"begin_time": 295,
"end_time": 503,
"text": "I",
"punctuation": ""
},
{
"begin_time": 503,
"end_time": 711,
"text": "got",
"punctuation": ""
},
{
"begin_time": 711,
"end_time": 920,
"text": "it",
"punctuation": ""
}
]
}
},
"usage": {
"duration": 3
}
}
}
|
payloadobject Properties outputobject Properties usageobject Si payload.output.sentence.sentence_end est false (phrase en cours non terminée), usage vaut null. Si payload.output.sentence.sentence_end est true (phrase en cours terminée), usage.duration indique la durée facturable de la tâche actuelle. Properties durationinteger Durée facturable de la tâche, en secondes. Properties sentenceobject Properties begin_timeinteger Horodatage de début de la phrase, en millisecondes. end_timeinteger Horodatage de fin de la phrase, en millisecondes. textstring Texte reconnu. heartbeatboolean Si vrai, ignorez ce résultat (paquet heartbeat). sentence_endboolean Indique si la phrase est terminée (true = résultat final, false = résultat intermédiaire). emo_tagstring Important
- Seul paraformer-realtime-8k-v2 prend en charge cette fonctionnalité.
- Cette fonctionnalité nécessite la désactivation de la segmentation sémantique. Définissez
semantic_punctuation_enabled sur false dans l'événement run-task.
- Le résultat de la reconnaissance des émotions n'est renvoyé que lorsque
payload.output.sentence.sentence_end est true.
Sentiment de la phrase actuelle :
- positive : Sentiment positif, tel que heureux ou satisfait.
- negative : Sentiment négatif, tel que fâché ou abattu.
- neutral : Aucun sentiment distinct.
emo_confidencefloat Important
- Seul paraformer-realtime-8k-v2 prend en charge cette fonctionnalité.
- Cette fonctionnalité nécessite la désactivation de la segmentation sémantique. Définissez
semantic_punctuation_enabled sur false dans l'événement run-task.
- Le résultat de la reconnaissance des émotions n'est renvoyé que lorsque
payload.output.sentence.sentence_end est true.
Score de confiance de l'émotion dans la plage [0,0, 1,0]. Une valeur plus élevée indique une confiance accrue. wordsarray[object] Informations d'horodatage au niveau du mot. Properties begin_timeinteger Horodatage de début du mot, en millisecondes. end_timeinteger Horodatage de fin du mot, en millisecondes. textstring Texte reconnu. punctuationstring Signe de ponctuation. |
task-finished
Description : La tâche s'est terminée normalement. Fermez la connexion ou réutilisez-la.
headerobject Properties task_idstring ID de tâche généré par le client (format UUID). eventstring Type d'événement. Toujours task-finished. attributesobject Attributs supplémentaires. Généralement vide. | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-finished",
"attributes": {}
},
"payload": {
"output": {},
"usage": null
}
}
|
payloadobject Contenu ignorable. Généralement {}. |
task-failed
Description : Échec de la tâche. La connexion est fermée et non réutilisable.
headerobject Properties task_idstring ID de tâche généré par le client (format UUID). eventstring Type d'événement. Toujours task-failed. error_codestring Description du type d'erreur. error_messagestring Cause spécifique de l'erreur. attributesobject Attributs supplémentaires. Généralement vide. | {
"header": {
"task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
"event": "task-failed",
"error_code": "CLIENT_ERROR",
"error_message": "request timeout after 23 seconds.",
"attributes": {}
},
"payload": {}
}
|
payloadobject Toujours {}. |