Product Support Notice

Transcription

1 PSN # PSN002343u Product Support Notice 2009 Avaya Inc. All Rights Reserved. Original publication date: 28-Jul-09. This is Issue #01, published date: 28- Severity/risk level Medium Urgency When convenient Jul-09. Name of problem Notes for TAS applications using MRCP with Nuance R9. Products affected Interactive Response (IR) 3.0/4.0. Problem description No documentation is available for using Request/Reply commands for TAS applications using MRCP with Nuance R9. Resolution The following document Request/Reply commands are sent before or after a recognition job, but not during the actual recognition of audio. There are two general categories of commands, grammar management and ASR parameter setup. Request/Reply Following are special request/reply commands sent by the Avaya IR to connected ASR engines. Request commands are case sensitive. Grammar names are limited to 64 characters and may not contain any whitespace characters. All request commands and reply results are expect to be in UTF-8 Unicode. 1. Results The reply returned after processing any of these requests with the exception of GET_RESULT_MEAN should be one of the following strings. The quote marks are not returned, only the quoted content. 2. Success A successful operation returns: "[status: success]" 3. Error An error return should be composed of the following string with the "%d" replaced by the error code. "[error: %d]" 4. Unknown If the request is not supported or is an unknown command then return: "[error: unknown request]" Following are the different return codes and there meaning for speech proxy: 6000 : PROXY_ASR_START 6001 : PROXY_ASR_PROMPTEND 6002 : PROXY_ASR_STOP 6003 : PROXY_ASR_ABORT 6004 : PROXY_ASR_TALKOFF 6008 : PROXY_ALLOC 6009 : PROXY_RELEASE 6010 : PROXY_ASR_COMP 6011 : PROXY_ASR_TIMEOUT 6012 : PROXY_ASR_ERROR 6013 : PROXY_ASR_DATA 6014 : PROXY_ASR_ENDPOINT 6015 : PROXY_BINARY_REPLY 6016 : SB_PROXY_REQUEST 6017 : VW_PROXY_REQUEST 6018 : PROXY_REPLY 6019 : PROXY_ALLOC_STAT 6020 : PROXY_BINARY_REQUEST 6021 : PROXY_DCFILEPATH_REQUEST 6022 : PROXY_DCREMOVE_REQUEST 6023 : PROXY_DATA_COLLECT 6024 : CALL_STATUS

2 Grammar Load Load the specified text as a grammar. The specified grammar name is generated by the VXML Interpreter and will be used for future activate, deactivate, and unload commands. <grammar name> Unique name for this grammar <grammar text> Complete text of the grammar to load GRAM_LOAD_TXT <grammar name> <grammar text> Grammar Load URI Load the specified URI as a grammar. The specified grammar name is generated by the VXML Interpreter and will be used for future activate, deactivate, and unload commands. <grammar name> Unique name for this grammar <grammar URI> URI pointing to the grammar to load GRAM_LOAD_URI <grammar name> <grammar uri> Grammar Activate Activate the specified grammar. This grammar should be added to the list of active grammars for all the following recognitions. The grammar remains active until deactivated or unloaded. The weight parameter is optional. <grammar name> Previously loaded grammar to activate <weight> Floating point weight of this grammar, weight is > 0.0 GRAM_ACT <grammar name> <weight> Grammar Deactivate Deactivate the specified grammar. This grammar should be removed from the list of active grammars for all the following recognitions. <grammar name> Previously loaded, activated grammar to deactivate GRAM_DEACT <grammar name> Grammar Unload Unload the specified grammar. The grammar should be deactivated and removed from the internal list of valid grammars. The grammar name is no longer valid after this call. <grammar name> Previously loaded grammar to unload. GRAM_UNLOAD <grammar name> Result Grammar Name Return the name of the grammar that produced the most recent recognition result. GET_RESULT_GRAM 2009 Avaya Inc. All Rights Reserved. Page 2

