swirec_simple_result_key

Specifies a single key to return in the recognition result instead of all keys.

Value

String identifying any key in the grammar (can contain any wchar value).

Default

(empty)

How to set

In a grammar using a <meta> tag (see the text on recognition-time parameters in Parameters set in grammar files).

Usage

Seldom used, but useful as a stylistic convention between grammar author and the application developer. For example, when browser cannot parse the keys found in a normal recognition result.

Performance

No performance benefits.

This parameter affects XML recognition results in the Emma-format only. (The format depends on the media type provided by the voice browser or the application.) The specified key is the only key value returned. (When this parameter is set, the Recognizer ignores the setting of swirec_extra_nbest_keys.) You can specify any key in the grammar, including keys with the "SWI_" prefix.

When this parameter is set in more than one active grammar, the Recognizer treats each setting individually. For each recognition result on the n-best list, the Recognizer consults the associated grammar, verifies whether the parameter has been set, and if so, reports the specified key in the result.

Sample definition in a grammar file:

<meta name="swirec_simple_result_key" content="MYKEY"/>