VoiceXML Example

Speech Calculator

Download this example
Download all examples
Back to the examples page

calc.vxml

<?xml version="1.0" encoding="UTF-8"?>
<vxml version="2.0" xmlns="http://www.w3.org/2001/vxml">

<meta name="description" content="Calculator"/>
<meta name="author" content="Annu Paganus and Guillaume Quenel"/>
<meta name="copyright" content="free for non commercial purpose"/>

<!--
Speech Recognizer calculator


Annu Paganus - Guillaume Quenel
Abo Akademi University


Copyright (c) 2005


This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->

<!-- Variable for the result of the calculation. -->
<var name="result" />

<!-- Grammar for getting some case sensitive help. -->
<link event="help">
  <grammar root="main">
    <rule id="main" scope="public">
      <item repeat="0-1"> please </item>
      <item repeat="0-1"> I need </item>
      help
      <item repeat="0-1"> me </item>
      <item repeat="0-1"> please </item>
    </rule>
  </grammar>
</link>



<!-- The form that has fields number_a, operation and number_b.
     When all filled, it makes the wanted operation for ne numbers a and b. -->
<form id="start">

<!-- At the beginning user gets information and all fields are cleared.
     That is needed when starting the calculator again from the begin.-->
  <block>    Welcome to the calculator. Please say what you want to do.
        <clear namelist="number_a operation number_b"/>
      <assign name="mixed" expr="false"/>
  </block>
<!-- Variable that is used when the results are told to the user. -->
  <var name="summarization"/>

<!-- Global tag fields used in case not implemented in current field. -->
  <nomatch>
    <prompt> I didn't understand you. </prompt>
    <reprompt/>
  </nomatch>
  <nomatch count="3">
    <prompt> I didn't understand you again. This is your last chance. </prompt>
    <reprompt/>
  </nomatch>

  <!-- When four inputs are not understood the calcultor is turned off. -->
  <nomatch count="4">
    <prompt> Sorry, I didn't understand you again. I am giving up. Bye. </prompt>
    <exit/>
  </nomatch>

  <help>
    Sorry, no help is available.
  </help>

  <!-- If user doesn't give any inputs when asked one time, the calculator is turned off. -->
  <noinput cond="true" count="1">
    <prompt> Please say something, it is no time to sleep...! </prompt>
  </noinput>

  <noinput cond="true" count="2">
    <prompt> I have no time to play with you. Good Bye  </prompt> <exit/>
  </noinput>


  <grammar src="calc.grxml"/>

<!-- Initial field that is used to let the user give inputs in natural way.
     After two times not understanding the users input, calculator asks the inputs one by one. -->
  <initial name="mixed">
    <nomatch>
      I didn't understand you. Please specify one number, the operation and the second number.
    </nomatch>
    <nomatch count="2">
      Sorry, I still don't understand you. I will ask you for the information one piece at a time.
      <assign name="mixed" expr="true"/>
      <reprompt/>
    </nomatch>
    <help>
      You can specify one number, the operation and the second number.
    </help>
  </initial>


<!-- The first number to calculate. -->
  <field name="number_a" slot="calc.numa">
    What is the first number?
    <grammar src="calc.grxml#thenumber"/>
    <nomatch>
      I didn't understand you. Say a number
    </nomatch>
    <nomatch count="2">
      I didn't understand you.
    </nomatch>
    <help>
      Please say a number between one and ninety nine
    </help>
    <filled>
        <prompt> Number <value expr="number_a"/> </prompt>
    </filled>
  </field>

<!-- The operation wanted to do. -->
  <field name="operation" slot="calc.oper">
    What operation do you want to do?
    <grammar src="calc.grxml#operation"/>
    <nomatch>
      I didn't understand you. Please say what operation you want to compute.
    </nomatch>
    <nomatch count="2">
      I didn't understand you. Say plus, minus, divide or multiply.
    </nomatch>
    <help>
      Please say plus, minus, divide or multiply.
    </help>
    <filled>
        <prompt> operation <value expr="operation"/></prompt>
    </filled>
  </field>