3 Result Meaning Return the meaning of the Nth recognition result of n-best recognition results. N-best index is 1 based. When the Nth n-best index is more than what the speech recognition has to return, then there is no semantic meaning for that request, and [status: reject] will be returned. If there is no Nth n-best index in the request, the proxy will return the semantic meaning of the first result of the N-Best Result. The return string has the following format: <meaning string>;[utts]= <value> :<score> There are two form of <meaning string>. The first form is the semantic meaning. For example, if the recognition result was "one thousand" the semantic meaning for built-in number would be "1000". If there is no associated semantic meaning then the meaning string is empty. The second form of grammar meaning supports key/value pair evaluation. This allows ASR engines to communicate VXML key/value results. To pass back a key value result uses the following format:?<key1>= <value1> :<score1>;<key2>= <value2> :<score2>; [UTTS]= <value> :<score> provides the utterance and its confidence level for the Nth best recognition result. <value> is the utterance for Nth best recognition result, while <score> is the confidence level for that utterance. GET_RESULT_MEAN < Nth n-best index > Set VXI Parameter Set the specified parameter to the specified value. Following is the list of valid parameters: confidencelevel sensitivity speedvsaccuracy completetimeout incompletetimeout maxspeechtimeout maxnbest savewaveform recognitionmode <parameter name> Name of the ASR parameter to set. <parameter value> Value of the parameter. VXI_SET_PARAM <parameter name> <parameter value> The timeout values for completetimeout, incompletetimeout, and maxspeechtimeout are measured in milliseconds. The valid range for confidencelevel, sensitivity, and speedvsaccuracy is from 0 to 1.0. If the parameter value is set to -1, then this value is not set on the speech server. However, the default value available on the speech server comes into effect. You can either use a MrcpSetParam (Available for IR 4.0 with IVRD 6.1 only) external function once or the LreqPROXY external function nine times for each of the MRCP parameters. For IR 4.0 Avaya recommends you to use MrcpSetParam external function as using LreqPROXY external function nine times can be a time-consuming task Avaya Inc. All Rights Reserved. Page 3

4 CAUTION: Do not use the MrcpSetParam external function and the RequestPROXY external function in the same application. The application does not compile correctly and generates the multiple define error message. Set ASR language Set the speech language parameter "SET_SPEECH_LANGUAGE" to the ASR speech language name such as "en-us" code for US English language. This command can be used before every "GRAM_LOAD_TXT" and "GRAM_LOAD_URI" commands. <language_name> ASR language to be used for example en-us code for US English language. SET_SPEECH_LANGUAGE <language_name> The following example shows how to use Nuance R9 s Open Speech in IVRD application: Start: 1. Answer Phone 2. Set Field Value Field: Engine = "OPSR4" Field: ActD1 = "GRAM_ACT D1" Field: SetLang1 = "SET_SPEECH_LANGUAGE en-us" 3. External Function Function Name: concat Use Arguments: LoadD1 "GRAM_LOAD_URI D1 builtin:" "grammar/digits?length=1" 0 4. External Function Function Name: allocproxy Use Arguments: Engine 5. Announce Speak With Interrupt Text: "Welcome to TTS and ASR test for Speech Works " 6. Announce Speak With Interrupt Text: "Choose one of the following options " Text: "Say one for option one " Text: "Say two for option two " 7. External Function Function Name: requestproxy Use Arguments: Engine SetLang1 8. External Function Function Name: requestproxy Use Arguments: Engine LoadD1 9. External Function Function Name: requestproxy Use Arguments: Engine ActD1 10. Prompt & Collect Input Max Number Of Digits: 01 RECOG: SR SWASR Checklist Case: "Input Ok" Continue Case: "Initial Timeout" Reprompt Case: "Too Few Digits" Reprompt Case: "No More Tries" Quit 2009 Avaya Inc. All Rights Reserved. Page 4

