Skip to main content

Fun-ASR-Realtime Événements serveur

Le service de reconnaissance vocale en temps réel Fun-ASR-Realtime transmet des événements côté serveur au client via WebSocket. Cette rubrique décrit les structures de données et les champs des quatre types d'événements suivants : task-started, result-generated, task-finished et task-failed.

task-started

La tâche a démarré avec succès. Le client peut commencer à envoyer des données audio.
headerobject

Properties

task_idstringID de tâche généré par le client (format UUID).eventstringType d'événement. Toujours task-started.attributesobjectAttributs supplémentaires. Généralement vide.
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-started",
        "attributes": {}
    },
    "payload": {}
}
payloadobjectToujours {}.

result-generated

Résultat de la reconnaissance. Comprend les résultats intermédiaires (sentence_end=false) et finaux (sentence_end=true). Le premier résultat intermédiaire d'une nouvelle phrase contient sentence_begin=true.
headerobject

Properties

task_idstringID de tâche généré par le client (format UUID).eventstringType d'événement. Toujours result-generated.usageobjectSi 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 terminée), usage.duration correspond à la durée facturée pour la tâche en cours.

Properties

durationintegerDurée facturée de la tâche, en secondes.
Sentence-start result:
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 0,
        "end_time": null,
        "text": "",
        "sentence_begin": true,
        "sentence_end": false,
        "sentence_id": 1,
        "words": []
      }
    },
    "usage": null
  }
}
Final result:
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "begin_time": 170,
        "end_time": 920,
        "text": "OK, got it.",
        "heartbeat": false,
        "sentence_end": true,
        "sentence_id": 1,
        "words": [
          {
            "begin_time": 170,
            "end_time": 295,
            "text": "OK",
            "punctuation": ","
          },
          {
            "begin_time": 295,
            "end_time": 503,
            "text": "got",
            "punctuation": ""
          },
          {
            "begin_time": 503,
            "end_time": 711,
            "text": "it",
            "punctuation": ""
          },
          {
            "begin_time": 711,
            "end_time": 920,
            "text": "",
            "punctuation": "."
          }
        ]
      }
    },
    "usage": {
      "duration": 3
    }
  }
}
payloadobject

Properties

outputobject

Properties

sentenceobject

Properties

begin_timeintegerHorodatage de début de la phrase, en millisecondes.end_timeintegerHorodatage de fin de la phrase, en millisecondes.textstringTexte reconnu.heartbeatbooleanSi vrai, le résultat est un paquet de battement de cœur et peut être ignoré.sentence_beginbooleanSignale le début d'une phrase.sentence_endbooleanIndique si la phrase est terminée (true = résultat final, false = résultat intermédiaire).sentence_idintegerIdentifiant séquentiel de la phrase. Dans les résultats normaux, sentence_id s'incrémente à partir de 1. Pour un paquet de battement de cœur (heartbeat vrai), sentence_id vaut toujours 0.wordsarray[object]Horodatages au niveau des mots.

Properties

begin_timeintegerHorodatage de début du mot, en millisecondes.end_timeintegerHorodatage de fin du mot, en millisecondes.textstringTexte reconnu.punctuationstringSigne de ponctuation.

task-finished

La tâche s'est terminée normalement. Vous pouvez fermer la connexion ou la réutiliser.
headerobject

Properties

task_idstringID de tâche généré par le client (format UUID).eventstringType d'événement. Toujours task-finished.attributesobjectAttributs supplémentaires. Généralement vide.
{
    "header": {
        "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
        "event": "task-finished",
        "attributes": {}
    },
    "payload": {
        "output": {},
        "usage": null
    }
}
payloadobjectChamp ignorable. Valeur généralement {}.

task-failed

Échec de la tâche. La connexion est fermée et ne peut pas être réutilisée.
headerobject

Properties

task_idstringID de tâche généré par le client (format UUID).eventstringType d'événement. Toujours task-failed.error_codestringDescription du type d'erreur.error_messagestringCause spécifique de l'erreur.attributesobjectAttributs 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": {}
}
payloadobjectToujours {}.