Upgrading Watson Speech services from Version 5.1.x to a later 5.1 refresh

An instance administrator can upgrade Watson Speech services from Version 5.1.x to a later 5.1 refresh.

Who needs to complete this task?

Instance administrator To upgrade Watson Speech services, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of Watson Speech services are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and Watson Speech services are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to upgrade the IBM Software Hub control plane and one or more services at the same time, follow the process in Upgrading an instance of IBM Software Hub instead.
  • If you didn't upgrade Watson Speech services when you upgraded the IBM Software Hub control plane, complete this task to upgrade Watson Speech services.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of Watson Speech services on the cluster.

Information you need to complete this task

Review the following information before you upgrade Watson Speech services:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.1.3, you must upgrade Watson Speech services to Version 5.1.3.

Environment variables
The commands in this task use environment variables so that you can run the commands exactly as written.
  • If you don't have the script that defines the environment variables, see Setting up installation environment variables.
  • To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:
    source ./cpd_vars.sh

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite Where to find more information
The cluster meets the minimum requirements for Watson Speech services. If this task is not complete, see System requirements.
The workstation from which you will run the upgrade is set up as a client workstation and the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift® CLI: oc
 If this task is not complete, see Updating client workstations.
The IBM Software Hub control plane is upgraded. If this task is not complete, see Upgrading an instance of IBM Software Hub.
For environments that use a private container registry, such as air-gapped environments, the Watson Speech services software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the cpd-cli is configured to pull the olm-utils-v3 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
Multicloud Object Gateway is upgraded, if needed. If this task is not complete, see Upgrading Multicloud Object Gateway.

Procedure

Complete the following tasks to upgrade Watson Speech services:

  1. Specifying installation options
  2. Upgrading the service
  3. Validating the upgrade
  4. Upgrading existing service instances
  5. What to do next

Specifying installation options

When you upgrade Watson Speech services, the options that you specified when you installed Watson Speech services are used.

If you plan to install the Watson Speech services, you can specify the following installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used. Uncomment the parameters that you want to override and update the values appropriately.

The sample YAML content uses the default values.

################################################################################
# Watson Speech services parameters
################################################################################

# ------------------------------------------------------------------------------
# Watson Speech to Text parameters
# ------------------------------------------------------------------------------
#watson_speech_enable_stt_async: false
#watson_speech_enable_stt_customization: false
#watson_speech_enable_stt_runtime: true
#watson_speech_stt_scale_config: xsmall

# ------------------------------------------------------------------------------
# Watson Text to Speech parameters
# ------------------------------------------------------------------------------
#watson_speech_enable_tts_customization: false
#watson_speech_enable_tts_runtime: true
#watson_speech_tts_scale_config: xsmall

# ------------------------------------------------------------------------------
# Watson Speech to Text models
# ------------------------------------------------------------------------------
#watson_speech_models: ["enUsBroadbandModel","enUsNarrowbandModel","enUsShortFormNarrowbandModel","enUsTelephony","enUsMultimedia"]

# ------------------------------------------------------------------------------
# Watson Text to Speech enhanced neural voices
# ------------------------------------------------------------------------------
#watson_speech_voices: ["enUSAllisonV3Voice","enUSLisaV3Voice","enUSMichaelV3Voice"]
Watson Speech to Text parameters

The following options apply only if you install the Watson Speech to Text service.

Property Description
watson_speech_enable_stt_async Specify whether to enable asynchronous HTTP requests. For example, enable this feature if you have large requests that you want to process asynchronously.
Default value
false
Valid values
false
Do not enable asynchronous HTTP requests.
true
Enable asynchronous HTTP requests.

When you set this property to true, it enables the /v1/recognitions interface.
watson_speech_enable_stt_customization Specify whether to enable Watson Speech to Text customizations:
  • Language model customization, which enables the service to more accurately recognize domain-specific terms.
  • Acoustic model customization, which enables the service to adapt to environmental noise, audio quality, and the accent or cadence of the speakers.
Default value
false
Valid values
false
Do not enable Watson Speech to Text customizations.
true
Enable Watson Speech to Text customizations.
When you set this property to true, it enables the following interfaces:
  • /v1/customizations for language model customization.
  • /v1/acoustic_customizations for acoustic model customization.
