Note
Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.
SemanticResultValue Constructor (Object)
Initializes a new instance of the SemanticResultValue class and specifies a semantic value.
Namespace: Microsoft.Speech.Recognition
Assembly: Microsoft.Speech (in Microsoft.Speech.dll)
Syntax
'Declaration
Public Sub New ( _
value As Object _
)
'Usage
Dim value As Object
Dim instance As New SemanticResultValue(value)
public SemanticResultValue(
Object value
)
Parameters
- value
Type: System.Object
The value managed by SemanticResultValue. Must be of type bool, int, float, or string.
Remarks
The SemanticResultValue created by this constructor contains only a semantic value, and does not associate the value with any particular grammar component. To associate the value with a grammar component, you must incorporate the SemanticResultValue instance in a GrammarBuilder object. The value is associated with the grammar component that preceded it, in addition to a GrammarBuilder object.
For instance, in the code fragment below, if a Grammar constructed using this GrammarBuilder instance recognizes the word "background", a value of true is set in the recognized phrase semantics.
GrammarBuilder backgroundGB=new GrammarBuilder("background");
backgroundGB.Append(new SemanticResultValue(true));
Note
Values managed by SemanticResultValue objects are defined by Object instances passed to their constructors. The underlying type of this Object must be bool, int, float, or string. Any other type will prevent construction of a Grammar instance with the SemanticResultValue.
Examples
The example below returns a Grammar for recognizing the command "Set/Change/Alter Foreground/Background … [color list]". SemanticResultValue and SemanticResultKey instances (along with Choices and GrammarBuilder objects) are used to define semantics that can be parsed on recognition. The parsed semantics will determine which color was requested and whether the foreground or background is to be modified.
The use of the SemanticResultValue constructor is highlighted, as is the explicit association of returned SemanticResultValue instances with grammar elements.
private Grammar FgBgColorGrammar() {
Grammar grammar = null;
//Allow command to begin with set, alter, change.
Choices introChoices = new Choices();
foreach (string introString in new string[] { "Change", "Set", "Alter" }) {
GrammarBuilder introGB = new GrammarBuilder(introString);
introChoices.Add(new SemanticResultValue(introGB,
String.Format("Command: {0}", introString)));
}
GrammarBuilder cmdIntro = new GrammarBuilder(introChoices);
//Now define the arguments to the command for Foreground or background and color as sementic Values
Choices fgOrbgChoice = new Choices(); GrammarBuilder backgroundGB=new GrammarBuilder("background"); backgroundGB.Append(new SemanticResultValue(true)); fgOrbgChoice.Add(backgroundGB);
fgOrbgChoice.Add((GrammarBuilder)new SemanticResultValue("foreground", false));
SemanticResultKey fgOrbgChoiceKey = new SemanticResultKey("BgOrFgBool", fgOrbgChoice);
Choices colorChoice = new Choices();
foreach (string colorName in System.Enum.GetNames(typeof(KnownColor))) {
colorChoice.Add((GrammarBuilder)
(new SemanticResultValue(colorName, (Color.FromName(colorName)).Name)));
//Uses implicit conversion of SemanticResultValue to GrammarBuilder
}
//Create GrammarBuilder for CmdArgs to be appended to CmdInto using Semantic keys.
GrammarBuilder cmdArgs = new GrammarBuilder();
cmdArgs.Append(new SemanticResultKey("BgOrFgBool", fgOrbgChoice));
cmdArgs.AppendWildcard();
cmdArgs.Append(new SemanticResultKey("colorStringList", colorChoice));
GrammarBuilder cmds = GrammarBuilder.Add(cmdIntro,
new GrammarBuilder(new SemanticResultKey("Cmd Args", cmdArgs)));
grammar = new Grammar(cmds);
grammar.Name = "Tree [Set,change,alter] [foreground,background] * color";
return grammar;
}