Plum Voice Platform Programmer's Reference Manual

Programmer's Reference Manual

Plum Voice Platform v. 2.6

© 2007 Plum Group, Inc. All rights reserved.

A. Appendix

A.1 <say-as> Tag Types
Please note that these tag types are case-sensitive. So "date:dmy" will work, but "Date:DMY" will not.

acronym
number
number:cardinal
number:ordinal
number:digits
date
date:dmy
date:mdy
date:ymd
date:ym
date:my
date:md
date:y
date:m
date:d
time
telephone
currency

See Section 6.2 of the Programmer's Reference Manual for more details of the <say-as> Tag Types that are supported by each engine.

A.2 Phoneme Set
The phoneme set is used with the <phoneme> tag to specify pronunciations to the AT&T Natural Voices and Cepstral Theta engines.

AT&T Natural Voices:

PHONEME	EXAMPLE	TRANSCRIPTION
aa	Bob	b aa b 1
ae	bat	b ae t 1
ah	but	b ah t 1
ao	bought	b ao t 1
aw	down	d aw n 1
ax	about	ax 0 b aw t 1
ay	bite	b ay t 1
b	bet	b eh t 1
ch	church	ch er ch 1
d	dig	d ih g
dh	that	dh ae t 1
dx	butter	b ah 1 dx er 0
eh	bet	b eh t 1
em	Chatham	ch ae 1 dx em 0
en	satin	s ae 1 q en 0
er	bird	b er d 1
ey	bait	b ey t 1
f	fog	f ao g 1
g	got	g aa t 1
hh	hot	h aa t 1
ih	bit	b ih t 1
iy	beat	b iy t 1
jh	jump	jh ah m p 1
k	cat	k ae t 1
l	lot	l aa t 1
m	Mom	m aa m 1
n	nod	n aa d 1
ng	sing	s ih ng 1
ow	boat	b ow t 1
oy	boy	b oy 1
p	pot	p aa t 1
q	button	b ah 1 q en 0
r	rat	r ae t 1
s	sit	s ih t
sh	shut	sh ah t 1
t	top	t aa p 1
th	thick	th ih k 1
uh	book	b uh k
uw	boot	b uw t 1
v	vat	v ae t 1
w	won	w ah n 1
y	you	y uw 1
z	zoo	z uw 1
zh	measure	m eh 1 zh er

0 Unstressed
1 Primary stress
2 Secondary stress
& Word boundary

Cepstral Engine:

PHONEME	EXAMPLE	TRANSCRIPTION
aa	father	f aa1 dh er0
ae	cat	k ae1 t
ah	about	ah0 b aw1 t
ao	bought	b ao1 t
aw	cow	k aw1
ay	buy	b ay1
b	book	b uh1 k
ch	catch	k eh1 ch
d	bad	b ae1 d
dh	then	dh eh1 n
eh	get	g eh1 t
er	earth	er1 th
ey	ate	ey1 t
f	fat	f ae1 t
g	good	g uh1 d
h	hello	h eh0 l ow1
i	sheep	sh i1 p
ih	ship	sh ih1 p
j	william	w ih1 l j ah0 m
jh	digit	d ih1 jh ih0 t
k	camera	k ae1 m r ah0
l	late	l ey1 t
m	man	m ae1 n
n	new	n uw1
ng	bang	b ae1 ng
ow	float	f l ow1 t
oy	boy	b oy1
p	camper	k ae1 m p er0
r	car	k aa1 r
s	sit	s ih1 t
sh	ship	sh ih1 p
t	tap	t ae1 p
th	thin	th ih1 n
uh	full	f uh1 l
uw	moon	m uw1 n
v	have	h ae1 v
w	water	w ao1 t er0
z	zero	z i0 r ow0
zh	vision	v ih1 zh ah0 n

0 Unstressed
1 Primary stress
2 Secondary stress
& Word boundary

A.3 Record and Recognition Termination Chart
Recording Timeout Behavior

	DTMFterm=true	DTMFterm=false
silence	stops after timeout seconds; returns <noinput>
speech followed by silence	stops finalsilence seconds after speech ends; returns recording
continuous speech	stops after maxtime seconds; returns recording
speech followed by any DTMF	stops immediately after DTMF input ends; DTMF input written to termchar; returns recording	stops finalsilence seconds after DTMF input ends; returns recording including DTMF tones
any DTMF	stops immediately after DTMF input ends; DTMF input written to termchar; returns a recording of dead air	stops finalsilence seconds after DTMF input ends; returns recording of DTMF tones

