Cisco Cisco Unified Customer Voice Portal 10.0(1) Developer's Guide
V
OICE
E
LEMENT
: F
ORM
_W
ITH
_C
ONFIRM
C
ISCO
CVP V
OICE
XML 3.1
Element Specifications
Name (Label)
Type
Req’d Single
setting
Substitution
allowed
Default
Notes
value
field_slot
(Field Slot)
(Field Slot)
string
No
true
true
None
The name to assign to the VXML field-level slot attribute. If
left unspecified (i.e. the default value), the field will not have a
slot attribute.
left unspecified (i.e. the default value), the field will not have a
slot attribute.
slot_element_data
(Slot Element Data)
(Slot Element Data)
string
No
false
true
None
Specifies for which grammar slot the return value should be
stored as element data. This is a repeatable setting so multiple
slot names can be specified. See notes below for further
details.
stored as element data. This is a repeatable setting so multiple
slot names can be specified. See notes below for further
details.
maxnbest
(Maxnbest)
(Maxnbest)
int ≥ 1
Yes
true
true
1
The maximum number of speech recognition results that can be
generated per voice input.
generated per voice input.
Notes:
•
The voice browser requires the top-level slot name in a grammar (whether inline or external) to match the field-level slot attribute
(or the field name attribute if the slot attribute is unspecified), in order for the field name variable (and hence the CVP VoiceXML
“value” element data) to be defined. For inline grammars, the CVP VoiceXML Form_With_Confirm element automatically
generates the grammar slot name based on the slot attribute or the field name. For custom-defined grammars that are referenced
from an external source, it is the developer’s job to configure “
(or the field name attribute if the slot attribute is unspecified), in order for the field name variable (and hence the CVP VoiceXML
“value” element data) to be defined. For inline grammars, the CVP VoiceXML Form_With_Confirm element automatically
generates the grammar slot name based on the slot attribute or the field name. For custom-defined grammars that are referenced
from an external source, it is the developer’s job to configure “
Field Name
” and/or “
Field Slot
” correctly so that the above
requirement is met.
•
For a grammar that returns either different slots for different inputs or multiple slots per utterance, there are two ways to configure
the Form_With_Confirm element to store the slot/value pairs:
the Form_With_Confirm element to store the slot/value pairs:
o
Leave the “
slot_element_data
” setting empty. The Form_With_Confirm element will create element data named
“nbestInterpretationX” (where X is from 1 to the length of the n-best list) that contains a string that uses delimiters “+” and “:”
to separate the multiple slot names from their values. For example: “+Slot1:value1+Slot2:value2...”. A developer would then
need to parse this string in a subsequent element to obtain the different slot name and value pairs.
to separate the multiple slot names from their values. For example: “+Slot1:value1+Slot2:value2...”. A developer would then
need to parse this string in a subsequent element to obtain the different slot name and value pairs.
o
Configure the “
slot_element_data
” setting with the names for all the slots that can be returned. The Form_With_Confirm
element will create a new set of n-best element data to store the recognition results for each slot listed in that setting. The
element data will be named as <SLOT_ELEMENT_DATAX> (where “SLOT_ELEMENT_DATA” is a string identical to the
setting value and X is from 1 to the length of the n-best list). For example, if “
element data will be named as <SLOT_ELEMENT_DATAX> (where “SLOT_ELEMENT_DATA” is a string identical to the
setting value and X is from 1 to the length of the n-best list). For example, if “
slot_element_data
” have two values “city”
and “state” and there are three n-best results triggered, then a total of six element data in the names of “city1”, “city2”, “city3”,
“state1”, “state2”, and “state3” will be created to store each of the n-best values for the “city” and “state” slots. Note that if n-
best processing is disabled by setting
“state1”, “state2”, and “state3” will be created to store each of the n-best values for the “city” and “state” slots. Note that if n-
best processing is disabled by setting
maxnbest
to 1, then only one interpretation will be returned per input and thereby only
one element data per slot (“city1” and “state1”) will be created.
Copyright 2001 - 2005 Audium Corporation. All Rights Reserved. 10/05
51