AT&T API Platform SDK for Microsoft®  2.3.3
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Properties
ATT_MSSDK.Speechv3.NBest Class Reference

NBest returned by speech to text response. NBest is a complex structure that holds the results of the transcription. Supports multiple transcriptions. More...

List of all members.

Public Member Functions

 NBest ()
 Initializes a new instance of the NBest class.

Properties

decimal Confidence [get, set]
 Gets or sets the Confidence. The confidence value of the Hypothesis, a value between 0.0 and 1.0 inclusive.
string Hypothesis [get, set]
 Gets or sets the Hypothesis. The transcription of the audio.
string LanguageId [get, set]
 Gets or sets the LanguageId. The language used to decode the Hypothesis. Represented using the two-letter ISO 639 language code, hyphen, two-letter ISO 3166 country code in lower case, e.g. “en-us”.
string Grade [get, set]
 Gets or sets the Grade. A machine-readable string indicating an assessment of utterance/result quality and the recommended treatment of the Hypothesis. The assessment reflects a confidence region based on prior experience with similar results. accept - the hypothesis value has acceptable confidence confirm - the hypothesis should be independently confirmed due to lower confidence reject - the hypothesis should be rejected due to low confidence.
string ResultText [get, set]
 Gets or sets the ResultText. A text string prepared according to the output domain of the application package. The string will generally be a formatted version of the hypothesis, but the words may have been altered through insertions/deletions/substitutions to make the result more readable or usable for the client.
List< string > Words [get, set]
 Gets or sets the Words. List of strings The words of the Hypothesis split into separate strings. May omit some of the words of the Hypothesis string, and can be empty. Never contains words not in hypothesis string.
List< decimal > WordScores [get, set]
 Gets or sets the Words. List of numbers The confidence scores for each of the strings in the words array. Each value ranges from 0.0 to 1.0 inclusive.
NluHypothesis NluHypothesis [get, set]
 Gets or sets the value of NluHypothesis.

Detailed Description

NBest returned by speech to text response. NBest is a complex structure that holds the results of the transcription. Supports multiple transcriptions.


Constructor & Destructor Documentation

Initializes a new instance of the NBest class.


Property Documentation

Gets or sets the Confidence. The confidence value of the Hypothesis, a value between 0.0 and 1.0 inclusive.

string ATT_MSSDK.Speechv3.NBest.Grade [get, set]

Gets or sets the Grade. A machine-readable string indicating an assessment of utterance/result quality and the recommended treatment of the Hypothesis. The assessment reflects a confidence region based on prior experience with similar results. accept - the hypothesis value has acceptable confidence confirm - the hypothesis should be independently confirmed due to lower confidence reject - the hypothesis should be rejected due to low confidence.

Gets or sets the Hypothesis. The transcription of the audio.

Gets or sets the LanguageId. The language used to decode the Hypothesis. Represented using the two-letter ISO 639 language code, hyphen, two-letter ISO 3166 country code in lower case, e.g. “en-us”.

Gets or sets the ResultText. A text string prepared according to the output domain of the application package. The string will generally be a formatted version of the hypothesis, but the words may have been altered through insertions/deletions/substitutions to make the result more readable or usable for the client.

List<string> ATT_MSSDK.Speechv3.NBest.Words [get, set]

Gets or sets the Words. List of strings The words of the Hypothesis split into separate strings. May omit some of the words of the Hypothesis string, and can be empty. Never contains words not in hypothesis string.

List<decimal> ATT_MSSDK.Speechv3.NBest.WordScores [get, set]

Gets or sets the Words. List of numbers The confidence scores for each of the strings in the words array. Each value ranges from 0.0 to 1.0 inclusive.