asr-finalresultresponse payload

Current version: v2

The application/x-nuance-asr-finalresultresponse payload provides the final recognition result.

Note:

Partial results are not included in the event logs. If specified in the recognition request, partial results are streamed back to the client as part of the recognition response, but they do not trigger event logs.

In addition to the standard fields described in data field structure, messages with the application/x-nuance-asr-finalresultresponse dataContentType include the following fields:

fields table
Field	Description
response	Contains the Result payload for the final result.
redactedReason	If content was redacted, provides the reason. For example, the “suppressCallRecording” value indicates that the `suppress_call_recording` RecognitionFlags field was set to true. See ASR values possibly masked for details and Credit card numbers > ASR
asrSessionid	Identifier of the current ASR session.

Sample payload: Example 1

{
  "data": {
    "response": {
      "resultType": 0,
      "absStartMs": 1390,
      "absEndMs": 4510,
      "utteranceInfo": {
        "durationMs": 0,
        "clippingDurationMs": 0,
        "droppedSpeechPackets": 0,
        "droppedNonspeechPackets": 0,
        "dsp": {
          "snrEstimateDb": 19,
          "level": 31,
          "numChannels": 1,
          "initialSilenceMs": 200,
          "initialEnergy": -47,
          "finalEnergy": -56,
          "meanEnergy": 164
        }
      },
      "hypotheses": [
        {
          "rejected": false,
          "formattedText": "I live at 123 Main Street",
          "minimallyFormattedText": "I live at one twenty three Main Street",
          "words": [
            {
              "text": "I",
              "startMs": 200,
              "endMs": 460,
              "silenceAfterWordMs": 0,
              "optionalWordConfidence": {
                "confidence": 0.9599999785423279
              },
              "optionalWordGrammarRule": null
            },
            {
              "text": "live",
              "startMs": 460,
              "endMs": 720,
              "silenceAfterWordMs": 160,
              "optionalWordConfidence": {
                "confidence": 0.9539999961853027
              },
              "optionalWordGrammarRule": null
            },
            {
              "text": "at",
              "startMs": 880,
              "endMs": 1000,
              "silenceAfterWordMs": 0,
              "optionalWordConfidence": {
                "confidence": 0.949999988079071
              },
              "optionalWordGrammarRule": null
            },
            {
              "text": "123",
              "startMs": 1620,
              "endMs": 1840,
              "silenceAfterWordMs": 0,
              "optionalWordConfidence": {
                "confidence": 0.9700000286102295
              },
              "optionalWordGrammarRule": null
            },
            {
              "text": "Main",
              "startMs": 1840,
              "endMs": 2120,
              "silenceAfterWordMs": 0,
              "optionalWordConfidence": {
                "confidence": 0.7960000038146973
              },
              "optionalWordGrammarRule": null
            },
            {
              "text": "Street",
              "startMs": 2120,
              "endMs": 2520,
              "silenceAfterWordMs": 0,
              "optionalWordConfidence": {
                "confidence": 0.8349999785423279
              },
              "optionalWordGrammarRule": null
            }
          ],
          "encryptedTokenization": "",
          "tokenization": [
            {
              "literal": "I\\pronoun",
              "stime": 200,
              "etime": 460,
              "smff": 0,
              "emff": 1,
              "optionalWordConfidence": null
            },
            {
              "literal": "live",
              "stime": 460,
              "etime": 720,
              "smff": 2,
              "emff": 6,
              "optionalWordConfidence": null
            },
            {
              "literal": "at",
              "stime": 880,
              "etime": 1000,
              "smff": 7,
              "emff": 9,
              "optionalWordConfidence": null
            },
            {
              "literal": "one\\number",
              "stime": 1000,
              "etime": 1260,
              "smff": 10,
              "emff": 13,
              "optionalWordConfidence": null
            },
            {
              "literal": "twenty",
              "stime": 1260,
              "etime": 1620,
              "smff": 14,
              "emff": 20,
              "optionalWordConfidence": null
            },
            {
              "literal": "three",
              "stime": 1620,
              "etime": 1840,
              "smff": 21,
              "emff": 26,
              "optionalWordConfidence": null
            },
            {
              "literal": "Main",
              "stime": 1840,
              "etime": 2120,
              "smff": 27,
              "emff": 31,
              "optionalWordConfidence": null
            },
            {
              "literal": "Street",
              "stime": 2120,
              "etime": 2520,
              "smff": 32,
              "emff": 38,
              "optionalWordConfidence": null
            }
          ],
          "optionalHypothesisConfidence": {
            "confidence": 0.5849999785423279
          },
          "optionalHypothesisAverageConfidence": {
            "averageConfidence": 0.8973506689071655
          },
          "optionalHypothesisGrammarId": null,
          "optionalDetectedWuw": null
        }
      ],
      "dataPack": {
        "language": "eng-USA",
        "topic": "GEN",
        "version": "4.11.1",
        "id": ""
      }
    },
    "dataContentType": "application/x-nuance-asr-finalresultresponse.v2+json",
    "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": "e2436a4a-e033-4d8d-ab3a-d59caa320474",
  "timestamp": "2024-01-18T23:13:43.249Z",
  "datacontenttype": "application/json",
  "partitionKey": {
    "service": "ASRaaS",
    "id": "012eec8c-b262-493d-af93-04334e5690eb"
  },
  "appid": "myappid"
}

Sample payload: Example 2: Call recording suppressed

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.