Status codes

A single Nuance Recognizer service provides a Recognize method and a DTMFRecognize method, both supporting bi-directional streaming of requests and responses.

Nuance Recognizer returns standard gRPC error  and HTTP codes as part of its responses.

Request procedure

First, the client provides a recognition request message with parameters indicating at least one grammar resource, and additionally for a speech recognition, what audio format and language to use. Optionally, it can also include parameters to control various aspects of the recognition, and arbitrary client data to be injected into call recording for reference in offline tuning workflows.

In response to this recognition request message, NRaaS returns a status message confirming the outcome of the request. When the recognition initializes successfully, the message is 200 OK.

Status messages can also be HTTP-aligned status codes. A failure to begin recognizing returns a 4xx or 5xx status.

Example 200 OK status response:

  status: {
    code: 200
    message: 'OK'
  }

When a 200 OK status is received, the client can then send one or more messages bearing binary audio samples in the format indicated in the recognize initialization message. During a speech recognition, the server responds with messages indicating the detection of the start and end of speech in the audio. Once a recognition is completed the server will send a result message indicating a normal completion or an error status message (4xx/5xx) if an error is encountered and the recognition failed. If available, the status response includes a details line with a longer description of the status.

Example full status response:

  status: {
    code: [HTTP-style return code: 100, 200, 4xx, or 5xx as appropriate.]
    message: '[Brief description of the status.]'
    details: '[Longer description if available.]'
  }

Causes of termination

The reasons for a speech or DTMF recognition terminating can include:

Speech recognition termination:

• Client ends its message stream to the server.
• Client cancels the RPC (remote procedure call).
• Server detects the end of speech.
• Server observes non-speech samples corresponding to the no_input_timeout_ms value.
• Server observes speech samples resulting in a recognition timeout corresponding to complete_timeout_ms, incomplete_timeout_ms or max_speech_timeout_ms value.
• Server observes no audio (or any message) is received for a server-configured inactivity timeout.
• Server observes the recognition duration exceeds a server-configured session timeout.
• Server encounters an error.

DTMF recognition termination:

• Client ends its message stream to the server.
• Client cancels the RPC.
• Server observes no DTMF message after the initialization message for a duration exceeding to the no_input_timeout_ms value.
• Server observes no subsequent DTMF message for a duration exceeding the dtmf_interdigit_timeout_ms value.
• Server observes no terminating character DTMF message is received after the start of the recognition for a duration corresponding to the dtmf_term_timeout_ms value.
• Server observes the terminating DTMF character.
• Server observes the recognition duration exceeds a server-configured session timeout.
• Server encounters an error.

If the client cancels the RPC, no further messages are received from the server. If the server encounters an error, it attempts to send a final error status and then cancels the RPC.

Status codes

Nuance Recognizer uses the HTTP status codes listed below. In general, values in the 400 range indicate an error in the request that your client app sent. Values in the 500 range indicate an internal error within Nuance Recognizer or another service.