vania-janet/multiturn-rag-retrieval-data huggingface dataset:
speech-to-text.custom-language-model.train Train a custom language model (POST /v1/customizations/{customization_id}/train). 







 Reset event 



Table 5. Language model customization .reset action that generates an event

 Action Description 

 speech-to-text.custom-language-model.reset Reset a custom language model (POST /v1/customizations/{customization_id}/reset). 







 Upgrade event 



Table 6. Language model customization .upgrade action that generates an event

 Action Description 

 speech-to-text.custom-language-model.upgrade Upgrade a custom language model (POST /v1/customizations/{customization_id}/upgrade_model). 









 Acoustic model customization events 

The following tables list the Speech to Text actions for acoustic model customization that generate events.



 Create events 



Table 7. Acoustic model customization .create actions that generate events

 Action Description 

 speech-to-text.custom-acoustic-model.create Create a custom acoustic model (POST /v1/acoustic_customizations). 
 speech-to-text.custom-acoustic-model-audio.create Create an audio for a custom acoustic model (POST /v1/acoustic_customizations/{customization_id}/audio/{audio_name}). 







 Read events 



Table 8. Acoustic model customization .read actions that generate events

 Action Description 

 speech-to-text.custom-acoustic-model-list.read Read a list of custom acoustic models (GET /v1/acoustic_customizations). 
 speech-to-text.custom-acoustic-model.read Read a custom acoustic model (GET /v1/acoustic_customizations/{customization_id}). 
 speech-to-text.custom-acoustic-model-audio-list.read Read an audio list of a custom acoustic model (GET /v1/acoustic_customizations/{customization_id}/audio). 
 speech-to-text.custom-acoustic-model-audio.read Read an audio of a custom acoustic model (GET /v1/acoustic_customizations/{customization_id}/audio/{audio_name}).
Defect fix: Japanese Telephony language model no longer fails due to long training time
: Defect fix: When training a custom language model with Japanese Telephony, the service now effectively handles large numbers of custom words without failing.





 2 May 2023 

New procedure for upgrading a custom model that is based on an improved next-generation model
: Two approaches are now available to upgrade a custom language model to an improved next-generation base model. You can still modify and then retrain the custom model, as already documented. But now, you can also upgrade the custom model by including the query parameter force=true with the POST /v1/customizations/{customization_id}/train request. The force parameter upgrades the custom model regardless of whether it contains changes (is in the ready or available state).

For more information, see [Upgrading a custom language model based on an improved next-generation model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgradecustom-upgrade-language-ng).

Guidance for adding words to custom models that are based on improved next-generation models
: The documentation now offers more guidance about adding words to custom models that are based on improved next-generation models. For performance reasons during training, the guidance encourages the use of corpora rather than the direct addition of custom words whenever possible.

For more information, see [Guidelines for adding words to custom models based on improved next-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ngwordsResourceAmount-words-ng).

Japanese custom words for custom models that are based on improved next-generation models are handled differently
: For Japanese custom models that are based on next-generation models, custom words are handled differently from other languages. For Japanese, you can add a custom word or sounds-like that does not exceed 25 characters in length. If your custom word or sounds-like exceeds that limit, the service adds the word to the custom model as if it were added by a corpus. The word does not appear as a custom word for the model.
This documentation is for the classic Watson Assistant experience. To see the documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Building a complex dialog 

In this tutorial, you will use the Watson Assistant service to create a dialog for an assistant that helps users with inquiries about a fictitious restaurant called Truck Stop Gourmand.



 Learning objectives 

By the time you finish the tutorial, you will understand how to:



* Plan a dialog
* Define custom intents
* Add dialog nodes that can handle your intents
* Add entities to make your responses more specific
* Add a pattern entity, and use it in the dialog to find patterns in user input
* Set and reference context variables





 Duration 

This tutorial will take approximately 2 to 3 hours to complete.





 Prerequisite 

