API Documentation
Upload
Pre-recorded endpoints
Live endpoints
Live WS actions
Live WS messages
- Realtime messages
- Post-processing messages
- Acknowledgment messages
- Lifecycle messages
Live callbacks
- Realtime messages
- Post-processing messages
- Acknowledgment messages
- Lifecycle messages
Live webhooks
- Lifecycle messages
Named Entity Recognition
Payload definition for the callback event live.named_entity_recognition.
Id of the job
live.named_entity_recognition The live message payload as sent to the WebSocket
Id of the live session
Date of creation of the message. The date is formatted as an ISO 8601 string
Error message if the addon failed
The error message
named_entity_recognition The message data. "null" if the addon failed
Id of the utterance used for this result
The transcribed utterance
All the detected languages in the audio sorted from the most detected to the less detected
af, sq, am, ar, hy, as, ast, az, ba, eu, be, bn, bs, br, bg, my, ca, ceb, zh, hr, cs, da, nl, en, et, fo, fi, fr, fy, ff, gd, gl, lg, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, ig, ilo, id, ga, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mo, mn, mymr, ne, no, nn, oc, or, pa, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, ss, sv, tl, tg, ta, tt, te, th, bo, tn, tr, tk, uk, ur, uz, vi, cy, wo, xh, yi, yo, zu Start timestamp in seconds of this utterance
End timestamp in seconds of this utterance
Confidence on the transcribed utterance (1 = 100% confident)
Audio channel of where this utterance has been transcribed from
x > 0List of words of the utterance, split by timestamp
Spoken word
Start timestamps in seconds of the spoken word
End timestamps in seconds of the spoken word
Confidence on the transcribed word (1 = 100% confident)
Transcription for this utterance
If diarization enabled, speaker identification number
x > 0Was this page helpful?
{
"id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
"event": "live.named_entity_recognition",
"payload": {
"session_id": "4a39145c-2844-4557-8f34-34883f7be7d9",
"created_at": "2021-09-01T12:00:00.123Z",
"error": null,
"type": "named_entity_recognition",
"data": {
"utterance_id": "00-00000011",
"utterance": {
"language": "en",
"start": 123,
"end": 123,
"confidence": 123,
"channel": 1,
"speaker": 1,
"words": [
{
"word": "<string>",
"start": 123,
"end": 123,
"confidence": 123
}
],
"text": "<string>"
},
"results": [
{
"entity_type": "<string>",
"text": "<string>",
"start": 123,
"end": 123
}
]
}
}
}