VXML开发接口说明(V1.0)rmd.doc

VoiceIE语音浏览系统ICP开发指南 用户手册目 录目 录第1章 VoiceXML标准概述1-11.1 简介1-21.2 概念说明1-21.2.1 VoiceXML与XML的关系1-21.2.2 执行的原则1-21.2.3 Dialog and Subdialog1-31.2.4 Session1-31.2.5 Application1-31.2.6 语法1-41.2.7 事件1-41.2.8 Link1-41.3 VoiceXML基本元素列表1-51.4 Document的结构和执行1-7第2章 VoiceXML标准基本元素功能及使用介绍2-12.1 Subdialog2-22.2 Form2-22.2.1 Form的解释2-22.2.2 Form Item2-32.2.3 Form Item的变量和条件2-42.2.4 引导型Form2-52.2.5 混合引导型Form2-72.2.6 Form的解释规则2-72.3 MENU2-102.4 LINK2-152.5 变量和表达式2-172.5.1 变量的声明2-172.5.2 变量的范围2-182.5.3 引用变量2-192.5.4 标准的session变量2-202.6 语法2-212.6.1 语音语法2-212.6.2 DTMF语法2-222.6.3 语法的范围2-232.6.4 语法的激活2-242.7 事件处理2-252.7.1 Throw2-252.7.2 Catch2-252.7.3 快捷元素2-262.7.4 catch元素的选择2-272.7.5 默认属性的catch元素2-272.7.6 事件类型2-282.8 资源的获取2-302.8.1 获取2-302.8.2 缓存2-312.9 元素2-332.9.1 基本的提示音格式2-332.9.2 语音标记2-332.9.3 音频提示2-352.9.4 元素2-362.9.5 打断功能2-372.9.6 选择放音功能2-372.9.7 Timeout属性2-392.10 FORM ITEM2-402.11 元素2-422.12 元素2-442.13 元素2-462.14 PARAM2-512.15 可执行内容2-542.15.1 元素2-542.15.2 元素2-542.15.3 元素2-552.15.4 元素2-552.15.5 元素2-562.15.6 元素2-562.15.7 元素2-582.15.8 元素2-592.15.9 元素2-602.15.10 元素2-612.15.11 元素2-622.15.12 元素2-622.16 时间的指定2-66第3章 语法3-13.1 语音语法3-23.1.1 引言3-23.1.2 定义语法3-73.1.3 语法编译3-143.1.4 自然语言理解3-213.2 DTMF语法3-30第4章 VoiceIE系统与ICP业务接口说明4-14.1 VoiceIE语音浏览系统结构4-24.2 VoiceIE系统对VoiceXML标准支持的说明4-44.2.1 VoiceIE系统对VoiceXML标准的支持4-44.2.2 VoiceIE系统扩展VoiceXML标准OBJECT使用说明4-84.3 计费接口说明4-204.3.1 按点击次数计费4-204.3.2 按流量计费4-214.3.3 按内容计费4-234.3.4 计费接口补充说明4-244.4 鉴权接口说明4-264.5 其他说明4-274.5.1 语音文件格式要求4-274.5.2 版本说明4-27附录 缩略语及专用术语表A-1iiiVoiceIE语音浏览系统ICP开发指南 用户手册第4章 VoiceIE系统与ICP业务接口说明第1章 VoiceXML标准概述本章目标l 介绍VoiceXML及相关的一些概念。l 介绍VoiceXML的一些基本元素。l 描述VoiceXML Document的执行规则。1.1 简介VoiceXML（Voice eXtensible Markup Language，语音扩展标识语言）为合成语音，数字音频，语音识别和DTMF（Dual Tone Multi-frequency，双音多频收号器）键输入，语音纪录、电话、多方会议等提供音频交互手段。它的主要目标是将基于WEB的开发内容移植到IVR（Interactive Voice Response，交互式声音应答）应用中。1.2 概念说明1.2.1 VoiceXML与XML的关系XML（eXtensible Markup Language，可扩展标记语言）和HTML（Hypertext Markup Language，超文本链接标识语言）都是由SGML（Standard Generalized Markup Language，标准通用标记语言）派生而来的。HTML是SGML的一个实例，而XML则是SGML的一个子集；VoiceXML是XML的一个实例。l XML是一个可无限扩展的标记语言，是用来设计各种各样的标记语言的准则，即通常所说的“元语言”Meta-Language（即可产生其它语言的语言）。l VoiceXML是XML在语音方面的一个实例。l VoiceXML标准必须先遵循XML规范（有关XML规范请参看相关资料，本手册不予说明）。1.2.2 执行的原则一个VoiceXML document（文档）或同一个application（应用）中的一系列document形成一个交互式的有限状态自动机。用户任何时刻只能处于一个会话状态，即处于某一个dialog。 每个dialog决定下一个跃迁到的dialog，跃迁时指定将使用到的URI（Uniform Resource Indicator，统一资源指示），即指出了下面使用那个document和dialog；如果该URI没有指定下一个document，则假定为当前document；如果没有指定下一个dialog，则假定为document中的第一个dialog。如果当前运行完的dialog没有指定下一个跳转的目标，或者其中出现明确要求退出的元素，则终止当前的交互。1.2.3 Dialog and Subdialog1. dialogdialog（对话）有以下两类：l form表示信息的收集输入。定义了一个交互接口，通过收集输入信息为一系列field item域项变量赋值。其中每个field可以指定一个语法，用以定义该field允许的输入信息。如果存在form级别的语法，则它可以对会话内的field起作用。l menu提出下一步作什么样的选择。向用户提交一系列可选项，并且下一步的跃迁将基于用户的选择。2. Subdialogsubdialog（子对话），类似函数调用，它提供了调用一个新的交互的机制，并返回到原来的form。返回时保存内部数据、所用语法以及状态信息，以供在调用该subdialog的document中使用。例如可在下列场合使用subdialog：l 创建一个要求访问数据库的验证片断。l 创建一个在一个应用中被多个文档共用的元件。l 创建一个在多个应用中可重用的对话库（library of dialogs）。1.2.4 Session一个session的活动周期为：l 开始于：当用户开始和一个VoiceXML解释器上下文（interpreter context）交互时。l 继续于：当获取和处理document 时。l 结束于：当用户、document、或者解释器上下文要求结束时。1.2.5 Application一个application 由一系列共享同一个root document（根文档）的document构成。在一个application内，不管用户是通过某一个document进行交互，还是从一个document转换到另一个document，root document总是处于加载状态，此时root document的变量作为application的变量，可以被同一application内的document所使用，并且它的语法在整个application内都是保持激活状态。只有在用户切换到本application之外的document时，root document才会被卸载。1.2.6 语法每一个dialog联系着一个或多个语音语法、DTMF语法，在机器引导（machine directed）的application中，每个dialog的语法只有在用户使用该dialog时，才处于激活状态；在 混合引导（mixed initiative）的application 中，用户和机器交互控制下一步做什么；某些dialog会保持其语法为激活状态（例如监听），即使用户转换到同一document中的另一个dialog或同一application的另一个已加载的document，在这种情况下，如果输入的用户语言匹配了另一个dialog的激活语法，执行将转移到该dialog，用户的语言将被当作对此dialog的操作。 混合引导的application增加了语音应用的灵活性与处理能力。1.2.7 事件对于各种的情况，由平台抛出事件（event），如：用户没用响应，请求帮助。当VoiceXML文档有语义错误时，解释器也会抛出事件。事件由catch元素或由它的快捷形式捕捉；一个事件能产生的每个元素都可指定catch元素。此外catch元素还可以附加元素“as if by copy”来继承。这样，在任何层次都可以指定共有事件的处理方式，并且这适用于所有较低层。1.2.8 Linklink支持混合引导。如果用户进入link的范围，link指定的语法就处于激活状态，一旦用户输入匹配了link的语法，控制就转移到link的目标URI。link可以被用来抛出事件以跳转到指定的URI目的地 。1.3 VoiceXML基本元素列表元素 功能给一个变量赋值在一个提示中放音频片段可执行代码的容器（container），这些代码不是交互代码在输出中增加暂停的JSML元素捕捉一个事件清除一个或多个form 变量定义一个菜单项目退出一个session把一些text定义为特殊类的JSML元素定义一个按键文法在一个菜单中枚举选择的缩写抓获一个错误事件退出一个document 或者application元素中使用 元素中使用 改变语音输出重音的JSML元素 提交信息和收集数据的dialog 定义一个form中的field field被填充完毕后要执行的动作 到同一个或另外一个文件的其它dialog 定义一个语音识别的语法 捕捉一个help事件 简单的条件逻辑 在form的入口定义初始化逻辑 为link中的所有dialog定义一个转移 定义一个选择菜单 捕捉一个no match事件 捕捉一个no input事件 为域指定一个option 在一个特定的范围内作用（例如、讲话对象） 和中的参数 向用户输出音频文件语音和TTS（Text-To-Speech，文本到语音的转化）语音 控制实现平台参数的设置 改变语音输出的重音和语调模式的JSML元素 记录一个音频采样 当再次访问一个field，请求播放提示音 从subdialog中返回 修改怎样拼写一个词或短语的JSML元素 指定一块ECMAscript客户端的脚本逻辑 调用另一个dialog，作为当前dialog的subdialog 将值提交给文档服务器 抛出一个事件 把呼叫转移到另外一个目的地 在提示中插入变量值 声明变量 每个VoiceXML文件的最高层元素1.4 Document的结构和执行一个VoiceXML document由高层的元素dialog组成。有两种类型的dialog：form和menu。一个document也可以有、等元素。1. 单个document内的执行缺省是从第一个dialog开始执行。当前执行的dialog决定下一个要执行的dialog。当所执行的dialog没有指定下一个dialog时，就结束运行。2. 含多个document的application的执行通常application是在独立的document内进行的。当需要在一个application里使用多个document时，应选一个document作为root document，并且在其他document的元素里引用它。如图1-1所示。图1-1 含多个document的application的执行application中的root document一直驻留在内存中。通常，可以见到下面的两种情况：l application中的root document（或者一个独立的document）已加载，用户在执行它。l application中的root document和其他的document被加载，用户在执行非root document。在含多个document的application中，root document的变量和语法可以共享，这样在整个application中用户都可以与共同的（即root document中的）form、link，还有menu进行交互。值得注意的是在含多个document的application中，最多只能有两个document可以同时被加载，一个是正在执行的document，另一个是root document。如果一个document引用了不存在的root document，或者某个application的root document引用了另外一个application的root document，就会引发语义错误事件。4-27第2章 VoiceXML标准基本元素功能及使用介绍本章目标l 简单翻译介绍VoiceXML1.00标准中一些基本元素的功能及应用。2.1 Subdialog使用subdialog可以减小dialog的复杂序列，改善程序的结构，或者用于生成一个可重用的组件。调用subdialog时增加了新的上下文。被调用的可以是当前document中一个dialog，也可以是另外的document 中的dialog。一个subdialog的调用与其语法的有效范围相关。2.2 Form它是VoiceXML document的关键元件。可以包含：(1) 一组form item。 form item又分为field item和control item。其中：l field item定义field item的变量，FIA（Form Interpretation Algorithm，form的解释算法）主循环里要访问的元素。l control item帮助控制field的收集信息。(2) 声明non-field item变量。(3) 事件处理器（event handlers）。(4) 过程逻辑块。form的属性：l Id标识form的名称 。l Scopeform语法的默认范围。如果默认范围是dialog，则form语法的默认范围仅在form内激活；如果默认范围是document，form语法的默认范围在同一document内的任一dialog内激活；如果默认范围是document，并且该document是root document，则form语法在该application的任一document的内的任一dialog内激活；如果一个form的语法标明了scope为dialog，则它仅在该form内激活。2.2.1 Form的解释form由内含的FIA解释。FIA循环重复地选择一个form item，然后访问它，这个被选的form item是第一个警戒条件不满足的form item。例如，form item的默认警戒条件检验该form item的变量是否被赋值，这样对于仅有field item的简单form，用户将被提示依次处理各field item。解释一个form item 通常包括以下步骤：l 选择并播放一段或多段提示音。l 收集用户输入，或者填充一个或多个field，或者抛出各种事件（如帮助事件）。l 解释field中最近填充的动作。在遇到控制状态转移时，如转换到其他dialog或者document的，或向服务器提交数据的，FIA将结束。当遇到暗含的结束标志，如没有合法的form item，FIA也将结束。2.2.2 Form Item一个form的form item是指可以被FIA的主循环访问到的元素（element），form item指引FIA收集特定的field，FIA选择到的一个控制item，可能包含一段需要运行的程序代码，或者它将告诉FIA为一个混合引导型form提供初始化了的提示放音集。1. Field Item一个field item 指定了一个field item变量，它的值从用户那里收集。field item带有提示音，以告诉用户说什么或者按什么键，以及定义允许输入内容的语法和处理任何结果事件的处理器。field item也可能带有一个元素，它定义field item变量赋值后应该做的动作。field item可以细分为：l 通过ASR（Automatic Speech Recognition，自动语音识别）或者DTMF语法来赋值的field item。l 内容为一段音频剪辑的field item，例如一个元素可以收集语音邮件。l 该field item将用户的电话转接到另一个电话上。有两种类型，一种将用户转过去以后，流程就结束；另一种，将用户转过去以后，等待其结束，然后返回控制，这时field变量的值将被设置成结束的状态，如：busy noanswer；network_busy；Near_end_disconnect；far_end_disconnect ；network_disconnect 。l 该field item调用一个带有各种变量的平台指定的对象（其返回值是带有一个或多个属性的ECMAScript对象）。平台指定的对象可以是一个用来收集信用卡信息的内嵌的对话，也可以是使用某些专用的DTMF文本输入法收集的文本信息。& 说明： (1) 元素支持调用一个带有各种变量的平台指定的对象，但并不要求应用必需提供平台指定的对象。(2) ECMAScript，A standard version of JavaScript backed by the European Computer Manufacturers Association，欧洲计算机制造商协会所支持的一个JavaScript的标准版本。(3) JavaScript，Java描述语言。l 大体上就象函数调用，它调用在当前页的对话，或者调用另一个VoiceXML文档，结束时返回一个ECMAScript对象。2. Control Item有两种类型的control item：l 一系列的程序化的声明，用来提示和计算，但是不收集输入。block通常有一个隐含的form item，它在被解释前设为true。l 它用在混合引导型form里控制初始的交互。它提示用户，使输入可以匹配form级的语法。当识别的结果使至少一个field item的变量被赋值时，的form item变量变为true，然后将它作为一个可选项移交给FIA。2.2.3 Form Item的变量和条件每个form item都对应一个form item变量，当开始解释一个form时，其中的form item变量都默认为未定义的。form item变量将保存解释form item的结果。每个field item也都对应一个field item变量，它将保存从用户那里收集来的变量值。form item变量可以用name属性起名字。也可以不用名字，这时会产生一个内部的名字。每个form item都有一个警戒条件，它决定该form item在执行FIA算法时是否被访问。默认的警戒条件只是判断该form item变量是否有值，如果已经有值了，在对该dialog执行FIA算法时，该form item就不会被访问（执行）。典型情况是，field item有名字而control item没有。通常form item变量没有初始值，也不指定附加的警戒条件。在form中可以先将某个form item初始化赋值，将它隐藏起来，以后再清空它的值，使它被选中执行。另外，field可以在其他field被赋值而它本身没有被赋值时，将警戒条件激活。block内容只有在其条件为true时才会执行，这样就可以控制FIA选择和执行了，从而实现良好的控制。不过实际上，大多数的dialog并没有采用这样复杂的控制。简单的说，所有的form item都有下列的属性：l Name对话范围内的form item变量的名字。l Exprform item变量的初始值，默认值是ECMAScript标准中的undefined。如果有了初始值，该form item将不会被FIA选中执行，除非它的值被清空。l Cond一个表达式，用在检测form item变量时进行评价。如果没有此项，缺省认为是true，或者在中，用来检查是否有form item变量被赋值。2.2.4 引导型Form最简单也是最常见的form类型是在应用中 form item被按照次序一次执行的计算机引导型的交互（a computer-directed interaction）。 Welcome to the weather information service . What state? Please speak the state for which you want the weather. What city? Please speak the state for which you want the weather. 对话将如下进行：C (computer): Welcome to the weathere information service . What state?H (human): helpC: Please speak the state for which you want the weather ？H: GeorgiaC: what city？H: TblisiC: did not understand what you said。what city？H: MaconC: The condition in Macon georgia are sunny and .field构成form的主要成分，一个field声明了一个变量，指定了提示音、识别的语法、DTMF声明、帮助信息以及其他的事件处理器。每个field 在form的对话范围内（in the forms dialog scope）声明了一个VoiceXML field item变量。一旦在form中有用户的输入，这些变量被提交，或是拷贝到其它的变量中。每个field都有自己的语音语法或DTMF语法，或者两者都有，这是由和元素明确指定的，或者用type属性暗含的。type属性是用来指定内嵌的标准语法，如数字，布尔量等。type属性也指明了语音合成器怎样来读field的值。每个field可以拥有一个或多个提示音。如果只有一个，它将在用户没有输入时不断重复的提示。如果有几个，则必须给出count属性，它将决定每次播放哪个提示音。元素定义了用户请求帮助时应该如何处理。帮助信息也可以是渐变内容，即每次播放的内容可以不同。可以使用略写形式，下面的两个元素是相等的： Please say visa, mastercard, or amex. Please say visa, mastercard, or amex.元素定义了前面field被执行赋值后做什么事情，它的一种用处是再次完整地检查语法或其他内容。2.2.5 混合引导型Form混合引导型form是指由计算机和用户共同来决定谈话，它必须有一个或多个 form item，且必须有一个或多个form级语法（form-level grammar）。如果有了form 级语法就会出现：l field可以以任意次序执行（不一定按前后排列次序）。l 用户的一次谈话可能会引起多于一个的field被执行。并且，可以激活不是当前dialog的form语法。如果document中有两个form，比如说一个是car rental form，另一个是hotel reservation form，并且两个form的语法在整个文档内都激活，则用户在被提示输入关于hotel reservation form内的信息时，输入关于car rental form内的信息，这样将引导计算机进行关于car rental form内的对话。用户可以输入任何被激活语法可以识别的内容，并且相关field的赋值流程也会相应执行。可以有若干种办法（个性化）定制FIA。l 一种办法是给form item变量赋值，这样该form item 就不会被FIA选中执行，同样，可以清空form item变量的值，这样就引导FIA重新访问该form item。l 另一种办法是用明确的指定下一个将要访问的field item，这将立即转换到该field item，如果在中出现，剩余的 动作以及未决的 动作将被忽略。2.2.6 Form的解释规则下面将讨论FIA的实现细节。1. 初始化阶段当进入一个form时，它将被初始化。内部提示计数器变量（在form的对话范围内）被设置为1，每个变量（form级的元素和form item 变量）被初始化：按照document内的次序，被置为未定义undefined，或是相对应的表达式属性。2. 主循环FIA的主循环有三个阶段：l 选择阶段选择下一个访问的form item。l 收集阶段访问下一个需要用户输入的form item。此item提示用户输入，激活相应的语法并且等待和收集用户的输入（语音输入或是DTMF输入）或是事件（例如帮助请求或是输入超时事件）。l 处理阶段处理输入的内容，执行form item并运行元素，完成诸如输入合法性检查等。由适当的事件处理器处理抛出的事件。 注意：如果控制流程是从别的form的FIA转换过来的，FIA已经有了收集到的输入，这种情况下，FIA主循环的的第一次执行将跳过选择和收集阶段，直接用提供的输入进入处理阶段。(1) 选择阶段其目标是选择下一个访问的form item。它的执行规则如下：如果上一个主循环的处理阶段指定了一个，则所指定的form item被选中，否则，第一个警戒条件为false的form item被选中。如果没有警戒条件为false的form item，则FIA将执行隐含的操作。(2) 收集阶段其目的是收集输入或事件。被选中的form item被访问，所执行的动作由form item的类型决定：l 如果访问的是field item，FIA将被访问field item的所有提示音，按其标明的次数以及放音条件进行排队和选择。然后监听field级的语法和所有激活的高级语法，并等待语法匹配或者某些事件。l 如果访问的是，FIA将被访问的所有提示音，按其标明的次数以及放音条件进行排队和选择。然后监听form级的语法和所有激活的高级语法，并等待语法匹配或者某些事件。l 如果访问的是，通过设置它的form item变量为true，评估它的内容，然后跳过处理阶段。不收集任何输入，并且执行完以后进入下一次的FIA主循环。(3) 处理阶段其目标是处理在收集阶段收集的输入或事件。如下所述：l 如果事件（如没有输入或用户挂机）发生，对应的catch元素将进行识别和处理，这可能造成FIA结束（如跳转到另外的dialog或者document，或者执行），或者FIA进入下一轮的主循环（如执行默认的帮助事件处理器）。l 如果输入内容匹配了的语法，则将执行的跳转，或产生相关事件。如果产生一个事件，该事件将由当前上下文中的form item处理。l 如果输入内容匹配了别的form 的语法，则FIA将结束，别的form将初始化，它的FIA将用该输入内容从执行处理阶段开始执行。l 如果输入内容匹配了本form 的语法，则：输入内容的语法匹配值将被赋给相应的field item变量；中的动作将被一些指定的任务触发；每个中确定的动作将按文档中的次序执行。如果遇到或，剩余的中的动作将不再执行，并且FIA结束，或者FIA进入下一轮的主循环。完成处理阶段后，FIA又回到选择阶段。2.3 MENUmenu是一种便捷的语法快捷形式，它用于在form中提供一个单独的匿名field，以提示用户进行选择并根据选择转换到不同的地方。类似于正常的form，它有自己的语法范围，即用户执行别的dialog而依然保持激活的范围。下面的menu向用户提供了三种选择： Welcome home. Say one of: Sports Weather Stargazer astrophysics news Please say one of 对话将如下进行：C: Welcome home. say one of: sports; weather; Stargazer astrophysics news.H: Astrology.C: I did not understand what you said. (a platform-specific default message.)C: Welcome home. say one of: sports; weather; Stargazer astrophysics news.H: sports.C: (proceeds to http:/www.sports.example/vxml/start.vxml）1. 元素它用于标识menu ，并决定语法的范围。menu的属性如下：l Id用于标识menu，它可以使menu成为或的目标。l Scopemenu的语法范围。如果它是dialog（默认的），则menu的语法仅在用户进入到该menu后才激活。如果范围是document，则menu的语法在整个document中都是激活的，如果该menu是在application的root document中，则其语法范围是整个application。l Dtmf如果其设置为true，任何没有明确指定DTMF元素的选项被缺省的依次指定为暗含的“1”，“2”等。2. 元素元素用于以下几种目的：l 用于指定一个语音语法片断，或一个DTMF语法片断，或其组合，以用于决定用户的选择。l 用于构成一列提示串。l 它指定选项被选中后将要跳转的目标URI。choice 的属性如下所示：l Dtmf用于选择的DTMF次序 。l Next下一个dialog或document的URI。l Event指定抛出一个事件而不是指定一个next。l Expr指定一个expression用于评估，而不是指定一个next 。l Caching 参见2.8.1节。l Fetchaudio参见2.8.1节。l Fetchhint参见2.8.1节。l Fetchtimeout参见2.8.1节。3. menu中的DTMFmenu可以只使用语音，或DTMF，也可以通过包含元素来使用两者的结合。下面是一个仅用DTMF的例子，它用每个选项的dtmf属性明确指定了各自的DTMF次序： For sports press 1, For weather press 2, For Stargazer astrophysics press 3. 也可以设置menu的dtmf属性为true，以对前9个选项依次指定DTMF数字，第一个选项被指定为“1”，其余类推。 For sports press 1, For weather press 2, For Stargazer astrophysics press 3. 这样menu的提示将为：C: Welcome home. For sports, press 1. For weather, press 2. For Stargazer astrophysics news,press 3.在的提示中可以类似的运用元素，以自制一系列可选项。4. 语法的产生任何一个选择短语都指定了一系列被监听的词和短语。用户可以任意讲所被监听的词和短语中的子集，它们要按先前出现的次序排列。选择短语是从直接或间接包含在中的元素中的PCDATA构造的。例如，根据提示：“stargazer astrophysics news”，用户可以说“stargazer”，“astrophysics”，“stargazer news”，“astrophysics news”等，对应的JSGF（Java Speech Grammar Format ，Java语音语法格式） 语法将是：“Stargazer astrophysics news”（表示可选项）。& 说明：PCDATA与CDATA的区别：PCDATA是真正意义上的