Speech recognition timeout behavior

	voice and DTMF	voice-only	DTMF-only
silence	stops after timeout seconds; returns <noinput>
speech followed by silence	stops after completetimeout seconds; returns speech input		stops after timeout seconds; returns <noinput>
continuous speech	stops after maxspeechtimeout seconds; returns speech input
speech followed by a DTMF-#	stops immediately after DTMF-#; returns speech input
speech followed by non-# DTMF	stops interdigittimeout seconds after DTMF input ends; returns DTMF input	stops after completetimeout seconds; returns DTMF tones as speech input	stops interdigittimeout seconds after DTMF input ends; returns DTMF input
speech followed by non-# DTMF followed by a DTMF-#	stops immediately after DTMF-#; returns DTMF input including #	stops immediately after DTMF-#; returns DTMF tones as speech input	stops immediately after DTMF-#; returns DTMF input including #
DTMF-#	stops immediately after DTMF-#, returns DTMF input including #	stops immediately after DTMF-#; returns DTMF tone as speech input	stops immediately after DTMF-#, returns DTMF input including #
non-# DTMF	stops interdigittimeout seconds after DTMF input ends; returns DTMF input	stops after completetimeout seconds; returns DTMF tones as speech input	stops interdigittimeout seconds after DTMF input ends; returns DTMF input
non-# DTMF followed by a DTMF-#	stops immediately after DTMF-#; returns DTMF input including #	stops immediately after DTMF-#; returns DTMF tones as speech input	stops immediately after DTMF-#; returns DTMF input including #

A.4 Tag Hierarchy
Core Tags

vxml (description )

%event.handler
form ( description )

%event.handler
data
filled
grammar
initial ( description )

%audio-output
%event.handler
link
prompt
property

link
record ( description )

%audio-output
%event.handler
filled
grammar
prompt
property

subdialog ( description )

%audio-output
%event.handler
filled
prompt
param ( description )
property

transfer ( description )

%audio-output
%event.handler
filled
grammar
prompt
property

block ( description )

%executable.content
data
foreach

field ( description )

%audio-output
%event.handler
filled
grammar
link

option (description )

option text

prompt
property

var
property
script

menu ( description )

%audio-output
choice ( description )

grammar

%event.handler
prompt
property

data
link
meta ( description )
metadata ( description )
var ( description )
property ( description )
script

Common Tags
data (description )
foreach (description )

link (description )

grammar

grammar (description )

grammar text
rule
meta
metadata
lexicon ( description )

script (description )

script text

filled (description )

%executable.content
data
foreach

prompt (description )

%all-output
foreach
lexicon ( description )
metadata

Event Handler Tags

%event.handler

catch (description )

%executable.content
data
foreach

help (description )

%executable.content
data
foreach

noinput (description )

%executable.content
data
foreach

nomatch (description )

%executable.content
data
foreach

error (description )

%executable.content
data
foreach

Executable Content Tags

%executable.content

%audio-output
assign ( description )
clear ( description )
disconnect ( description )
exit ( description )
goto ( description )
if ( description )

%executable.content
elseif ( description )
else ( description )
data
foreach

log ( description )

log text

prompt
reprompt ( description )
return ( description )
submit ( description )
throw ( description )
script
var

Output Tags

%all-output

%allowed-within-sentence
%structure

%audio-output

speech text
audio ( description )

%all-output
desc ( description )

enumerate ( description )

%all-output

value ( description )

%sentence-elements

break (description )
emphasis ( description )

%allowed-within-sentence

mark ( description )
phoneme ( description )

speech text

prosody ( description )

%all-output

say-as ( description )

speech text

value

sub ( description )

speech text

speak ( description )

%all-output

voice ( description )

%all-output

%structure

paragraph | p ( description )

%allowed-within-sentence
sentence | s

sentence | s ( description )

%allowed-within-sentence

%audio-output
%sentence-elements

Grammar Tags

rule ( description )

%rule-expansion
example ( description )

%rule-expansion

grammar text
token ( description )

token text

ruleref ( description )
one-of ( description )

item ( description )

%rule-expansion

tag ( description )

Legend

%italic blue	indicates a placeholder for any of a group of tags
normal	indicates a tag with no subelements
boldface	indicates a tag with subelements shown immediately below the boldfaced name of the tag
red	references a subelement common to several other tags

DTMF-only