watson_speech_enable_stt_runtime Specify whether to enable the microservice for speech recognition. You must enable this microservice if you install the Watson Speech to Text service.
Default value
true
Valid values
false
Do not enable the microservice for speech recognition.
Important: This microservice is automatically enabled if you set either of the following properties to true:
  • watson_speech_enable_stt_customization
  • watson_speech_enable_stt_async
true
Enable the microservice for speech recognition.

When you set this property to true, it enables the /v1/recognize interface.
watson_speech_stt_scale_config Specify the size of the service.
Default value
xsmall
Valid values
  • xsmall
  • small
  • medium
  • large
  • custom

For detailed information about each size, refer to the component scaling guidance PDF.
Watson Text to Speech parameters

The following options apply only if you install the Watson Text to Speech service.

Property Description
watson_speech_enable_tts_customization Specify whether to enable Watson Text to Speech customizations, which enables the service to create a dictionary of words and their translations for a specific language.
Default value
false
Valid values
false
Do not enable Watson Text to Speech customizations.
true
Enable Watson Text to Speech customizations.

When you set this property to true, it enables the /v1/customizations interface for customization.
watson_speech_enable_tts_runtime Specify whether to enable the microservice for speech synthesis. You must enable this microservice if you install the Watson Text to Speech service.
Default value
true
Valid values
false
Do not enable the microservice for speech synthesis.
Important: This microservice is automatically enabled if you set watson_speech_enable_tts_customization to true.
true
Enable the microservice for speech synthesis.

When you set this property to true, it enables the /v1/synthesize interface.
watson_speech_tts_scale_config Specify the size of the service.
Default value
xsmall
Valid values
  • xsmall
  • small
  • medium
  • large
  • custom

For detailed information about each size, refer to the component scaling guidance PDF.
Watson Speech to Text models

The following options apply only if you install the Watson Speech to Text service.

Property Description
watson_speech_models Specify which Watson Speech to Text models are installed.

Specify the models as a comma-separated array. For example:

["enUsBroadbandModel","enUsNarrowbandModel","enUsShortFormNarrowbandModel",...]
Default value
By default, the following models are installed:
  • enUsBroadbandModel (US English (en-US) Broadband model)
  • enUsNarrowbandModel(US English (en-US) Narrowband model)
  • enUsShortFormNarrowbandModel (US English (en-US) Short-Form Narrowband model)
  • enUsMultimedia (US English (en-US) Multimedia model)
  • enUsTelephony (US English (en-US) Telephony model )
Valid Values
Previous- generation models
  • enUsBroadbandModel (US English (en-US) Broadband model)
  • enUsNarrowbandModel(US English (en-US) Narrowband model)
  • enUsShortFormNarrowbandModel (US English (en-US) Short-Form Narrowband model)
  • arMsBroadbandModel (Modern Standard Arabic (ar-MS) Broadband model)
  • deDeBroadbandModel (German (de-DE) Broadband model)
  • deDeNarrowbandModel (German (de-DE) Narrowband model)
  • enAuBroadbandModel (Australian English (en-AU) Broadband model)
  • enAuNarrowbandModel (Australian English (en-AU) Narrowband model)
  • enGbBroadbandModel (UK English (en-GB) Broadband model)
  • enGbNarrowbandModel (UK English (en-GB) Narrowband model)
  • esEsBroadbandModel (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Broadband models)
  • esEsNarrowbandModel (Castilian Spanish (es-ES, es-AR, es-CL, es-CO, es-MX, and es-PE) Narrowband models)
  • frCaBroadbandModel (Canadian French (fr-CA) Broadband model)
  • frCaNarrowbandModel (Canadian French (fr-CA) Narrowband model)
  • frFrBroadbandModel (French (fr-FR) Broadband model)
  • frFrNarrowbandModel (French (fr-FR) Narrowband model)
  • itItBroadbandModel (Italian (it-IT) Broadband model)
  • itItNarrowbandModel (Italian (it-IT) Narrowband model)
  • jaJpBroadbandModel (Japanese (ja-JP) Broadband model)
  • jaJpNarrowbandModel (Japanese (ja-JP) Narrowband model)
  • koKrBroadbandModel (Korean (ko-KR) Broadband model)
  • koKrNarrowbandModel (Korean (ko-KR) Narrowband model)
  • nlNlBroadbandModel (Dutch (nl-NL) Broadband model)
  • nlNlNarrowbandModel (Dutch (nl-NL) Narrowband model)
  • ptBrBroadbandModel (Brazilian Portuguese (pt-BR) Broadband model)
  • ptBrNarrowbandModel (Brazilian Portuguese (pt-BR) Narrowband model)
  • zhCnBroadbandModel (Mandarin Chinese (zh-CN) Broadband model)
  • zhCnNarrowbandModel (Mandarin Chinese (zh-CN) Narrowband model)
