NR payloads

The series of events for an NRaaS interaction depends on the type of recognition: speech or DTMF. The following table lists the events that can be sent by NRaaS and the type of recognition they report.

A typical NRaaS speech recognition interaction includes a subset of the following events:

  • An application/x-nuance-nrc-recognitioninit event is first sent and includes the content of the RecognitionInit, which provides the parameters and resources for recognition.

  • The application/x-nuance-nrc-status event is usually sent after the recognitionInit event is received. It provides the content of the 200 OK status message that is sent back to the client to indicate that recognition parameters and resources were accepted and successfully configured.

  • If NR doesn’t detect speech, the application/x-nuance-nrc-control event appears. It includes the amount of time given for attempting to detect speech.

  • The application/x-nuance-nrc-startofspeech event indicates the beginning of audio as detected by NR.

  • In a speech recognition interaction, the application/x-nuance-nrc-endofspeech event indicates the end of audio as detected by NR. DTMF does not provide an endofspeech event.

  • The application/x-nuance-nrc-result event contains the formatted recognition result and the recognition status to indicate a successful recognition, speech detection, and more.

  • Finally, the application/x-nuance-nrc-callsummary event is sent. It provides a summary of the ASR interaction (full recognition turn), including request parameters, results, statistics, and internal events.

A typical DTMF recognition interaction includes a subset of the following events:

  • An application/x-nuance-nrc-DTMFrecognitioninit event is first sent and includes the content of the RecognitionInit, which provides the parameters and resources for recognition.

  • The application/x-nuance-nrc-status event is usually sent after the DTMFrecognitioninit event is received. It provides the content of the 200 OK status message that is sent back to the client to indicate that recognition parameters and resources were accepted and successfully configured.

  • If NR doesn’t detect DTMF, the application/x-nuance-nrc-control event appears. It includes the amount of time given for attempting to detect DTMF.

  • Finally, the application/x-nuance-nrc-result event contains the formatted recognition result and the recognition status to indicate a successful recognition, speech detection, and more.

nrc-recognitionInit payload

Content of the recognitionInit sent in the NRaaS RecognitionRequest.

nrc-dtmfrecognitioninit payload

Content of the dtmfrecognitioninit sent in the NRaaS DTMFRecognitionRequest.

nrc-status payload

Content of the 200 Continue status message that is sent back to the client.

nrc-control payload

Content of the control status message that appears if no audio is detected.

nrc-startofspeech payload

Beginning of audio as detected by NRaaS.

nrc-endofspeech payload

End of audio as detected by NRaaS.

nrc-result payload

Final NR recognition result.

nrc-callsummary payload

Summary information about the NRaaS interaction (full recognition turn), including request parameters, results, statistics, and internal events.