Home > Articles > Web Services > XML

This chapter is from the book

This chapter is from the book

3.41 property

Element type

property

Attributes

name | value

Parents

field | form | initial | menu | object | record | subdialog | transfer | vxml

Children

None.

Description

Sets the platform property of the given name to the given value. This element allows the VoiceXML author to fine-tune the interpreter's behavior. Your mileage may vary with many of the properties described here, as VoiceXML platforms vary greatly in this respect.

DTD

<!ELEMENT property EMPTY >
<!ATTLIST property
  name  NMTOKEN #REQUIRED
  value CDATA   #REQUIRED >

Language model

Attributes

  • name : NMTOKEN

    The name of the platform property to set. A VoiceXML platform can support platform-specific properties. These should be named using the Java-package URL convention, e.g. com.voicegenie.asrinittimeout.

  • value : CDATA

    The value to which the named property should be set.

There is a number of properties that must be supported by all VoiceXML compliant platforms.

The following are the generic speech recognizer properties:

  • completetimeout

    The length of silence required after the user speech before the speech recognizer finalizes a result (either accepting it or throwing a nomatch event). The completetimeout value is used when the speech is a complete match of an active grammar. By contrast, the incompletetimeout is used when the speech is an incomplete match of an active grammar. A too long completetimeout value delays the result completion and therefore can make the computer's response slow. A short completetimeout may lead to an utterance being broken up inappropriately. Reasonable completetimeout values are typically in the range of 0.3 to 1.0 seconds.

  • confidencelevel

    The speech recognition confidence level, a floating point value in the range of 0.0 to 1.0. Results are rejected (a nomatch event is thrown) when the engine's confidence in its interpretation is below this threshold. A value of 0.0 means that minimum confidence is needed for a recognition, and a value of 1.0 requires maximum confidence. The default value is 0.5.

  • incompletetimeout

    The required length of silence after the user speech before the recognizer finalizes a result. The incompletetimeout applies when the speech prior to the silence is an incomplete match of all active grammars. In this case, once the timeout has elapsed, the partial result is rejected (with a nomatch event). The incompletetimeout also applies when the speech prior to the silence is a complete match of an active grammar, but where it is possible to speak further and still match the grammar. By contrast, the completetimeout is used when the speech is a complete match to an active grammar and no further words can bespoken. A long incompletetimeout value delays the result completion and therefore can make the computer's response slow. A short incompletetimeout may lead to an utterance being broken up inappropriately. The incompletetimeout is usually longer than the completetimeout to allow users to pause in mid-utterance (for example, to breathe).

  • maxspeechtimeout (2.0)

    The maximum duration of user speech. If this time has elapsed before the user stops speaking, the event maxspeechtimeout is thrown. The default duration is platform dependent.

  • sensitivity

    The sensitivity level. A value of 1.0 means that the recognition is highly sensitive to quiet input. A value of 0.0 means it is least sensitive to noise. The default value is 0.5.

  • speedvsaccuracy

    A hint specifying the desired balance between speed and accuracy. A value of 0.0 means fastest recognition; a value of 1.0 means best accuracy. The default value is 0.5.

The following are the generic DTMF recognizer properties:

  • interdigittimeout

    The inter-digit timeout value to use when recognizing DTMF input. The default is platform dependent.

  • termchar

    The terminating DTMF character for DTMF input recognition. The default value is "#".

  • termtimeout

    The terminating timeout to use when recognizing DTMF input. The default value is "0s".

The following are the prompt and collect properties:

  • bargein

    The bargein attribute to use for prompts. Setting this to true allows barge-in by default. Setting it to false disallows barge-in. The default value is true.

  • bargeintype

    Sets the type of bargein to energy, speech, or recognition. Default is platform-specific.

  • timeout

    The time after which a noinput event is thrown. The default value is platform dependent.

