PreviousNextIndex
Nodes and Palette Options > Detailed Palette Option Descriptions > Property
 
Property

Type

Form item

Available from

Purpose

The Property item is used to set one or more values that affect system behavior. These values include properties like timeouts and recognition processes.

Behavior

When placed in the AppRoot node, the Property item sets application-wide defaults for the designated properties. When placed in a node, the Property item sets the designated properties at the node level. When attached to a node item, the Property item sets the designated properties at the item level.

When a given property is set using the Property item, that setting affects anything below it in the application. For example, if you set the Timeout Complete property in a node, that setting affects everything that comes after it in the node. It does not, however, affect other nodes. At a given level, the property value remains in effect until it is reset at a later point. For example, if you have a node with two property value settings for a particular property within the same node, the first stays in effect until the application reaches the second property setting.

A property setting at a lower level overrides a property setting for the same property at a higher level. For example, if you have the DTMF Terminating Character property set in both the AppRoot node and another DTMF Terminating Character property set in a node, the property at the node level overrides the one set at the AppRoot node level.

You can set as many or as few property settings as you want in a single Property item.

Note:

To set properties that are not defined within the Property item, use the External Property item.

Properties

The properties for the Property item are separated into three general groups according to their functions:

Speech (ASR) Property Setting

Description

Confidence Level

Enter the minimum required level of confidence for an ASR engine to return a recognition of a speech utterance. The system rejects any utterance that returns a confidence level lower than this value and throws a No Match event.

The range of valid values for this property is 0.0 through 1.0. A value of 0.0 means that minimum confidence is required for a recognition. A value of 1.0 means that a maximum confidence is required for a recognition.

Default = 0.5

Sensitivity

Enter the sensitivity level for speech recognition to start. This setting determines how loud an utterance must be for the ASR engine to start speech recognition.

The range of valid values for this property is 0.0 through 1.0. The higher the number you enter in this field, the more sensitive the ASR engine is, and the less amount of input volume it takes to start speech recognition.

Default = 0.5

Speed vs. Accuracy

Enter the number to determine the balance between speed of recognition and accuracy of recognition.

The range of valid values for this property is 0.0 through 1.0. A lower value tips the balance in favor of speed of recognition. A higher value tips the balance in favor of accuracy of recognition.

Default = 0.5

Timeout Complete

Enter the number of seconds of silence the system must wait before finalizing an utterance. Note that, if no utterance was ever recognized with a match, the system uses this timeout period to determine when to throw a No Match event. If an utterance was successfully recognized, this is the period of silence the system waits before returning the result.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

Take care when setting this property. If you set the number too high, it can slow down system response time, even for successful recognitions. If you set the number too low, it can lead to an utterance being cut off prematurely. Reasonable values for this property are usually in the range 5 to 15 seconds.

This property has no default value. The default value for this is set on the ASR server. If you set a value in this field, this value overrides the default on the ASR server.

See also the next property, Timeout Incomplete.

Timeout Incomplete

Enter the number of seconds of silence the system must wait before finalizing an incomplete recognition of an utterance. An incomplete recognition is defined as an incomplete match of all active grammars. In this case, once the timeout is reached, the system rejects the utterance and throws a No Match event.

An incomplete timeout can also occur when there is a complete match of an active grammar but it is possible to speak further and still match the grammar. By contrast, a complete timeout (see previous property, Timeout Complete) takes place when there is a complete match of an active grammar and no further input can be recognized.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

Take care when setting this property. If you set the number too high, it can slow down system response time, even for successful recognitions. If you set the number too low, it can lead to an utterance being cut off prematurely. This property is usually set lower than the Timeout Complete, but high enough to allow callers to pause mid-utterance, for instance, for a breath. Reasonable values for this property are usually in the range 2 to 5 seconds.

This property has no default value. The default value for this is set on the ASR server. If you set a value in this field, this value overrides the default on the ASR server.

See also the previous property, Timeout Complete.

Maximum Speech

Enter the number of seconds you want to allow the caller to continue speaking before the system ends the recognition attempt and throws a maxspeechtimeout event.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

This property has no default value. The default value for this is set on the ASR server. If you set a value in this field, this value overrides the default on the ASR server.


General Property Setting

Description

Interdigit timeout

Enter the number of seconds the system must wait for an additional DTMF input when such an input is expected.

This property becomes active when a DTMF expects and requires a certain number of DTMF input digits. For example, when collecting a telephone number from a caller, the DTMF grammar might be set up to require a ten-digit number. If the caller enters eight digits and then stops, this property is triggered at the end of the timeout setting, and the system throws a No Match event.

Valid values for this property are positive integers.

This property has no default value. The default value for this is set on the server that handles DTMF responses. If you set a value in this field, this value overrides the default on that server.

Private

When enabled, this property will omit certain pieces of data from the logs. For example, a user's credit card number might be private information that should be suppressed from the logs.

When enabled, it enables the privacy option on Voice Portal only. For more information on privacy option, refer the "Privacy feature support for VoiceXML applications" section of Planning for Voice Portal guide.

Note:

This property is not applicable for Interactive Response.

Terminating timeout

Number of seconds the system must wait for an additional DTMF input when such an input is possible.

This property becomes active when a DTMF can accept a variable number of DTMF input digits. For example, when collecting an account number from a caller, the account might be either seven or eight digits long. If the caller enters seven digits and then stops, this property is triggered at the end of the timeout setting, and the system returns a successful recognition result.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

This property has no default value. The default value for this is set on the server that handles DTMF responses. If you set a value in this field, this value overrides the default on that server.

Terminating character

The DTMF key press that the system must use to end a DTMF input.

When this key is pressed, the system ends the DTMF input recognition and returns the appropriate result.

Valid values for this property are the numbers 0 through 9, the star (*) key, and the pound (#) key. The default is #


Fetch Property Setting

Description

fetchTimeout

The timeout for fetches. The value is a Time Designation. The default value is platform-dependent.

grammarmaxage

Tells the platform the maximum acceptable age, in seconds, of cached grammars. The default is platform-specific.

grammarmaxstale

Tells the platform the maximum acceptable staleness, in seconds, of expired cached grammars. The default is platform-specific.


Transitional Audio Property Setting

Description

Audio Prompt

Select the prompt to use as the transitional audio prompt.

Note that a prompt must be defined as a transitional audio prompt when it is created. Only transitional audio prompts can be selected for this property.

Delay seconds

Enter the number of seconds the system must wait before starting to play the transitional audio prompt.

The idea is that, if the system response time is short enough, it might be better to have a short period of silence, rather than starting to play an audio file that is immediately cut off.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

This property has no default value. The default value for this is set on the IVR system. If you set a value in this field, this value overrides the default on the IVR system.

Minimum play seconds

Enter the minimum number of seconds of the prompt that you want the system to play before proceeding.

The idea is that, once the caller does begin to hear the prompt, it should not be stopped too quickly. This can be useful, for instance, when there is a short message you want callers to hear before the system proceeds.

Valid values for this property are positive real numbers. Numbers can be of the format "n", "n.", ".n" or "n.n", where n represents any sequence of one or more digits.

This property has no default value. The default value for this is set on the IVR system. If you set a value in this field, this value overrides the default on the IVR system.



PreviousNextIndex

©2009, Avaya Inc. All rights reserved.