5 End Prompt & Collect 11. Announce Speak With Interrupt Text: "Thank you for choosing an option" 12. External Function Function Name: deallocproxy Use Arguments: Engine 13. Quit The following are some notes about this example program: The value of the argument to requestproxyfor the engine should always be "OPSR4" (The variable name Engine is defined by the application writer) The LoadD1, ActD1 and SetLang1 field names are only examples actual field names may vary. The grammar must be allocated see allocproxy (Step 4). The ASR speech language must be set see first requestproxy (Step 7). The grammar must be loaded see second requestproxy (Step 8). The LoadD1 argument (Set in step 3) must start with GRAM_LOAD_URI <grammar_name> <grammar_uri> <grammar_name> in this case can be anything but must be consistent with <grammar_name> used in later grammar activate step (Step 8) <grammar_uri> should be as described in Nuance documentation what is in this example is one of many possibilities The grammar must be activated see third requestproxy (Step 9). The ActD1 argument (set in step 2) must start with GRAM_ACT <grammar_name> The SetLang1 argument (set in step 2) must start with SET_SPEECH_LANGUAGE <language_name> In the prompt&collect the grammar_name (SWASR in step 10) must match a stub grammar that was created as described in the stub grammar section earlier in this document. Here are the few things you will have to consider: 1. The grammars might need to be ported to SRGS (.grxml) from the old.gsl ones that might have been used until now. Grxml files will need to be used as a URL, not inline. 2. If you intend to set "vxi parameters" like confidencelevel / sensitivity / etc, you will have to set a new one called "recognitionmode" IN THE END and set its value as "speech". 3. Before loading each grammar, you will need to load the language for that grammar, if it is different from the default (That is "en-us" in vs/sproxy/cfg/mrcp.cfg). 4. If you have been setting vendor, specific properties through TAS until now, you will have to map them to those that can be used in MRCP. Workaround or alternative remediation Remarks Patch Notes The information in this section concerns the patch, if any, recommended in the Resolution above. Backup before applying the patch Download Patch install instructions Verification Failure Service-interrupting? No 2009 Avaya Inc. All Rights Reserved. Page 5

6 Patch uninstall instructions Security Notes The information in this section concerns the security risk, if any, represented by the topic of this PSN. Security risks Avaya Security Vulnerability Classification Not Susceptible Mitigation For additional support, contact your Authorized Service Provider. Depending on your coverage entitlements, additional support may incur charges. Support is provided per your warranty or service contract terms unless otherwise specified. Avaya Support Contact Telephone U.S. Remote Technical Services Enterprise U.S. Remote Technical Services Small Medium Enterprise U.S. Remote Technical Services BusinessPartners for Enterprise Product BusinessPartners for Small Medium Product Please contact your distributor. Canada Caribbean and Latin America Europe, Middle East, and Africa Asia Pacific Disclaimer: ALL INFORMATION IS BELIEVED TO BE CORRECT AT THE TIME OF PUBLICATION AND IS PROVIDED AS IS. AVAYA INC., ON BEHALF OF ITSELF AND ITS SUBSIDIARIES AND AFFILIATES (HEREINAFTER COLLECTIVELY REFERRED TO AS AVAYA ), DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND FURTHERMORE, AVAYA MAKES NO REPRESENTATIONS OR WARRANTIES THAT THE STEPS RECOMMENDED WILL ELIMINATE SECURITY OR VIRUS THREATS TO CUSTOMERS SYSTEMS. IN NO EVENT SHALL AVAYA BE LIABLE FOR ANY DAMAGES WHATSOEVER ARISING OUT OF OR IN CONNECTION WITH THE INFORMATION OR RECOMMENDED ACTIONS PROVIDED HEREIN, INCLUDING DIRECT, INDIRECT, CONSEQUENTIAL DAMAGES, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF AVAYA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE INFORMATION PROVIDED HERE DOES NOT AFFECT THE SUPPORT AGREEMENTS IN PLACE FOR AVAYA PRODUCTS. SUPPORT FOR AVAYA PRODUCTS CONTINUES TO BE EXECUTED AS PER EXISTING AGREEMENTS WITH AVAYA. All trademarks identified by or TM are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners Avaya Inc. All Rights Reserved. Page 6