asr-callsummary payload
Current version: v2
The application/x-nuance-asr-callsummary
payload provides summary information about the ASR interaction for the complete recognition turn.
In addition to the standard fields described in data field structure, messages with the application/x-nuance-asr-callsummary
dataContentType include the following fields:
fields table
Field |
Description |
sessionId |
ID of the session. |
absStartTime |
Audio stream start time. |
Recognize |
Information about the Recognizer command. See Recognizer API in the ASRaaS documentation for details. |
audioPacketStats |
Information about the audio packets received. |
firstPacketTime |
Date and time the first audio packet was received. |
lastPacketTime |
Date and time the last audio packet was received. |
utterances |
Information about the utterances in the recognition |
info |
Information about an utterance. |
snrEstimate |
The estimated signal-to-noise ratio in the utterance. |
completionCause |
In response to Recognize, the reason for the response:- SUCCESS: The result was correctly produced.
- ERROR: An error prevented the result from being computed.
- NO-INPUT-TIMEOUT: The noInputTimeout interval has elapsed: no result is delivered.
- RECOGNITION-TIMEOUT: The recognitionTimeout interval elapsed: the result may or may not be delivered.
- END-OF-STREAM: An EndOfInput command terminated the Recognize turn: the result may or may not be delivered.
- NO-MATCH: The result was produced, but is marked as rejected. This completion cause is returned for extremely noisy and/or unintelligible audio, or when the audio is not compatible with the declared audio format.
|
metrics |
Metrics for the call. |
firstAudioToResult |
The number of milliseconds from the arrival of the first audio message/binary packet after Recognize to the current time. |
audioUrn |
URN of the ASR resource. This field is helpful when downloading audio files of the utterances that were sent for recognition to ASRaaS. See AFSS API for details. |
absEndTime |
Audio stream end time. |
asrSessionId |
Identifier of the current ASR session. |
Sample payload
{
"data": {
"callsummary": {
"sessionId": "e7744c6e-7bc9-961d-975f-7942c202e868",
"absStartTime": 1705619593087,
"Recognize": [
{
"audioPacketStats": {
"firstPacketTime": "2024-01-18T23:13:13.235Z",
"lastPacketTime": "2024-01-18T23:13:43.178Z"
},
"utterances": [
{
"info": {
"snrEstimate": 19,
},
"completionCause": "SUCCESS"
}
],
"metrics": {
"firstAudioToResult": 30014
},
"audioUrn": "/2024/01/18/23/10/myappid/ASRaaS/e7744c6e-7bc9-961d-975f-7942c202e868"
}
],
"absEndTime": 1705619623267
},
"dataContentType": "application/x-nuance-asr-callsummary.v2+json",
"processingTime": {
"start_time": "2024-01-18T23:13:13.087Z",
"duration_ms": 29943
},
"userid": "7b88d547a41d88b788416084cbb7635338fad0c5780e505ca0acc07f7a0ebf15",
"asrSessionId": "e7744c6e-7bc9-961d-975f-7942c202e868",
"requestid": "e7744c6e-7bc9-961d-975f-7942c202e868"
},
"specversion": "1.0",
"service": "ASRaaS",
"source": "nuance.asr.v1.Recognizer/Recognize",
"type": "Recognize",
"id": "da0d666e-d3f6-4c2a-8353-9252ff4d6b0c",
"timestamp": "2024-01-18T23:13:43.267Z",
"datacontenttype": "application/json",
"partitionKey": {
"service": "ASRaaS",
"id": "d014084b-eb62-4816-a5ba-d79b5b457064"
},
"appid": "myappid"
}