SpeechRecognitionResult class

Package:

microsoft-cognitiveservices-speech-sdk

Defines result of speech recognition.

Extends

RecognitionResult

Constructors

SpeechRecognitionResult(string, ResultReason, string, number, number, string, string, string, string, string, PropertyCollection)

Creates and initializes an instance of this class.

Properties

duration	Duration of recognized speech in 100 nano second increments.
errorDetails	In case of an unsuccessful recognition, provides details of the occurred error.
language	Primary Language detected.
languageDetectionConfidence	Primary Language detection confidence (Unknown, Low, Medium, High).
offset	Offset of recognized speech in 100 nano second increments.
properties	The set of properties exposed in the result.
reason	Specifies status of the result.
resultId	Specifies the result identifier.
speakerId	speaker id from conversation transcription/id scenarios
text	Presents the recognized text in the result.

Constructor Details

SpeechRecognitionResult(string, ResultReason, string, number, number, string, string, string, string, string, PropertyCollection)

Creates and initializes an instance of this class.

new SpeechRecognitionResult(resultId?: string, reason?: ResultReason, text?: string, duration?: number, offset?: number, language?: string, languageDetectionConfidence?: string, speakerId?: string, errorDetails?: string, json?: string, properties?: PropertyCollection)

Parameters

resultId

string

The result id.

reason

ResultReason

The reason.

text

string

The recognized text.

duration

number

The duration.

offset

number

The offset into the stream.

language

string

Primary Language detected, if provided.

languageDetectionConfidence

string

Primary Language confidence ("Unknown," "Low," "Medium," "High"...), if provided.

speakerId

string

speaker id for conversation transcription, if provided.

errorDetails

string

Error details, if provided.

json

string

Additional Json, if provided.

properties

PropertyCollection

Additional properties, if provided.

Property Details

duration

Duration of recognized speech in 100 nano second increments.

number duration

Property Value

number

Duration of recognized speech in 100 nano second increments.

errorDetails

In case of an unsuccessful recognition, provides details of the occurred error.

string errorDetails

Property Value

string

a brief description of an error.

language

Primary Language detected.

string language

Property Value

string

language detected.

languageDetectionConfidence

Primary Language detection confidence (Unknown, Low, Medium, High).

string languageDetectionConfidence

Property Value

string

detection confidence strength.

offset

Offset of recognized speech in 100 nano second increments.

number offset

Property Value

number

Offset of recognized speech in 100 nano second increments.

properties

The set of properties exposed in the result.

PropertyCollection properties

Property Value

PropertyCollection

The set of properties exposed in the result.

reason

Specifies status of the result.

ResultReason reason

Property Value

ResultReason

Specifies status of the result.

resultId

Specifies the result identifier.

string resultId

Property Value

string

Specifies the result identifier.

speakerId

speaker id from conversation transcription/id scenarios

string speakerId

Property Value

string

id of speaker in given result

text

Presents the recognized text in the result.

string text

Property Value

string

Presents the recognized text in the result.