post_final_transcript message

The session's result, the same as GET /v2/live/{id}'s (receive_post_processing_events).

Delivery

On the WebSocket with messages_config.receive_post_processing_events; to your callback as live.post_final_transcript with callback_config.receive_post_processing_events.

Fields

• session_id string required

  Identifier of the session.

• created_at string required

  When the message was sent (ISO 8601, UTC).

• type "post_final_transcript" required
• data object required
  3 fields

  • metadata object required
    4 fields

    • audio_duration number required

      Audio received, in seconds.

    • billing_time number required

      Billed duration, in seconds.

    • number_of_distinct_channels integer required

      Number of audio channels.

    • transcription_time number required

      How long the session ran, in seconds.

  • transcription object required
    3 fields

    • languages array of string required

      Languages heard, in order of appearance.

    • utterances array of object required

      Every final utterance, by start time.

      11 fields

      • text string required

        The transcript. With named entity recognition or PII redaction on, it carries their inline elements (<ner:name id="1">…</ner:name>, <pii:email id="1"/>).

      • start number required

        Start, in seconds from the start of the audio.

      • end number required

        End, in seconds from the start of the audio.

      • language string required

        Language spoken (ISO 639-1).

      • confidence number required

        Confidence, from 0 to 1.

      • channel integer required

        Audio channel the utterance was heard on, from 0.

      • speaker integer

        Speaker number, with diarization.

        default: null

      • words array of object required

        The words with their timestamps.

        5 fields

        • word string required

          The word, with its leading space when it follows another.

        • start number required

          Start of the word, in seconds from the start of the audio.

        • end number required

          End of the word, in seconds from the start of the audio.

        • confidence number required

          Confidence, from 0 to 1.

        • speaker integer

          Speaker of the word, with diarization.

          default: null

      • text_raw string

        The transcript without inline elements (with named entity recognition; never with PII redaction).

        default: null

      • entities array of object

        The entities of the utterance, with named entity recognition or PII redaction.

        default: null

        7 fields

        • label string

          Entity type, for example name, phone_number, location_city.

          default: null

        • id integer

          The entity's number in the session, per type: the same person is always the same number.

          default: null

        • action string

          ner: tagged; otherwise how the personal data was redacted.

          default: null

        • score number

          Confidence, from 0 to 1.

          default: null

        • text string

          The entity as heard (never sent for masked personal data unless pii.return_entities).

          default: null

        • start integer

          Offset of the entity's element in text, in characters.

          default: null

        • end integer

          End offset of the entity's element in text, in characters.

          default: null

      • forced "max_duration"

        Set when the utterance was closed by maximum_duration_without_endpointing rather than by a pause.

        default: null

    • full_transcript string required

      The final utterances' text, joined.

  • translation object

    default: null

    5 fields

    • success boolean required
    • is_empty boolean required

      true when nothing was translated.

    • exec_time number required
    • error any

      default: null

    • results array of object required

      One result per target language.

      6 fields

      • error any

        Always null.

        default: null

      • languages array of string required

        The target language of this result.

      • full_transcript string required

        The translated text, joined.

      • utterances array of object required

        The translated utterances, one per final.

        11 fields

        • text string required

          The transcript. With named entity recognition or PII redaction on, it carries their inline elements (<ner:name id="1">…</ner:name>, <pii:email id="1"/>).

        • start number required

          Start, in seconds from the start of the audio.

        • end number required

          End, in seconds from the start of the audio.

        • language string required

          Language spoken (ISO 639-1).

        • confidence number required

          Confidence, from 0 to 1.

        • channel integer required

          Audio channel the utterance was heard on, from 0.

        • speaker integer

          Speaker number, with diarization.

          default: null

        • words array of object required

          The words with their timestamps.

        • text_raw string

          The transcript without inline elements (with named entity recognition; never with PII redaction).

          default: null

        • entities array of object

          The entities of the utterance, with named entity recognition or PII redaction.

          default: null

        • forced "max_duration"

          Set when the utterance was closed by maximum_duration_without_endpointing rather than by a pause.

          default: null

      • sentences array of any required

        Always empty.

      • subtitles array of any required

        Always empty.

Example

{
  "session_id": "string",
  "created_at": "string",
  "type": "post_final_transcript",
  "data": {
    "metadata": {
      "audio_duration": 0.5,
      "billing_time": 0.5,
      "number_of_distinct_channels": 0,
      "transcription_time": 0.5
    },
    "transcription": {
      "languages": [
        "string"
      ],
      "utterances": [
        {
          "text": "Hello, how can I help you?",
          "start": 0.5,
          "end": 0.5,
          "language": "en",
          "confidence": 0.5,
          "channel": 0,
          "speaker": 0,
          "words": [],
          "text_raw": "string",
          "entities": [],
          "forced": "max_duration"
        }
      ],
      "full_transcript": "string"
    },
    "translation": {
      "success": false,
      "is_empty": false,
      "exec_time": 0.5,
      "error": null,
      "results": [
        {
          "error": null,
          "languages": [],
          "full_transcript": "string",
          "utterances": [],
          "sentences": [],
          "subtitles": []
        }
      ]
    }
  }
}