<!-- The second number to calculate. -->
  <field name="number_b" slot="calc.numb">
    What is the second number?
    <grammar src="calc.grxml#thenumber"/>
    <nomatch>
      I didn't understand you. Say a number
    </nomatch>
    <nomatch count="2">
      I didn't understand you.
    </nomatch>
    <help>
      Please say a number between one and ninety nine
    </help>
    <filled>
        <prompt> number <value expr="number_b"/></prompt>
    </filled>
  </field>

  <block>

    <!-- Calculating the result. -->
    <if cond="operation=='divided' &amp;&amp; number_b == '0'">
        <prompt> I can't divide a number by zero, your operation is impossible </prompt>

    <elseif cond="operation=='divided' &amp;&amp; number_b != '0'"/>
        <assign name="result" expr="number_a / number_b" />

    <elseif cond="operation=='minus'" />
        <assign name="result" expr="number_a - number_b" />

    <elseif cond="operation=='multiply'" />
        <assign name="result" expr="number_a * number_b" />

    <elseif cond="operation=='plus'" />
        <!--  Number() here in order to avoid interpreting + as string concatenation! -->
        <assign name="result" expr="Number(number_a) + Number(number_b)" />

    </if>

    <!-- Calculating the result. -->
    <script> <![CDATA[
      summarization = number_a;
      summarization += ' ';
      summarization += operation;
      summarization += ' ';
      summarization += number_b;
      summarization += ' equals ';
      summarization += result;
    ]]> </script>


   <if cond="operation!='divided' || number_b != '0'">
     <prompt> You ask to compute <value expr="summarization"/>. </prompt>
   </if>

   <goto next="#is_correct"/>


  </block>

</form>


<!-- The form in which user is asked if he/she wants to continue calculating. -->
<form id="is_correct">
  <field name="yesno">

    <noinput> Calculator is about to exit. Good bye! <exit/> </noinput>
    <nomatch> I didn't understand you. Please say yes or no</nomatch>

    <prompt>Do you want to continue?</prompt>
    <grammar src="yesno.grxml"/>
    <filled>
      <if cond="yesno == 'yes'">
        <goto next="#start"/>
       <else/>
           <prompt>Thank you for using this calculator!</prompt>
         <exit />
      </if>
  </filled>
  </field>
</form>

</vxml>

back to the top

calc.grxml

<?xml version="1.0" encoding="UTF-8"?>
<grammar version="1.0" root="computation" xml:lang="en">

<meta name="description" content="grammar for calculator"/>
<meta name="author" content="Annu Paganus and Guillaume Quenel"/>
<meta name="copyright" content="free for non commercial purpose"/>

<!--
Speech Recognizer calculator


Annu Paganus - Guillaume Quenel
Abo Akademi University


Copyright (c) 2005


This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->


<!-- Rule for different combinations of polite starting expressions -->
<rule id="politness1">
  <item repeat="0-1"> please </item>
  <item repeat="0-1">I</item>
  <item repeat="0-">
      <ruleref uri="#what"/>
  </item>

  <item repeat="0-1">to</item>
  <item repeat="0-1">calculate</item>
</rule>

<!-- Rule for different ending expressions -->
<rule id="politness2">
  <item repeat="0-1">
    <one-of>
      <item> please </item>
      <item> thank you </item>
      <item> thanks </item>
      <item> is equal </item>
      <item> is equal to</item>
      <item> equals </item>
      <item> together </item>
    </one-of>
  </item>
</rule>


