Quick Start

note

In this quick start, the Python Wheel is assumed to be installed and available within your environment.

The run.sh script in the package tcan be used for end to end testing and report generation.

1. Install
2. Download the Sample App --> 16khz_quickstart_travel.zip
3. Follow the steps

Package Contents

.
├── audio
│   ├── 1-1.wav
│   ├── 1-10.wav
│   ├── 1-11.wav
│   ├── 1-12.wav
│   ├── 1-13.wav
│   ├── 1-14.wav
│   ├── 1-15.wav
│   ├── 1-16.wav
│   ├── 1-17.wav
│   ├── 1-18.wav
│   ├── 1-19.wav
│   ├── 1-2.wav
│   ├── 1-20.wav
│   ├── 1-3.wav
│   ├── 1-4.wav
│   ├── 1-5.wav
│   ├── 1-6.wav
│   ├── 1-7.wav
│   ├── 1-8.wav
│   ├── 1-9.wav
│   └── 2-1.wav
├── config.json
├── mappings.adjmap
├── output
├── quickstart_travel.trsx
├── run.sh
└── truth.tsv

2 directories, 26 files

Steps

See Mix Learn for recordings showing how to get started with the Nuance Mix Travel QuickStart Project.

Step 1. Create a Mix Project

• Go to https://mix.nuance.com
• Create a project (Quick Start)
• Import quickstart_travel.trsx

Step 2. Build

• Build ASR and NLU models

Step 3. Create and Deploy App Config