Next-generation models
  • enUsMultimedia (US English (en-US) Multimedia model)
  • enUsTelephony (US English (en-US) Telephony model )
  • arMsTelephony (Modern Standard Arabic (ar-MS) Telephony model)
  • csCZTelephony (Czech (cs-CZ) Telephony model)
  • deDeMultimedia (German (de-DE) Multimedia model)
  • deDeTelephony (German (de-DE) Telephony model)
  • enAuMultimedia (Australian English (en-AU) Multimedia model)
  • enAuTelephony (Australian English (en-AU) Telephony model)
  • enGbMultimedia (UK English (en-GB) Multimedia model)
  • enGbTelephony (UK English (en-GB) Telephony model)
  • enInTelephony (Indian English (en-IN) Telephony model)
  • enWwMedicalTelephony (English (all supported dialects) Medical Telephony model)
  • esEsMultimedia (Castilian Spanish (es-ES) Multimedia model)
  • esEsTelephony (Castilian Spanish (es-ES) Telephony model)
  • esLaTelephony (Latin American Spanish (es-LA) Telephony model)
  • frCaMultimedia (Canadian French (fr-CA) Multimedia model)
  • frCaTelephony (Canadian French (fr-CA) Telephony model)
  • frFrMultimedia (French (fr-FR) Multimedia model)
  • frFrTelephony (French (fr-FR) Telephony model)
  • hiInTelephony (Indian Hindi (hi-IN) Telephony model)
  • itItMultimedia (Italian (it-IT) Multimedia model)
  • itItTelephony (Italian (it-IT) Telephony model)
  • jaJpMultimedia (Japanese (ja-JP) Multimedia model)
  • jaJpTelephony (Japanese (ja-JP) Telephony model)
  • koKrMultimedia (Korean (ko-KR) Multimedia model)
  • koKrTelephony (Korean (ko-KR) Telephony model)
  • nlBeTelephony (Belgian Dutch (nl-BE) Telephony model)
  • nlNlMultimedia (Netherlands Dutch (nl-NL) Multimedia model)
  • nlNlTelephony (Netherlands Dutch (nl-NL) Telephony model)
  • ptBrMultimedia (Brazilian Portuguese (pt-BR) Multimedia model)
  • ptBrTelephony (Brazilian Portuguese (pt-BR) Telephony model)
  • svSeTelephony (Swedish (sv-SE) Telephony model)
  • zhCnTelephony (Mandarin Chinese (zh-CN) Telephony model)
Large speech models
  • deDe (German (de-DE) model)
  • enUs (US English (en-US) model)
  • enAu (Australian English (en-AU) model)
  • enGb (UK English (en-GB) model)
  • enIn (Indian English (en-IN) model)
  • esAR (Argentinian Spanish (es-AR) model)
  • esCl (Chilean Spanish (es-CL) model)
  • esCo (Colombian Spanish (es-ES) model)
  • esEs (Castilian Spanish (es-ES) model)
  • esMx (Mexican Spanish (es-ES) model)
  • esPe (Peruvian Spanish (es-ES) model)
  • frCa (Canadian French (fr-CA) model)
  • frFr (French (fr-FR) model)
  • jaJp (Japanese (ja-JP) model)
  • ptBr (Brazilian Portuguese (pt-BR) model)
  • ptPt (Portugal Portuguese (pt-PT) model)
Watson Text to Speech voices

The following options apply only if you install the Watson Text to Speech service.

Property Description
watson_speech_voices Specify which Watson Text to Speech voices are installed.

Specify the voices as a comma-separated array. For example:

["enUSAllisonV3Voice","enUSLisaV3Voice","enUSMichaelV3Voice",...]
Default value
By default, the following voices are installed:
  • enUSAllisonV3Voice (US English (en-US) Allison enhanced neural voice)
  • enUSLisaV3Voice (US English (en-US) Lisa enhanced neural voice)
  • enUSMichaelV3Voice (US English (en-US) Michael enhanced neural voice)
