Installing Vocalizer

For an installation overview, see Installation.

Review these notes before starting the installation procedure:

  • Installation host: You can install Vocalizer on any host; however, you must also install the client on your application host to enable communication with the server. See Installing the Vocalizer client for details.
  • Software location: The default location is:
    • Linux: /usr/local/Nuance/Vocalizer_for_Enterprise
    • Windows: C:\Program Files (x86)\Nuance\Vocalizer_for_Enterprise
  • Environment variables: The installation sets these environment variables. Open a new session to make them available.

    Variable

    Default

    Description

    NUANCE_DATA_DIR

    Linux: /var/local/Nuance

    Windows: C:\ProgramData\Nuance\Enterprise

    Directory for storing log, cache, utterance files.

    VOCALIZER_SDK

    Linux: /usr/local/Nuance/Vocalizer_for_Enterprise

    Windows: C:\Program Files\Nuance\Vocalizer for Enterprise

    Installation directory for Vocalizer for Enterprise.

    (In documentation examples this is what is meant by the Vocalizer install_path.)

    Note: If you are running the Vocalizer API, not all required environment variables are set by the installation. See Configuring the Vocalizer API for post-installation configuration.

Uninstalling previous releases of Nuance Core Services

Vocalizer is not compatible on the same host with Nuance Core Services 4.0.

If the host already has an installation of Nuance Core Services, you must uninstall it before installing Vocalizer.

To remove Nuance Core Services:

  • On Linux:
    > rpm -e NCoreServices-FTA-RES NCoreServices-WATCHER
  • On Windows:
    • Select Add/Remove Programs from the Control Panel.
    • Click on the Nuance Core Services program, and click Remove.

Installing Vocalizer for Enterprise

To install Vocalizer for Enterprise:

  1. Remove all previously installed voices and then the software:
    • To remove a voice: rpm -ve voice
    • To remove a voice: rpm -ve voice
  2. Confirm that any other prerequisite software is installed as described under Requirements.
  3. Download the Vocalizer for Enterprise product from Nuance Network at Nuance Network.
  4. Extract the software:
    > tar -zxf downloadedFileName.tar.gz
  5. Change to the Vocalizer_for_Enterprise directory, and run the install.sh shell script.

    For example:

    > cd Vocalizer_for_Enterprise
    > ./install.sh
  6. Follow the online instructions to complete the installation.
  7. Open a new session to make $VOCALIZER_SDK available to your environment.
  8. Install a voice as described in Installing voices.
  1. Confirm that any other prerequisite software is installed as described under Requirements.
  2. Download the Vocalizer for Enterprise product from Nuance Network at Nuance Network.
  3. Unzip the software.
  4. Change to the Vocalizer_for_Enterprise directory, and run the exe file.
  5. Follow the online instructions to complete the installation.
  6. Install a voice as described in Installing voices.

Installing voices

Note: Do not install voices on network mounted drives.

To install voices, first download the voice from Nuance Network at Nuance Network and extract the downloaded file.

  1. Change to the voice subdirectory under the location where you downloaded the rpm.
  2. To install a voice to the default location, Nuance/usr/local/Vocalizer_for_Enterprise run the following command: 
    > rpm -i voice.rpm

    For example, this command installs the American English Samantha voice for Vocalizer for Enterprise under /usr/local/Nuance/Vocalizer_for_Enterprise:

    > rpm -i nve-enu-samantha-xpremium.rpm
  1. Run the msi program.
  2. Follow the online instructions.

    The voice is installed by default under C:\Program Files (x86)\Nuance\Vocalizer_for_Enterprise\.

On Windows, the Nuance voice installer always installs to the default location. To install to a different location:

  1. Unzip the file in the desired location.
  2. Set the VOCALIZER_VOICE_PATH environment variable to the new location. (To set envars, click Control Panel→System→Advanced system settings.)

Note that more than one voice model may be available, depending on when the voice was manufactured. (Newer voices have better quality.) If you install more than one kind of voice, say Nathan xpremium and xpremium-high, Vocalizer automatically detects and uses the newest (xpremium-high). To avoid this default behavior and force the use of older voices, use the voice_model parameter. (For example, you might want to use an older voice when migrating an existing installation that is tuned for the older voice.)

Uninstalling Vocalizer

To uninstall Vocalizer and voices:

Use the Control Panel to uninstall Vocalizer and the voices. Select a Vocalizer, such as Nuance Vocalizer for Enterprise, and remove it.

To uninstall Vocalizer, use the following command:

> rpm -ve nve-api

Add these commands if removing all Nuance speech products:

> rpm –ve Nuance-Doc
> rpm -ve Nuance-Common

To uninstall voices, run this command:

> rpm -ve voice

For example, to uninstall the American English Zoe voice, use:

> rpm -ve nve-enu-zoe-ml-xpremium-high-1.0.2