The following are the fetching properties:

  • audiofetchhint

    This tells the platform whether it can attempt to optimize dialog interpretation by prefetching audio. The value is either safe to indicate audio is only fetched when it is needed, or prefetch to permit, but not require, the platform to prefetch the audio. The default value is prefetch.

  • audiomaxage

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

  • audiomaxstale

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

  • documentfetchhint

    Tells the platform whether documents may be prefetched. The value is either safe (the default) or prefetch.

  • documentmaxage

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

  • documentmaxstale

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

  • fetchaudio

    The URI of the audio to play while waiting for a document to be fetched. The default is not to play any audio during fetch delays. There are no fetchaudio properties for audio, grammars, objects, and scripts. The fetching of the audio clip is governed by the audiofetchhint, audiomaxage, audiomaxstale, and fetchtimeout properties in effect at the time of the fetch. The playing of the audio clip is governed by the fetchaudiodelay and fetchaudiominimum properties in effect at the time of the fetch.

  • fetchaudiodelay (2.0)

    The time interval to wait at the start of a fetch delay before playing the fetchaudio source. The default interval is platform dependent, e.g. "2s". The idea is that when a fetch delay is short, it may be better to have a few seconds of silence instead of a bit of fetchaudio that is immediately cut off.

  • fetchaudiominimum (2.0)

    The minimum time interval to play a fetchaudio source, once started, even if the fetch result arrives in the meantime. The default is platform dependent, e.g. "5s". The idea is that once the user does begin to hear fetchaudio, it should not be stopped too quickly.

  • fetchtimeout

    The timeout for fetches. The default value is platform dependent.

  • grammarfetchhint

    Tells the platform whether grammars may be prefetched. The value is either prefetch (the default) or safe.

  • 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.

  • objectfetchhint

    Tells the platform whether the URI contents for object may be prefetched. The values are prefetch (the default) or safe.

  • objectmaxage

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

  • objectmaxstale

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

  • scriptfetchhint

    Tells the platform whether scripts may be prefetched. The values are prefetch (the default) or safe.

  • scriptmaxage

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

  • scriptmaxstale

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

The following are miscellaneous properties:

  • inputmodes

    This property determines which input mode to use. The input modes are dtmf and voice. On platforms that support both modes, inputmodes defaults to "dtmf voice". To disable speech recognition, set inputmodes to "dtmf". To disable DTMF, set it to "voice". One use for this would be to turnoff speech recognition in noisy environments. Another would be to conserve speech recognition resources by turning them off where the input is always expected to be DTMF.

  • maxnbest

    This property controls the maximum size of the application.lastresult$ array; the array is constrained to be no larger than the value specified by maxnbest. This property has a minimum value of 1. The default value is 1.

  • universals

    Production-grade applications often need to define their own universal command grammars, e.g. to increase application portability or to provide a distinctive interface. They specify new universal command grammars with link elements. The default grammars can then be turned off with this property. Default catch handlers are not affected by this property. The value "none" is the default which means that all platform default universal command grammars are disabled. The value "all" turns them all on. Individual grammars are enabled by listing their names separated by spaces. For instance, "cancel exit help" is equivalent to "all".

Children

None.

Examples

In Example 3-52, the bargein property is set to true for the document. Once the interpreter is within the form, the property is set to false hence prohibiting the caller from barging in on "Welcome to the telephone banking system." The property is set again to true in the acctno field hence allowing the caller to barge in on "Please enter your account number now." When the interpreter reaches the filled element, the property value of the form now prevails so the caller can not barge in on "Thank you."

Example 3-52 Four bargein properties in four different variable scopes

<?xml version="1.0" encoding="iso-8859-1"?>
<vxml version="2.0">
  <property name="bargein" value="true"/>

  <form id="welcome">
    <property name="bargein" value="false"/>
    <initial> Welcome to the telephone banking system.</initial>
    <field name="acctno" type="digits">
      <property name="bargein" value="true"/>
      <prompt>Please enter your account number now.</prompt>
    </field>

    <filled>
      <prompt>Thank you.</prompt>
    </filled>
  </form>
</vxml>

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020