• Go to the Mix Dashboard
• Navigate to "Applications"
• Create a Configuration, Deploy it
• Generate a client secret (if you don't have one) and copy it along with the client ID
• Copy the tag (will be used in the respective service's URN)

Step 4. Update Test Tool Config

See below, update config.json

• credentials - client_id and client_secret
• asr->dlm_uri - resource tag
• nlu->model_uri - resource tag

Step 5. Install the Tool

• Install the Python wheel

Step 6. Run Test

• ./run.sh

---

QuickStart Travel Sample Test

The sample below is using

• eng-USA as the language
• GEN language topic
• ASR (with DLM) and
• NLU (using ASR results)

Configuration

Aspect	Comments
Services	Production ASR and NLU, *.api.nuance.com
Log Level	Informational
Description	ASR object with DLM
Language	English US - en-US, also eng-USA
ASR	Test with GEN topic, auto punctuate, apply 1 DLM with 0.7 weight; no wordsets
NLU	Test with using result from ASR

config.json

{
	"description": "QuickStart TestSet 1: NLU with ASR",
	"log_level": "INFO",
    "language": "eng-USA",
	"urls": {
		"oauth": "https://auth.crt.nuance.com/oauth2/token",
		"asr": "asr.api.nuance.com:443",
		"nlu": "nlu.api.nuance.com:443"
	},
	"credentials": {
		"oauth_scopes": "asr nlu",
		"client_id": "appID:_____REPLACEME_____",
		"client_secret": "_____REPLACEME_____"
	},
	"asr": {
		"topic": "GEN",
		"auto_punctuate": true,
		"dlm_uri": "urn:nuance-mix:tag:model/_____REPLACEME_____/mix.asr?=language=eng-USA",
		"dlm_weight": 0.7,
		"wordset_path": null,
        "retry_count": 2,
        "retry_sleep_s": 5
	},
	"nlu": {
		"use_asr_results": true,
		"model_uri": "urn:nuance-mix:tag:model/_____REPLACEME_____/mix.nlu?=language=eng-USA",
        "retry_count": 2,
        "retry_sleep_s": 5
	}
}

Truth File

truth.tsv

speaker codedWvnm   transcription   annotation  intent
1   1-1.wav Book a flight to Atlanta    {"eArrivalCity": "Atlanta"}     iBookFlight
1   1-2.wav I'd like to go to Atlanta on May 4th    {"eArrivalCity": "Atlanta", "eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_DAY": 4, "nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_MONTH": 5}} iBookFlight
1   1-3.wav Is there a flight from New York to Phoenix? {"eDepartureCity": "New York City", "eArrivalCity": "Phoenix"}  iBookFlight
1   1-4.wav Can I fly to San Francisco? {"eArrivalCity": "San Francisco"}   iBookFlight
1   1-5.wav I'm going to New York tomorrow  {"eArrivalCity": "New York City", "eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_STEP": "day", "nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_INCREMENT": 1}}  iBookFlight
1   1-6.wav Did I lose my luggage in New York?  {}  iFAQLostLuggage
1   1-7.wav Where's my luggage? {}  iFAQLostLuggage
1   1-8.wav I'd like to travel from Phoenix to Atlanta on July 20th {"eArrivalCity": "Atlanta", "eDepartureCity": "Phoenix", "eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_MONTH": 7, "nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_DAY": 20}}   iBookFlight
1   1-9.wav Yeah, is my flight on time? {}  iFlightStatus
1   1-10.wav    When is my flight?  {}  iFlightStatus
1   1-11.wav    What's my itinerary?    {}  iFlightStatus
1   1-12.wav    What is my flight status?   {}  iFlightStatus
1   1-13.wav    What's a good restaurant in New York?   {}  NO_INTENT
1   1-14.wav    To New York {"eArrivalCity": "New York City"}   NO_INTENT
1   1-15.wav    From Phoenix    {"eDepartureCity": "Phoenix"}   NO_INTENT
1   1-16.wav    Tomorrow    {"nuance_CALENDARX": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_STEP": "day", "nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_INCREMENT": 1}} NO_INTENT
1   1-17.wav    No actually I want to leave from Atlanta    {"eDepartureCity": "Atlanta"}   NO_INTENT
1   1-18.wav    Change the destination from New York to Atlanta {"eDepartureCity": "New York City", "eArrivalCity": "Atlanta"}  NO_INTENT
1   1-19.wav    Make it on August 5th   {"eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_MONTH": 8, "nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_DAY": 5}}    NO_INTENT
1   1-20.wav    Can I go from Montreal to Phoenix on May 1st?   {"eArrivalCity": "Phoenix", "eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_DAY": 1, "nuance_CALENDAR.nuance_DATE.nuance_DATE_ABS.nuance_MONTH": 5}} iBookFlight
2   2-1.wav Book a flight from New York to Atlanta for tomorrow {"eArrivalCity": "Atlanta", "eDepartureCity": "New York City", "eDepartureDate": {"nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_STEP": "day", "nuance_CALENDAR.nuance_DATE.nuance_DATE_REL.nuance_INCREMENT": 1}} iBookFlight

Audio

In the linked sample package, 16kHz, Mono, 16-bit Linear PCM files are present.

Adjudication Map

mappings.adjmap

#
# General
#

s/^/ /ig;
s/$/ /ig;

s/ en / & /ig;
s/ and / & /ig;
s/ och / & /ig;

s/,/ /ig;
s/’/'/ig;
s/\-/ /ig;
s/，/ /ig;

s/ \$PI / PI /ig;
s/ \$PIs / PI /ig;

s/œ/oe/ig;
s/é/e/ig;
s/É/E/ig;
s/í/i/ig;
s/ S.A. / SA /ig;

# put spaces at boundaries of ASCII text and Asian text
s/([a-zA-Z0-9\-]+)(?=[一-鿿])/$1 /ig;
s/(?<=[一-鿿])([a-zA-Z0-9\-]+)/ $1 /ig;

s/\^20/ /g; # san^20fran --> san fran
s/\\\S+//g; # i\pronoun --> i

s/^ +//g;
s/ +$//g;

#
# Domain specific
#

Mix Project TRSX

mix-quickstart-projects/en-US.trsx at main · nuance-communications/mix-quickstart-projects (github.com)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project xmlns:nuance="https://developer.nuance.com/mix/nlu/trsx" xml:lang="eng-USA" nuance:version="2.5" nuance:enginePackVersion="hosted">
    <sources>
        <source name="nuance_custom_data" displayName="nuance_custom_data" version="1.0" type="CUSTOM" useForOOV="true"/>
    </sources>
    <ontology base="http://developer.nuance.com/resources/ontology-1.0.xml">
        <intents>
            <intent name="iAllDone"/>
            <intent name="iFAQLostLuggage"/>
            <intent name="iBookFlight">
                <links>
                    <link conceptref="eDepartureDate"/>
                    <link conceptref="eArrivalCity"/>
                    <link conceptref="eDepartureCity"/>
                    <link conceptref="eCity"/>
                </links>
            </intent>
            <intent name="iFlightStatus"/>
        </intents>
        <concepts>
            <concept name="eDepartureCity">
                <relations>
                    <relation type="isA" conceptref="eCity"/>
                </relations>
            </concept>
            <concept name="eArrivalCity">
                <relations>
                    <relation type="isA" conceptref="eCity"/>
                </relations>
            </concept>
            <concept name="eDepartureDate">
                <relations>
                    <relation type="isA" conceptref="DATE"/>
                </relations>
            </concept>
            <concept name="eGlobalCommands"/>
            <concept name="eConfirmFlightLookup">
                <relations>
                    <relation type="isA" conceptref="YES_NO"/>
                </relations>
            </concept>
            <concept name="eConfirmFlight">
                <relations>
                    <relation type="isA" conceptref="YES_NO"/>
                </relations>
            </concept>
            <concept name="eBookFlight"/>
            <concept name="eCity"/>
        </concepts>
    </ontology>
    <dictionaries>
        <dictionary conceptref="eGlobalCommands">
            <entry literal="agent" value="escalate"/>
            <entry literal="book a flight" value="book flight"/>
            <entry literal="cities" value="cities"/>
            <entry literal="escalate" value="escalate"/>
            <entry literal="flight status" value="flight status"/>
            <entry literal="give me options" value="options"/>
            <entry literal="human agent" value="escalate"/>
            <entry literal="list all the cities" value="cities"/>
            <entry literal="list the cities" value="cities"/>
            <entry literal="lost luggage" value="lost luggage"/>
            <entry literal="main menu" value="main menu"/>
            <entry literal="menu options" value="options"/>
            <entry literal="operator" value="escalate"/>
            <entry literal="options" value="options"/>
            <entry literal="speak to a representative" value="escalate"/>
            <entry literal="speak to someone" value="escalate"/>
            <entry literal="what are my options" value="options"/>
            <entry literal="what are the cities" value="cities"/>
            <entry literal="what are the options" value="options"/>
            <entry literal="what things can i say" value="options"/>
        </dictionary>
        <dictionary conceptref="eCity">
            <entry literal="Atlanta" value="Atlanta"/>
            <entry literal="Cleveland" value="Cleveland"/>
            <entry literal="JFK" value="New York City"/>
            <entry literal="LGA" value="New York City"/>
            <entry literal="New York" value="New York City"/>
            <entry literal="New York City" value="New York City"/>
            <entry literal="Phoenix" value="Phoenix"/>
            <entry literal="San Fran" value="San Francisco"/>
            <entry literal="San Francisco" value="San Francisco"/>
        </dictionary>
    </dictionaries>
    <samples>
        <sample intentref="NO_INTENT" count="1" excluded="false" fullyVerified="true">all the<annotation conceptref="eGlobalCommands">cities</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="1" excluded="false" fullyVerified="true">
            <annotation conceptref="eCity">San Francisco</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="1" excluded="false" fullyVerified="true">
            <annotation conceptref="eCity">JFK</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="1" excluded="false" fullyVerified="false">i would like to</sample>
        <sample intentref="NO_INTENT" count="1" excluded="false" fullyVerified="false">i'd like to</sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="false">need to book a flight</sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="false">book a flight</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">that's all</sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">actually from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">Tokyo</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">book a flight leaving from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">atlanta</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">buy tickets to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">san francisco</annotation>
            </annotation>
        </sample>
        <sample intentref="iFAQLostLuggage" count="2" excluded="false" fullyVerified="false">i can't find my luggage</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">i'm done</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">no all done</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">no thanks i'm good</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nope i'm done</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nothing else , i'm done</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nothing else , thanks</sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">book a flight to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">new york city</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">book a flight to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">san francisco</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">schedule a flight from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">cleveland</annotation>
            </annotation>to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">new york</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">book a flight to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">chicago</annotation>
            </annotation>from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">la guardia</annotation>
            </annotation>on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">January 24th</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iFlightStatus" count="2" excluded="false" fullyVerified="false">check the status of my flight</sample>
        <sample intentref="iFlightStatus" count="2" excluded="false" fullyVerified="false">flight status</sample>
        <sample intentref="iFlightStatus" count="2" excluded="false" fullyVerified="false">is my flight on time</sample>
        <sample intentref="iFlightStatus" count="2" excluded="false" fullyVerified="false">is my flight delayed</sample>
        <sample intentref="iFAQLostLuggage" count="2" excluded="false" fullyVerified="false">where's my suitcase</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">I'm done</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nope</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">that's it</sample>
        <sample intentref="iBookFlight" count="10" excluded="false" fullyVerified="true">book a flight from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">new york city</annotation>
            </annotation>to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">cleveland</annotation>
            </annotation>on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">january 2nd</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">
            <annotation conceptref="eGlobalCommands">representative</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">
            <annotation conceptref="eGlobalCommands">customer service representative</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">
            <annotation conceptref="eGlobalCommands">options</annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">need to schedule a flight from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">phoenix</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">i need to go to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">cleveland</annotation>
            </annotation>on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">monday</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">is there a flight from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">atlanta</annotation>
            </annotation>to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">phoenix</annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">actually I want to go to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">New York</annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="true">i want to fly to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">new york</annotation>
            </annotation>
            <annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">tomorrow</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">thursday</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iFAQLostLuggage" count="2" excluded="false" fullyVerified="false">lost luggage</sample>
        <sample intentref="iFAQLostLuggage" count="2" excluded="false" fullyVerified="false">where's my luggage</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">that's all thank you</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">i'm all set thanks</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nothing goodbye</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">nothing else thanks i'm good</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">that's all for now</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">don't need any more help</sample>
        <sample intentref="iAllDone" count="2" excluded="false" fullyVerified="false">goodbye</sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">
            <annotation conceptref="eGlobalCommands">what are my options</annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">actually to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">Seattle</annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">actually i'm leaving from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">atlanta</annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">no i'm leaving from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">atlanta</annotation>
            </annotation>
        </sample>
        <sample intentref="NO_INTENT" count="2" excluded="false" fullyVerified="true">actually i'm leaving on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">friday</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iFlightStatus" count="2" excluded="false" fullyVerified="false">what's the status of my flight</sample>
        <sample intentref="iFAQLostLuggage" count="2" excluded="false" fullyVerified="false">i lost my luggage</sample>
        <sample intentref="iFAQLostLuggage" count="4" excluded="false" fullyVerified="false">my luggage didn't arrive</sample>
        <sample intentref="NO_INTENT" count="20" excluded="false" fullyVerified="true">on<annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">december 21st</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="1" excluded="false" fullyVerified="true">book a flight to<annotation conceptref="eArrivalCity">
                <annotation conceptref="eCity">New York</annotation>
            </annotation>from<annotation conceptref="eDepartureCity">
                <annotation conceptref="eCity">Cleveland</annotation>
            </annotation>
            <annotation conceptref="eDepartureDate">
                <annotation conceptref="DATE">
                    <annotation conceptref="nuance_CALENDARX">tomorrow</annotation>
                </annotation>
            </annotation>
        </sample>
        <sample intentref="iBookFlight" count="2" excluded="false" fullyVerified="false">booking a flight</sample>
    </samples>
</project>