Cisco Cisco Unified Customer Voice Portal 11.0(1) Developer's Guide
V
OICE
E
LEMENT
:
F
ORM
C
ISCO
CVP
V
OICE
XML
3.0
Element Specifications
Copyright 2001 - 2005 Audium Corporation. All Rights Reserved. 1/14/05
40
Form
The Form voice element is used to capture any input from the caller, based on developer-specified grammars. The valid caller inputs
can be specified either directly in the voice element settings (which will create an inline grammar) or with external grammar files.
Information returned by the Form grammars are saved in element data that can then be analyzed by developer-defined components. A
Form voice element can be configured to listen for voice input only, DTMF input only, or both voice and DTMF input. In short, the
Form element is the most flexible of all CVP VoiceXML elements as it allows almost any custom information to be captured without
requiring a separate voice element. If a CVP VoiceXML voice element does not capture certain information as desired, one can
always use a Form element first, before embarking on constructing a custom voice element.
can be specified either directly in the voice element settings (which will create an inline grammar) or with external grammar files.
Information returned by the Form grammars are saved in element data that can then be analyzed by developer-defined components. A
Form voice element can be configured to listen for voice input only, DTMF input only, or both voice and DTMF input. In short, the
Form element is the most flexible of all CVP VoiceXML elements as it allows almost any custom information to be captured without
requiring a separate voice element. If a CVP VoiceXML voice element does not capture certain information as desired, one can
always use a Form element first, before embarking on constructing a custom voice element.
The Form element provides support for custom control over the VoiceXML code generation. For example, the developer can decide
what name to use for the VoiceXML field, whether or not to include a field-level slot attribute and how to name the slot attribute. The
element also supports separate options for activating help prompts and the ability to set modality for Form.
what name to use for the VoiceXML field, whether or not to include a field-level slot attribute and how to name the slot attribute. The
element also supports separate options for activating help prompts and the ability to set modality for Form.
Multiple DTMF and speech external grammars can be referenced within a single Form element, and the developer has the ability to
specify grammar weights for speech grammars and set MIME types for both speech and DTMF grammars. Additionally, the Form
element can be used to capture multiple slots, and the developer can specify for which slot(s) they want the recognition values stored
as element data. Advanced n-best processing can be enabled, and standard n-best results are stored in element data and the activity
log.
specify grammar weights for speech grammars and set MIME types for both speech and DTMF grammars. Additionally, the Form
element can be used to capture multiple slots, and the developer can specify for which slot(s) they want the recognition values stored
as element data. Advanced n-best processing can be enabled, and standard n-best results are stored in element data and the activity
log.
Settings
Name (Label)
Type
Req’d
Single
setting
value
Substitution
allowed
Default
Notes
inputmode
(Input Mode)
(Input Mode)
string enum Yes true false
both
The type of entry allowed for input. Possible values are: voice |
dtmf
dtmf
| both.
noinput_timeout
(Noinput Timeout)
(Noinput Timeout)
string
Yes true true
5s
The maximum time length allowed (in seconds) for silence or no
dtmf entry before a noinput event is thrown.
dtmf entry before a noinput event is thrown.
form_max_noinput_count
(Form Max NoInput)
(Form Max NoInput)
int ≥ 0
Yes true true
3
0
= infinite noinputs allowed.
form_max_nomatch_count
(Form Max NoMatch)
(Form Max NoMatch)
int ≥ 0
Yes true true
3
0
= infinite nomatches allowed.
form_confidence_level
(Form Confidence Level)
(Form Confidence Level)
decimal
(0.0 – 1.0)
Yes true true
0.40
The confidence level threshold to use for data capture.