Before you begin, complete the [Getting Started tutorial](https://cloud.ibm.com/docs/assistant?topic=assistant-getting-started).

You will use the dialog skill that you created, and add nodes to the simple dialog that you built as part of the getting started exercise.







 Step 1: Plan the dialog 

You are building an assistant for a restaurant named Truck Stop Gourmand that has one location and a thriving cake-baking business. You want the simple assistant to answer user questions about the restaurant, its menu, and to cancel customer cake orders. Therefore, you need to create intents that handle inquiries related to the following subjects:



* Restaurant information
* Menu details
* Order cancellations



You'll start by creating intents that represent these subjects, and then build a dialog that responds to user questions about them.





 Step 2: Answer questions about the restaurant 

Add an intent that recognizes when customers ask for details about the restaurant itself. An intent is the purpose or goal expressed in user input. The General_About_You intent that is provided with the General content catalog serves a similar function, but its user examples are designed to focus on queries about the assistant as opposed to the business that is using the assistant to help its customers. So, you will add your own intent.
The service's base vocabulary contains many words that are used in everyday conversation. Its models provide sufficiently accurate recognition for many applications. But they can lack knowledge of specific terms that are associated with particular domains.

The language model customization interface can improve the accuracy of speech recognition for domains such as medicine, law, information technology, and others. By using language model customization, you can expand and tailor the vocabulary of a base model to include domain-specific terminology.

You create a custom language model and add corpora and words specific to your domain. Once you train the custom language model on your enhanced vocabulary, you can use it for customized speech recognition. The service can typically train any custom model in a matter of minutes. The time and effort that are needed to create a custom model depend on the data that you have available for the model.

Language model customization is available for both previous-generation and next-generation models, but customization works differently for previous- and next-generation models. The documentation describes the differences. For more information about getting started with language model customization, see



* [Creating a custom language model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate)
* [Using a custom language model for speech recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageUse)





 Improved language model customization for next-generation models 

Language model customization for next-generation models is being enhanced. The improvements to language model customization are being applied to next-generation models incrementally, starting with the models for a few languages. Over time, other next-generation language models will be migrated to the improved technology.



* To identify models that use the improved technology, look for a date in the Language model customization (improved) column of table 2 in [Customization support for next-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-supportcustom-language-support-ng). Check for a date for the version of the service that you use,

IBM Cloud

or
* Chinese (Mandarin): zh-CN_LiNaVoice, zh-CN_WangWeiVoice, and zh-CN_ZhangJingVoice
* Czech: cs-CZ_AlenaVoice
* Dutch (Belgian): nl-BE_AdeleVoice and nl-BE_BramVoice
* Dutch (Netherlands): nl-NL_EmmaVoice and nl-NL_LiamVoice
* English (Australian): en-AU_CraigVoice, en-AU_MadisonVoice, and en-AU_SteveVoice
* Korean: ko-KR_HyunjunVoice, ko-KR_SiWooVoice, ko-KR_YoungmiVoice, and ko-KR_YunaVoice
* Swedish: sv-SE_IngridVoice



New enhanced neural and expressive neural voices are already available for the Australian English and Korean languages. In the coming weeks, a new enhanced neural voice will be available for the Netherlands Dutch language. You must migrate to one of the new voices for Australian English, Korean, or Netherlands Dutch before 31 March 2023.

For more information, see



* [Languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices)
* [Migrating from neural voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices-migrate)







 27 February 2023 

New Australian English expressive neural voices
: The service now supports two new expressive neural voices, male and female, for Australian English:



* en-AU_HeidiExpressive
* en-AU_JackExpressive



Expressive neural voices offer natural-sounding speech that is exceptionally clear, crisp, and fluid. The new voices are generally available (GA) for production use. They support the use of both standard International Phonetic Alphabet (IPA) and IBM Symbolic Phonetic Representation (SPR) phonetic symbols. For more information, see



* [Expressive neural voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voiceslanguage-voices-expressive)
If you are using IBM Cloud® Dedicated, check with your IBM salesperson to confirm which languages are supported in your environment.



 Arabic 



 Feature Standard Support [Custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) support 

 Categories X 
 Classifications X 
 Concepts 
 Emotion 
 Entities X* X 
 Keywords X 
 Metadata X 
 Relations X X 
 Semantic roles 
 Sentiment X 
 Syntax X 



* Relevance ranking is not supported.





 Chinese (Simplified) 



 Feature Standard Support [Custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) support 

 Categories X 
 Classifications 
 Concepts 
 Emotion 
 Entities X* X 
 Keywords X 
 Metadata 
 Relations X 
 Semantic roles 
 Sentiment X 
 Syntax X 



* Relevance ranking is not supported.





 Czech 



 Feature Standard Support [Custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) support 

 Categories 
 Classifications 
 Concepts 
 Emotion 
 Entities X* 
 Keywords X 
 Metadata 
 Relations 
 Semantic roles 
 Sentiment X 
 Syntax X 



* Relevance ranking is not supported.





 Danish 



 Feature Standard Support [Custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) support 

 Categories 
 Classifications 
 Concepts 
 Emotion 
 Entities X* 
 Keywords X 
 Metadata 
 Relations 
 Semantic roles 
 Sentiment X 
 Syntax X 



* Relevance ranking is not supported.





 Dutch 



 Feature Standard Support [Custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) support 

 Categories X 
 Classifications 
 Concepts 
 Emotion 
 Entities X* X 
 Keywords X 
 Metadata 
 Relations X 
 Semantic roles 
 Sentiment X 
 Syntax X 



* Relevance ranking is not supported.





 English
National language support for IBM Cloud 

IBM Cloud® supports nine national languages other than English. However, depending on the release level of the products included in IBM Cloud, the content that is provided might not be translated.

The IBM Cloud console and the Support Center display content according to your browser's language setting.

The IBM Cloud docs are machine translated. You can switch between languages by using the Language switcher at the beginning of each page. The language that you select persists between sessions. If it's the first time you're viewing the docs in a particular browser, the docs display the content according to your browser's language setting unless the URL includes a parameter setting the language.

The following table lists the supported national languages and language codes for IBM Cloud.



Table 1. Supported national languages and language codes

 National Language Language Code 

 Brazilian Portuguese pt_BR 
 English en 
 French fr 
 German de 
 Japanese ja 
 Korean ko 
 Italian it 
 Spanish es 
 Simplified Chinese zh_CN 
 Traditional Chinese zh_TW 





 National language support for support 

Support by local technical account managers is available in any of the supported national languages that are listed during local business hours. Our major centers have several bilingual technical support professionals who support local languages as needed.





 National language support for sales 

IBM has a local presence in most countries, with sales and technical resources that speak the local language. The [IBM Cloud website](https://www.ibm.com/cloud) does IP detection to designate the website language, and you can also change your business location in the Let's talk button. There, you can find a local phone number and contact information for your country.

The following list displays the website URL and local phone number for a selection of locations that IBM Cloud sales supports across the world.



* United States [https://www.ibm.com/cloud](https://www.ibm.com/cloud) / telephone: +18449525683
* Brazil [https://www.ibm.com/br-pt/cloud](https://www.ibm.com/br-pt/cloud) / telephone: +558007071426
The service supports many languages and dialects:



* Arabic (Modern Standard)
* Chinese (Mandarin)
* Czech
* Dutch (Belgian and Netherlands)
* English (Australian, Indian, United Kingdom, and United States)
* French (Canadian and France)
* German
* Hindi (Indian)
* Italian
* Japanese
* Korean
* Portuguese (Brazilian)
* Spanish (Castilian and Latin American)
* Swedish



For more information about the supported languages and about using previous- and next-generation models for speech recognition, see [Using languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-service-featuresfeatures-languages).





 Audio support 

The service accepts audio for transcription in many popular formats:



* Ogg or Web Media (WebM) audio with the Opus or Vorbis codec
* MP3 (or MPEG)
* Waveform Audio File Format (WAV)
* Free Lossless Audio Codec (FLAC)
* Linear 16-bit Pulse-Code Modulation (PCM)
* G.729
* A-Law
* Mu-law (or u-law)
* Basic audio



For more information about the supported audio formats and their characteristics, see [Using audio formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-service-featuresfeatures-audio).





 Integrated use cases 

You can use the Speech to Text service with other Watson services to create applications with even greater scope and functionality:



* AI assistant on the phone - Eliminate hold times and improve customer satisfaction with IBM Watson® Assistant phone integration. Provide live support to your customers with the pre-built integration of Watson Assistant, Speech to Text, and IBM Watson® Text to Speech.
* Analyze customer calls - Uncover patterns and conduct root-cause analysis on transcriptions of phone calls between your customers and call center agents. Transcribe audio by using Speech to Text, and then analyze the transcription with IBM Watson® Natural Language Understanding.
* Support agents - Provide real-time information to improve agent efficiency and focus.
(This field, which provides the same information as the custom_pronunciation field, is maintained for backward compatibility.)
* supported_features describes the additional service features that are supported by the voice:



* voice_transformation is a boolean value that indicates whether the voice supported the SSML <voice-transformation> element. The feature was available only for obsolete standard US English voices. You cannot use the <voice-transformation> element with any supported voice.
* custom_pronunciation is a boolean value that indicates whether the voice can be customized with the service's customization interface.









 Listing a specific voice 

The GET /v1/voices/{voice} method lists information about a specific voice. It accepts two parameters.



* voice (path parameter, required string) - Identifies the voice for which information is to be returned. You specify a voice by its name (for example, en-US_LisaV3Voice).
* customization_id (query parameter, optional string) - Provides the globally unique identifier (GUID) of a custom model that is defined for the language of the specified voice. If you include a customization ID, you must make the request with credentials for the instance of the service that owns the custom model.



If you omit the customization_id parameter, the method returns JSON output for the specified voice that is identical to the information returned for a voice by the GET /v1/voices method. If you specify a customization_id, the output includes a customization field that provides information about the specified custom model.

The following example returns information about the en-US_LisaV3Voice and the specified custom model:

IBM Cloud

curl -X GET -u "apikey:{apikey}" "{url}/v1/voices/en-US_LisaV3Voice?customization_id=64f4807f-a5f1-5867-924f-7bba1a84fe97"

IBM Cloud Pak for Data
"supported_as_target": false,
"identifiable": true
},
{
"language": "ar",
"language_name": "Arabic",
"native_language_name": "العربية",
"country_code": "AR",
"words_separated": true,
"direction": "right_to_left",
"supported_as_source": true,
"supported_as_target": true,
"identifiable": true
},
. . .
]
Show more

The list of support languages is long, reporting more than 75 languages.





 List of supported languages 

The following table list the translatable languages. The service can translate from the following languages to any other language in the list (with the exception of Basque and Catalan). The service correctly translates from and to bidirectional languages that are written left-to-right and right-to-left (for example, Arabic, Hebrew, and Urdu).

The service use ISO two-character codes for most languages. It uses an ISO three-character code (cnr) for Montenegrin. In some cases, it uses a two-character language code and a two-character country code separated by a hyphen, such as fr-CA for French Canadian, pa-PK for Punjabi spoken in Pakistan, and zh-TW for traditional (Mandarin) Chinese spoken in Taiwan.

Not all language combinations that are supported for translation are also customizable. Usually, only the combinations with English as source or target language are customizable. Click the name of a language to see the customizable translation models for that language.



Table 1. Translatable languages

 Language Language code Language Language code 

 [Arabic](https://cloud.ibm.com/docs/language-translator?topic=language-translator-translation-modelsarabic) ar [Latvian](https://cloud.ibm.com/docs/language-translator?topic=language-translator-translation-modelslatvian) lv
: Added support for new file types for customization: CSV, TSV, XLSX (Microsoft Excel), XLIFF, and JSON. For more information, see [Supported document formats for training data](https://cloud.ibm.com/docs/language-translator?topic=language-translator-customizingsupported-document-formats-for-training-data).

New translation models
: Added Welsh-to-English (cy-en) support in translation, and added support for Welsh (cy) in language detection. For more information, see [List of supported languages](https://cloud.ibm.com/docs/language-translator?topic=language-translator-translation-modelslist-languages-supported).





 11 June 2020 

New customizable translation models
: Added the following customizable translation models for Ukrainian:



* Ukrainian to English (uk-en)
* English to Ukrainian (en-uk)



For more information, see [List of supported languages](https://cloud.ibm.com/docs/language-translator?topic=language-translator-translation-modelslist-languages-supported).

Improved translation between Spanish and English
: Improved results for the translation models between Spanish and English:



* Spanish to English (es-en)
* English to Spanish (en-es)



Improved document translation for Microsoft PowerPoint
: Improved table handling with document translation for Microsoft PowerPoint.





 28 May 2020 

Expanded language support for translation and identification
: Expanded language support:



* Support for translating the following languages is now available:



* Nepali (ne)
* Sinhala (si)



* Support for identifying the following languages is now available:



* Burmese (my)
* Lao (lo)
* Marathi (mr)
* Nepali (ne)
* Punjabi (Shahmukhi script, Pakistan) (pa-PK)
* Sinhala (si)
* Tagalog (tl)





Improved translation results for Catalan and Chinese
: Improved results when translating to and from the following languages:



* Catalan (ca)
* Chinese (Simplified) (zh)



New translation limits for Lite plan
* Australian English: en-AU_Multimedia
* UK English: en-GB_Multimedia



For more information about all available next-generation models, see [Next-generation languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng).

Updates to multiple next-generation models for improved speech recognition
: The following next-generation models have been updated for improved speech recognition:



* Australian English telephony model (en-AU_Telephony)
* UK English telephony model (en-GB_Telephony)
* US English multimedia model (en-US_Multimedia)
* US English telephony model (en-US_Telephony)
* Castilian Spanish telephony model (es-ES_Telephony)



For more information about all available next-generation models, see [Next-generation languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng).

Grammar support for previous-generation models is now generally available
: Grammar support is now generally available (GA) for previous-general models that meet the following conditions:



* The models are generally available.
* The models support language model customization.



For more information, see the following topics:



* For more information about the status of grammar support for previous-generation models, see [Customization support for previous-generation models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-supportcustom-language-support-pg).
* For more information about grammars, see [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customizationgrammars-intro).



New beta grammar support for next-generation models
: Grammar support is now available as beta functionality for all next-generation models. All next-generation models are generally available (GA) and support language model customization. For more information, see the following topics: