Robotics & Artificial Intelligence Tools 2003 (Professional Edition)

home *** CD-ROM | disk | FTP | other *** search

/ Robotics & Artificial Int…3 (Professional Edition) / Robotics & Artificial Intelligence Tools 2003 (Professional Edition).iso / voice recognition / vssdkinstall_launcher.exe / readme.txt < prev next >

Wrap

Text File | 2002-06-13 | 27.5 KB | 749 lines

IBM(R) WebSphere(R) Voice Server for Windows(R) 2000 Software Developers Kit (SDK) Version 2.1 README CONTENTS 1.0 ABOUT THIS README FILE 2.0 WHAT'S NEW IN THIS RELEASE 3.0 HARDWARE REQUIREMENTS 4.0 SOFTWARE REQUIREMENTS 5.0 FEATURES 6.0 INSTALLATION 7.0 CONSIDERATIONS FOR JAPANESE LANGUAGE VERSIONS 8.0 CONFIGURATION 9.0 RUNNING THE SAMPLES 10.0 RUNNING YOUR OWN VOICEXML APPLICATIONS 11.0 KNOWN PROBLEMS AND FIXES 12.0 UNINSTALLATION 13.0 USING THE TTSCLEAN, VIACLEAN, AND VSCLEAN UTILITIES 14.0 NOTICES AND TRADEMARKS 15.0 THIRD-PARTY LICENSES 1.0 ABOUT THIS README FILE This README provides information on installing the IBM WebSphere Voice Server Software Developers Kit Release 2.1. After installation, refer to the "IBM WebSphere Voice Server Software Developers Kit (SDK) VoiceXML Programmer's Guide" for information on using this software. Hereafter, the IBM WebSphere Voice Server Software Developers Kit is referred to as the "IBM WebSphere Voice Server SDK." The Programmer's Guide is delivered in both Portable Document Format (PDF), viewable with the Adobe Acrobat Reader 5.0 or later, and HTML format, viewable with a Web browser. The Adobe Acrobat Reader is included on the Voice Server installation CD. We recommend that you print the VoiceXML Programmer's Guide for reference. 2.0 WHAT'S NEW IN THIS RELEASE This release of the IBM WebSphere Voice Server SDK includes the following enhancements: o Function to support the generation of pronunciations in French, German, Spanish, and UK English with the WebSphere Voice Toolkit v2.0. o Bug fixes for the speech-recognition engine. o Minor corrections and improvements to the VoiceXML Programmer's Guide. 3.0 HARDWARE REQUIREMENTS A computer equipped with: o Intel(R) Pentium(R) 366 MHz processor or equivalent o CD-ROM drive, if installing the SDK from a CD o 128 MB RAM o 250 MB disk space (minimum): o 30 MB for installing the Sun(TM) Java(TM) Runtime Environment (Sun JRE) 1.3.1 o 40 MB in the Windows system directory o 130 MB in the installation directory for installing each language selected o 28 MB in the installation destination directory for caching, logging, and tracing NOTE: If you are downloading the SDK from a Web site, the installation packages (9 total) require an additional 58 MB to 171 MB of free space during download, plus 62 MB to 172 MB of free space for extracting the files that are created when executing the download packages. The range varies depending on the language package(s) downloaded. o 28 MB for the main download installation package (required) o Approximately 50 MB for each language file (Available languages are: French, German, Italian, Japanese, Simplified Chinese, Spanish, UK English and US English.) After you have installed the SDK product, you can remove the download package(s) and the extracted installation program files. You must download at least one language package along with the main installation package. o A display adapter setting of greater than 256 colors o A Microsoft(TM) Windows 2000 compatible 16-bit full-duplex sound card (with a microphone input jack) with good recording quality o A good quality microphone NOTES: 1. The Voice Server SDK has not been exhaustively tested with all possible audio device drivers. We recommend that you use a sound card and a microphone from the lists that have been tested for compatibility with IBM ViaVoice(TM) Millennium. To view these lists, visit: http://www-3.ibm.com/software/speech/support/ At that Web site, click the language of your choice, then any ViaVoice release, then "Tested Systems, Sound Cards/Chip Sets & Microphones". 2. There is a known problem with the interaction between the Java Media Framework (JMF) and certain audio device drivers, such as the Crystal SoundFusion or the Creative Labs SoundBlaster Live! adapter. For a fix to this problem, please read the Release Notes at: http://www.ibm.com/software/webservers/voiceserver/support.html 4.0 SOFTWARE REQUIREMENTS o Microsoft Windows 2000 Professional or Server SP2. o Networking (for example TCP/IP) must be enabled. o Sun Java Runtime Environment (Sun JRE) 1.3.1 (included in this package, but must be installed before the IBM WebSphere Voice Server SDK software). o Adobe Acrobat Reader version 5.0 (included in this package) or later. o HTTP 1.1 client, if desired. NOTE: If you have another IBM WebSphere Voice Server product or any IBM ViaVoice product installed on your system, you must uninstall it before installing this package. 5.0 FEATURES The IBM WebSphere Voice Server SDK includes a VoiceXML speech browser, speech recognizer, speech synthesizer, sample applications, and other tools for developing and testing VoiceXML applications. Features of the IBM WebSphere Voice Server SDK include: o Support for VoiceXML 1.0 plus IBM extensions, as documented in the VoiceXML Programmer's Guide. o Speech or simulated DTMF (telephone key press) input. o Synthesized speech (text-to-speech) or prerecorded audio-file output. o Six audio types for prerecorded audio files. o Support for the following languages: French, German, Italian, Japanese, Simplified Chinese, Spanish, UK English, and US English. o "Barge-in," enabling application users to interrupt audio prompts by speaking. o Grammar-based speech recognition, including support for dynamically generated grammars. o Directed dialog support with form filling. o Support for "mixed initiative dialogs," which enable application users to include multiple requests in a single utterance. 6.0 INSTALLATION 6.1 Prerequisites o You must have administrator access to install the IBM WebSphere Voice Server SDK. o The Installation Wizard requires that your display adapter be set to at least 256 colors. Otherwise, the Installation Wizard may generate an exception and abort. o The IBM WebSphere Voice Server SDK uses customized versions of the IBM ViaVoice Speech Recognition and Text-To-Speech engines; therefore, if you have any IBM ViaVoice product installed on your system, you must uninstall it before installing this package. NOTE: If you encounter any problems uninstalling these products completely, you should run the ViaClean utility, as explained in section 13.0 USING THE TTSCLEAN, VIACLEAN, AND VSCLEAN UTILITIES. o If you have an earlier release of the IBM WebSphere VoiceServer SDK, you must uninstall it before installing Release 2.1. NOTE: If you encounter any problems, you should run the ViaClean and VSClean utilities, as explained in section 13.0 USING THE TTSCLEAN, VIACLEAN AND VSCLEAN UTILITIES. o Once you have installed Release 2.1 of the IBM WebSphere Voice Server SDK on your system, you can rerun the installation at a later time to install additional languages. 6.2 Installing the JRE The IBM WebSphere Voice Server SDK requires the Sun JRE version 1.3.1. If you do not already have this JRE installed on your system, you must install it before installing the SDK. To install the Sun JRE, run the ..\install\jre131\j2re-1_3_1-win-i.exe file. If you are installing the SDK from a CD-ROM, this path is relative to the root directory of the CD-ROM. If you downloaded the SDK from a Web site, this path is relative to the directory where you unpacked the installation package. 6.3 Installing the SDK 1. To launch the IBM WebSphere Voice Server SDK Installation Wizard, run the setup.exe file. o If you are installing the SDK from a CD-ROM, this file is located in the root directory of the CD-ROM. o If you downloaded the SDK from a Web site, this file is located in the directory where you unpacked the installation package. 2. Follow the instructions in the Installation Wizard to install the SDK. You may install one or more of the supported language versions. NOTES: 1. You must install the SDK on a local hard drive. You cannot install to a local floppy, or to a ZIP drive, CD-ROM, or remote drive. 2. Should a message be displayed during the installation process and the message is not completely visible, enlarge the dialog window by clicking and dragging one of the four corners until the entire message is visible. 3. The name of the folder where you install the SDK cannot contain any accented characters (for example, Θ, τ, and ⁿ). The default destination directory is: <windrive>:\Program Files\VoiceServerSDK The installation destination directory is saved in the environment variable IBMVS: IBMVS=installation-directory NOTE: This environment variable must not be changed by any user or program. If you choose to specify a different directory, the following restrictions apply: o The destination path should not include non-alphanumeric characters (for example, ~!@#$%^&*) or non-ASCII characters. You can only use ASCII, alphanumeric characters, and space. o The destination path should not be more than 5 directory levels. For example: <windrive>:\Program Files\two\three\four\VoiceServerSDK The Installation Wizard copies files to the following directory structure: <installation-directory>\ bin - executable files docs - user documentation jmf20 - Java Media Framework 2.0 lib - Jar files, DLLs license - license files samples\<locale> - sample VoiceXML applications and associated documentation, where <locale> is: de_DE for German en_GB for UK English en_US for US English es_ES for Spanish fr_FR for French it_IT for Italian ja_JP for Japanese zh_CN for Simplified Chinese ViaVoice - IBM ViaVoice Speech Recognition files ViaVoiceOutloud - IBM ViaVoice Text-To-Speech files uninstall - files needed for the uninstallation program The installation program creates a program folder where you can launch the following shortcuts: o Audio Sample - French o Audio Sample - German o Audio Sample - UK English o Audio Sample - US English o Audio Sample - Italian o Audio Sample - Spanish o Audio Sample - Simplified Chinese o Audio Sample - Japanese o Audio Sample - French o Audio Sample - German o Audio Sample - UK English o Audio Sample - US English o Audio Sample - Italian o Audio Sample - Spanish o Audio Sample - Simplified Chinese o Audio Sample - Japanese o VoiceXML Programmer's Guide (requires Acrobat Reader 5.0) o Readme o VoiceXML Version 1.0 Specification To access this folder from the Windows Start menu, choose Programs -> IBM WebSphere Voice Server SDK. NOTE: You will not be able to launch shortcuts for languages that you have not installed. 6.4 Installing the Adobe Acrobat Reader To view or print the Programmer's Guide, you must use the Adobe Acrobat Reader version 5.0 or later. To install Adobe Acrobat Reader, run the file: ..\install\Adobe\rp500enu.exe NOTES: 1. If you are installing the SDK from a CD-ROM, this path is relative to the root directory of the CD-ROM. 2. If you downloaded the SDK from a Web site, this path is relative to the directory where you unpacked the installation package. 6.5 Installing multiple languages During the installation of a second or subsequent language, the Installation Wizard might want to install a Voice Server file that already exists on your computer. The Wizard will then display a message asking if you want to replace the file. Should this occur, click Yes to allow the Wizard to replace the file. 7.0 CONSIDERATIONS FOR JAPANESE LANGUAGE VERSIONS Please make a note of the following restrictions when installing IBM WebSphere Voice Server for Japanese: o Voice Server for Japanese is supported only on the Japanese language version of Windows 2000. o Multiple language installations are not supported. 8.0 CONFIGURATION To complete the installation, you must reboot your system. After rebooting, you must run the Audio Setup program to configure your microphone and speakers for use with this product. From the Windows Start menu, choose Programs -> IBM WebSphere Voice Server SDK, and then select the Audio Setup program for the desired language. 9.0 RUNNING THE SAMPLES This package includes a number of sample VoiceXML applications, located in subdirectories of <installation-directory>\samples\<locale>, where <locale> is: o de_DE for German o en_GB for UK English o en_US for US English o es_ES for Spanish o fr_FR for French o it_IT for Italian o ja_JP for Japanese o zh_CN for Simplified Chinese After installing and configuring this package, you should run the Audio Sample to verify that your audio input and output devices are working properly. You can run the Audio Sample from the Windows Start menu by choosing Programs -> IBM WebSphere Voice Server SDK -> Audio Sample, and then select the Audio Sample program for the desired language. To run the other samples, refer to their respective documentation. NOTE: The GrammarBuilder sample requires that you have a version of the IBM DB2(R) Universal Database(TM) in the same language because the database and table names are different for some language versions of DB2. For example, the US English GrammarBuilder sample will fail if you try to use it to access the French EXAMPLE database, because it is expecting the US English database called SAMPLE. You can download a fully-functional trial version of DB2 in the desired language from: http://www.ibm.com/software/data/db2/udb/downloads.html 10.0 RUNNING YOUR OWN VOICEXML APPLICATIONS The VoiceXML Programmer's Guide contains detailed information on creating and running your own VoiceXML applications. The VoiceXML Programmer's Guide is available in the directory <installation-directory>\docs. You can access it from the Windows Start menu by choosing Programs -> IBM WebSphere Voice Server SDK -> Programmer's Guide. 10.1 Using the Command Line Interface To start the VoiceXML browser, use the following command: %IBMVS%\bin\batchfile URL where: "batchfile" is one of the following: vsaudio_<locale> - When the VoiceXML application runs, the VoiceXML browser generates spoken output (using text-to-speech and/or recorded audio) and accepts spoken input and simulated DTMF input entered using the DTMF Simulator included in the IBM WebSphere Voice Server SDK. vstext_<locale> - When the VoiceXML application runs, the VoiceXML browser writes prompts and other output as text in the Java console window, and accepts input from your keyboard or the DTMF Simulator. If desired, you can provide input from a file by specifying a <inputfile parameter. This mode is useful for automated testing purposes or if a microphone is not available on your system. NOTE: <locale> is one of: de_DE for German en_GB for UK English en_US for US English es_ES for Spanish fr_FR for French it_IT for Italian ja_JP for Japanese zh_CN for Simplified Chinese "URL" is the initial URL for your VoiceXML application. 10.2 Using IBM WebSphere Studio IBM WebSphere Studio is a Web development team environment for organizing and managing Web projects. IBM WebSphere Studio version 3.5 has been enhanced to support VoiceXML files. If you are developing your applications using IBM WebSphere Studio version 4.0, you can start the VoiceXML browser by right-clicking on a .vxml file in any Studio view and then selecting Preview with -> WebSphere Voice Server. Studio is preconfigured to execute the first VoiceXML browser installed. For example, if you installed the US English and UK English language versions of the SDK, studio launches the batch file vsaudio_en_US.bat (US English batch file), which invokes the VoiceXML browser and passes it a URL that refers to the selected file. To execute the VoiceXML browser in another language, you must first export (back up) and then edit the setting in the system registry. 1. Click Start -> Run, then type "regedit" in the entry field and click OK. 2. From the menu, click Registry, then click Export Registry File. 3. Save the registry file with a name and in a location you'll remember easily should you need to import it later. 4. Search for the key name: My Computer\HKEY_LOCALE_MACHINE\SOFTWARE\IBM\Websphere Voice Server SDK. 5. Change the value of the sub key "previewer" to point to the desired file, for example vsaudio_en_GB.bat. For more information on using the VoiceXML browser with IBM WebSphere Studio, refer to the IBM WebSphere Studio documentation. 11.0 KNOWN PROBLEMS AND FIXES o Users of Virtual Private Network (VPN) software, such as Aventail Connect(R), may experience a "Failure to create recognizer for local: En_US" when attempting to use the VoiceXML browser, the audio setup (SMART.EXE), or the utility program SETDEF.EXE. To circumvent this problem, either ensure that your VPN software is up and running (i.e. you are connected), or uninstall the VPN software. o Users of software firewall solutions, such as Symantec Desktop Firewall(R) may experience an "SmConnect rc = -3" error when attempting to use the VoiceXML browser. This occurs when the desktop firewall software inhibits communication between the VoiceXML browser and the speech recognition engine. As a workaround, please disable the personal firewall software before running the VoiceXML browser. o Following an uninstallation, the "Add/Remove Programs" window may no longer accept window focus. Please reboot your computer and follow the uninstallation program's instructions to fix this problem. o Non-Latin letters (e.g. DBCS characters) in grammar rule names for form-level grammars are not supported. The ECMAScript action tag mechanism assigns the portion of the result covered by rule <x> to an ECMAScript variable $x, so the characters used in <x> must be legal characters for an ECMAScript variable name. Therefore, DBCS characters are not supported. o You may experience slow barge-in response intermittently while using the SDK. o When using the browser-internal phone grammar with the Italian SDK, numbers containing "settantanove" (79) will not be recognized correctly. In most cases, "settantanove" will be recognized as "settanta nove" (70 9). NOTE: Visit the WebSphere Voice Server SDK peer-to-peer discussion newsgroup forum located under "Forums/newsgroups" at: http://www.ibm.com/software/webservers/voiceserver/support.html 12.0 UNINSTALLATION You must have administrator access to uninstall these products. 12.1 Uninstalling the Sun JRE Before attempting to uninstall the Sun JRE, you should first uninstall the IBM WebSphere Voice Server SDK. 12.2 Uninstalling the SDK If you want to install another IBM WebSphere Voice Server product or an IBM ViaVoice product on your system, you must first uninstall the IBM WebSphere Voice Server SDK. The uninstallation will remove ALL language versions installed. To uninstall this product, run the Add/Remove Programs utility from the Windows Start menu: Start -> Settings -> Control Panel -> Add/Remove Programs NOTE: If you run Add/Remove Programs from a Windows Explorer window, the IBM WebSphere Voice Server SDK will not be completely uninstalled; you will need to manually remove the installation destination directory and then run the TTSCLEAN, VIACLEAN, and VSCLEAN utilities. After completion of the uninstallation program, some files will still remain in the product directory. You will need to manually remove these files. If you encounter any other problems uninstalling the IBM WebSphere Voice Server SDK program completely, you should run the TTSCLEAN, VIACLEAN, and VSCLEAN utilities, as explained in the next section. 13.0 USING THE TTSCLEAN, VIACLEAN, AND VSCLEAN UTILITIES If the SDK installation stops or the uninstallation is unsuccessful or incomplete, you should run the TTSCLEAN, VIACLEAN, and VSCLEAN utilities. These utilities remove Voice Server SDK registry entries that are left on your system. Any installed files that are left on your system after running these utilities should be manually removed (files in C:\Program Files\VoiceServerSDK, for example). These utilities are located on the installation media only; they are not installed on your hard disk. You can run these files in any order. ...\install\Support\ttsclean.exe ...\install\Support\viaclean.exe ...\install\Support\vsclean.exe NOTES: 1. If you are installing the SDK from a CD-ROM, this path is relative to the root directory of the CD-ROM. 2. If you downloaded the SDK from a Web site, this path is relative to the directory where you unpacked the installation package. 14.0 NOTICES AND TRADEMARKS This information was developed for products and services offered in the United States. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 USA For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. 14.1 Trademarks and service marks DB2, DB2 Universal Database, IBM, ViaVoice, and WebSphere are trademarks or registered trademarks of the International Business Machines Corporation in the United States, other countries, or both. Intel and Pentium are trademarks of Intel Corporation in the United States, other countries, or both. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others. 15.0 THIRD-PARTY LICENSES This Program includes third-party components which are subject to the following: o Your use of The Mozilla ECMAScript/JavaScript Interpreter is subject to the terms and conditions of the Netscape Public License Version 1.1 (the "License") which is installed in the following location on your hard drive: <installation-directory>\docs\mozilla.txt You may also obtain a copy of the License at: http://www.mozilla.org/NPL/ as well as the source code at: http://www.mozilla.org/download.html o Java Media Framework 2.0 is subject to the terms and conditions listed in the Binary Code License Agreement section of the readme file which is installed in the following location on your hard drive: <installation-directory>\jmf20\doc\readme.html o Adobe Acrobat Reader is subject to the license agreement provided by Adobe Systems Incorporated. You may obtain a copy of the license at: http://www.adobe.com/products/acrobat/ or view the terms and conditions during installation of Acrobat Reader. (C)Copyright IBM Corporation 2000, 2002. All rights reserved.