<!-- The root rule for mixed initiative situations -->
<rule id="computation" scope="public">
  <tag>out.calc = new Object;</tag>

  <ruleref uri="#politness1"/>
  <item repeat="1-">
  <one-of>
   <item>
         <item><!-- User is able to say only the first number -->
           <ruleref uri="#thenumber"/>
           <tag>out.calc.numa = meta.current().text;</tag>
         </item>
   </item>

   <item>

         <item><!-- User is able to say only the operation -->
           <one-of>
               <item><ruleref uri="#op_no_order"/></item>
               <item><ruleref uri="#op_in_order"/></item>
           </one-of>
           <tag>out.calc.oper = meta.current().text;</tag>
         </item>

   </item>


   <item>
      <item>
        <ruleref uri="#thenumber"/>
        <tag>out.calc.numa = meta.current().text;</tag>
      </item>
      <item>
        <one-of>
              <item><ruleref uri="#op_no_order"/></item>
              <item><ruleref uri="#op_in_order"/></item>
        </one-of>
        <tag>out.calc.oper = meta.current().text;</tag>
      </item>
      <item repeat="0-1">
        <ruleref uri="#thenumber"/>
        <tag>out.calc.numb = meta.current().text;</tag>
      </item>
   </item>

   <item>
      <item>
        <ruleref uri="#op_no_order"/>
        <tag>out.calc.oper = meta.current().text;</tag>
      </item>
      <item>
        <ruleref uri="#thenumber"/>
        <tag>out.calc.numa = meta.current().text;</tag>
      </item>
      <item>
        <ruleref uri="#combine"/>
      </item>
      <item>
        <ruleref uri="#thenumber"/>
        <tag>out.calc.numb = meta.current().text;</tag>
      </item>
   </item>

   <item>
         <item>
           <ruleref uri="#op_in_order"/>
           <tag>out.calc.oper = meta.current().text;</tag>
         </item>
         <item>
           <ruleref uri="#thenumber"/>
           <tag>out.calc.numb = meta.current().text;</tag>
         </item>
         <item> from </item>
         <item>
           <ruleref uri="#thenumber"/>
           <tag>out.calc.numa = meta.current().text;</tag>
         </item>
   </item>




  </one-of>
  </item>
  <ruleref uri="#politness2"/>
</rule>


  <!-- The rule for the numbers between 0 to 99 -->
  <rule id="thenumber" scope="public">
    <one-of>
      <item><ruleref uri="#ones" /><tag>out=Number(rules.ones);</tag></item> <!-- number is smaller than 10 -->
      <item><ruleref uri="#tens" /><tag>out=Number(rules.tens);</tag></item> <!-- # is one of tens -->
      <item><ruleref uri="#twos" /><tag>out=Number(rules.twos);</tag></item> <!-- 10 <= # < 20 -->
      <item><ruleref uri="#tens" /><tag>out=Number(rules.tens);</tag> <!-- number is for example 20 4 = 24 -->
            <ruleref uri="#ones" /><tag>out=Number(out)+Number(rules.ones);</tag>
      </item>

    </one-of>
  </rule>

  <rule id="ones">
    <one-of>
    <item>0</item>
    <item>zero<tag>out=0</tag></item>
    <item>1</item>
    <item>one<tag>out=1</tag></item>
    <item>2</item>
    <item>two<tag>out=2</tag></item>
    <item>3</item>
    <item>three<tag>out=3</tag></item>
    <item>4</item>
    <item>four<tag>out=4</tag></item>
    <item>5</item>
    <item>five<tag>out=5</tag></item>
    <item>6</item>
    <item>six<tag>out=6</tag></item>
    <item>7</item>
    <item>seven<tag>out=7</tag></item>
    <item>8</item>
    <item>eight<tag>out=8</tag></item>
    <item>9</item>
    <item>nine<tag>out=9</tag></item>
    </one-of>
  </rule>

  <rule id="twos">
    <one-of>
    <item>10</item>
    <item>ten<tag>out=10</tag></item>
    <item>11</item>
    <item>eleven<tag>out=11</tag></item>
    <item>12</item>
    <item>twelve<tag>out=12</tag></item>
    <item>13</item>
    <item>thirteen<tag>out=13</tag></item>
    <item>14</item>
    <item>fourteen<tag>out=17</tag></item>
    <item>15</item>
    <item>fifteen<tag>out=15</tag></item>
    <item>16</item>
    <item>sixteen<tag>out=16</tag></item>
    <item>17</item>
    <item>seventeen<tag>out=17</tag></item>
    <item>18</item>
    <item>eighteen<tag>out=18</tag></item>
    <item>19</item>
    <item>nineteen<tag>out=19</tag></item>
    </one-of>
  </rule>

  <rule id="tens">
    <one-of>
    <item>20</item>
    <item>twenty<tag>out=20</tag></item>
    <item>30</item>
    <item>thirty<tag>out=30</tag></item>
    <item>40</item>
    <item>fourty<tag>out=40</tag></item>
    <item>50</item>
    <item>fifty<tag>out=50</tag></item>
    <item>60</item>
    <item>sixty<tag>out=60</tag></item>
    <item>70</item>
    <item>seventy<tag>out=70</tag></item>
    <item>80</item>
    <item>eighty<tag>out=80</tag></item>
    <item>90</item>
    <item>ninety<tag>out=90</tag></item>
    </one-of>
  </rule>

<!-- The rule for getting the wanted operation from the user while the system is in system initiative state. -->
<rule id="operation" scope="public">
  <item repeat ="0-1">I</item>
  <item repeat ="0-1">want</item>
  <item repeat ="0-1">to</item>
  <one-of>
        <item><ruleref uri="#op_no_order"/></item>
        <item><ruleref uri="#op_in_order"/></item>
  </one-of>
  <tag> out = meta.current().text;</tag>
</rule>



<!-- Operations in which order doesn't really matter. -->
<rule id="op_no_order">
  <one-of>
      <item> plus </item>
      <item> add <tag>out="plus"</tag></item>
      <item> sum <tag>out="plus"</tag></item>

      <item> multiply </item>
      <item> times <tag>out="multiply"</tag></item>

      <item> divided </item>
      <item> divided by <tag>out="divided"</tag></item>
      <item> divide <tag>out="divided"</tag></item>
      <item> division <tag>out="divided"</tag></item>

      <item> result </item>
      <item> equals <tag>out="result"</tag></item>
  </one-of>

<!-- Operation minus in which the order matters in some case -->
</rule>
<rule id="op_in_order">
  <one-of>
     <item> minus </item>
     <item> subtract <tag>out="minus"</tag></item>

  </one-of>
</rule>

<!-- Rule for combining the numbers (Example: sum 4 [and] 6) -->
<rule id="combine">
   <one-of>
      <item>and</item>
      <item>with</item>
      <item>to</item>
      <item>by</item>
      <item>plus</item>
   </one-of>

</rule>

<!-- Compliments that are used in the beginning of the mixed initiative state. -->
<rule id="what">
<one-of>
        <item> want </item>
        <item> would like </item>
        <item> could you </item>
        <item> can you </item>
        <item> what is </item>
        <item> tell me </item>
        <item> say </item>
        <item> to know</item>
        <item> please </item>
</one-of>

</rule>
</grammar>

back to the top

yesno.grxml

<?xml version="1.0" encoding="UTF-8"?>
<grammar version="1.0" root="yesno" xml:lang="en" tag-format="semantics/1.0-literals">

<meta name="description" content="yes/no grammar"/>
<meta name="author" content="Annu Paganus and Guillaume Quenel"/>
<meta name="copyright" content="free for non commercial purpose"/>

<!--
Speech Recognizer calculator


Annu Paganus - Guillaume Quenel
Abo Akademi University


Copyright (c) 2005


This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<!-- The root rule -->
  <rule id="yesno" scope="public">
    <one-of>
      <item><ruleref uri="#yes"/><tag>yes</tag></item>
      <item><ruleref uri="#no"/><tag>no</tag></item>
    </one-of>
    <item repeat="0-1"><ruleref uri="#politness"/></item>
  </rule>

  <rule id="yes">
    <one-of>
      <item>yes</item>
      <item>yeah</item>
      <item>yep</item>
      <item>sure</item>
      <item>of course</item>
    </one-of>
  </rule>

  <rule id="no">
    <one-of>
      <item>no</item>
      <item>not</item>
      <item>nope</item>
    </one-of>
  </rule>

  <rule id="politness">
    <one-of>
      <item> please </item>
      <item> thanks </item>
      <item> thank you </item>
    </one-of>
  </rule>

</grammar>

back to the top

Secondary menu

Main menu

Navigation path

Speech Calculator