Valid Values
Enhanced neural voices
  • enUSAllisonV3Voice (US English (en-US) Allison enhanced neural voice)
  • enUSLisaV3Voice (US English (en-US) Lisa enhanced neural voice)
  • enUSMichaelV3Voice (US English (en-US) Michael enhanced neural voice)
  • enUSEmilyV3Voice (US English (en-US) Emily enhanced neural voice)
  • enUSHenryV3Voice (US English (en-US) Henry enhanced neural voice)
  • enUSKevinV3Voice (US English (en-US) Kevin enhanced neural voice)
  • enUSOliviaV3Voice (US English (en-US) Olivia enhanced neural voice)
  • deDEBirgitV3Voice (German (de-DE) Birgit enhanced neural voice)
  • deDEDieterV3Voice (German (de-DE) Dieter enhanced neural voice)
  • deDEErikaV3Voice (German (de-DE) Erika enhanced neural voice)
  • enGBCharlotteV3Voice (UK English (en-GB) Charlotte enhanced neural voice)
  • enGBJamesV3Voice (UK English (en-GB) James enhanced neural voice)
  • enGBKateV3Voice (UK English (en-GB) Kate enhanced neural voice)
  • esESEnriqueV3Voice (Castilian Spanish (es-ES) Enrique enhanced neural voice)
  • esESLauraV3Voice (Castilian Spanish (es-ES) Laura enhanced neural voice)
  • esLASofiaV3Voice (Latin American Spanish (es-LA) Sofia enhanced neural voice)
  • esUSSofiaV3Voice (North American Spanish (es-US) Sofia enhanced neural voice)
  • frCALouiseV3Voice (French Canadian (fr-CA) Louise enhanced neural voice)
  • frFRNicolasV3Voice (French (fr-FR) Nicolas enhanced neural voice)
  • frFRReneeV3Voice (French (fr-FR) Renee enhanced neural voice )
  • itITFrancescaV3Voice (Italian (it-IT) Francesca enhanced neural voice)
  • jaJPEmiV3Voice (Japanese (ja-JP) Emi enhanced neural voice)
  • koKRJinV3Voice (Korean (ko-KR) Jin enhanced neural voice)
  • nlNLMerelV3Voice (Netherlands Dutch (nl-NL) Merel enhanced neural voice)
  • ptBRIsabelaV3Voice (Brazilian Portuguese (pt-BR) Isabela enhanced neural voice)
Expressive neural voices
  • enAUHeidiExpressive (Australian English (en-AU) Heidi expressive neural voice)
  • enAUJackExpressive (Australian English (en-AU) Jack expressive neural voice)
  • enGBGeorgeExpressive (GB English (en-GB) George expressive neural voice)

    5.1.2 and later This voice is available starting in IBM Software Hub Version 5.1.2.

  • enUSAllisonExpressive (US English (en-US) Allison expressive neural voice)
  • enUSEmmaExpressive (US English (en-US) Emma expressive neural voice)
  • enUSLisaExpressive (US English (en-US) Lisa expressive neural voice)
  • enUSMichaelExpressive (US English (en-US) Michael expressive neural voice)
  • ptBRLucasExpressive (Brazilian Portuguese (pt-BR) Lucas expressive nueral voice)

    5.1.2 and later This voice is available starting in IBM Software Hub Version 5.1.2.

Upgrading the service

Important: The Operator Lifecycle Manager (OLM) objects for Watson Speech services were updated when you upgraded the IBM Software Hub platform. The cpd-cli manage apply-olm updates all of the OLM objects in the operators project at the same time.

To upgrade Watson Speech services:

  1. Log the cpd-cli in to the Red Hat® OpenShift Container Platform cluster:
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Update the custom resource for Watson Speech services.

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true \
--upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

Watson Speech services is upgraded when the apply-cr command returns:
[SUCCESS]... The apply-cr command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=watson_speech

Upgrading existing service instances

The service instances are automatically upgraded when you upgrade Watson Speech services.

What to do next

Watson Speech services is ready to use. To get started with Watson Speech services, see Processing spoken audio with Watson Speech services.