Add custom vocabularies - Amazon Connect
Things to know about vocabulariesRequired permissionsAdd a custom vocabularyVocabulary statesView a custom vocabulary

Add custom vocabularies

You can improve the accuracy of speech recognition for product names, brand names, and domain-specific terminology, by expanding and tailoring the vocabulary of the speech-to-text engine in Contact Lens.

This topic explains how to add custom vocabularies using the Amazon Connect admin website. You can also add them using the CreateVocabulary and AssociateDefaultVocabulary APIs.

Things to know about custom vocabularies

  • You must set a vocabulary as the default for it to be applied to the analyses to generate transcripts. The following image shows the Custom vocabularies page. Choose the ellipsis, and then choose Set as default.

    The custom vocabularies page, the location of the ellipses, the set as default option.

  • You can have one vocabulary per language applied to the analyses. This means only one file per language can be in the Ready (default) state.

  • You can upload and activate up to 20 vocabulary files. You can activate all 20 files at the same time.

  • Transcription is a one-time event. A newly uploaded vocabulary isn't applied retroactively to existing transcriptions.

  • Your text file must be in LF format. If you use any other format, such CRLF format, your custom vocabulary is not accepted by Amazon Transcribe.

  • The sample vocabulary file can be downloaded only when you choose an English language setting.

  • For limits to the size of a vocabulary file and other requirements, see Custom vocabularies in the Amazon Transcribe Developer Guide.

  • Custom vocabularies apply to speech analytics only. They do not apply to chat conversations because the transcripts already exist.

Required permissions

Before you can add custom vocabularies to Amazon Connect, you need the Analytics and Optimization, Contact Lens - custom vocabularies permission assigned to your security profile.

By default, in new instances of Amazon Connect the Admin and CallCenterManager security profiles have this permission.

For information about how to add more permissions to an existing security profile, see Update security profiles.

Add a custom vocabulary

  1. Log in to Amazon Connect with a user account that has the required permissions to add custom vocabularies.

  2. Navigate to Analytics and optimization, Custom vocabularies.

  3. Choose Add custom vocabulary.

  4. On the Add custom vocabulary page, enter a name for the vocabulary, choose an English language, and then choose Download a sample file.

    Note

    The sample vocabulary file can be downloaded only when you choose an English language setting. Otherwise, an error message is displayed, as shown in the following image.

    The error message that processing the vocabulary file failed.

    The following image shows what the sample vocabulary file looks like. The header contains Phrase, IPA, SoundsLike, DisplayAs. The header is required.

    A sample vocabulary file, the header.

  5. The information in the file is separated by one [TAB] per entry. For details about how to add words and acronyms to your vocabulary file, see Creating a custom vocabulary using a table in the Amazon Transcribe Developer Guide.

    The following image shows words in a sample vocabulary file. Words in the Phrase column are required. Words in the IPA, SoundsLike, and DisplayAs columns are optional.

    A sample vocabulary file, words in the phrase column are required.

    To enter multiple words in the Phrase column, separate each word with a hyphen (-); do not use spaces.

Vocabulary states

  • Ready (default): The vocabulary is being applied to the analyses to generate transcripts. It is applied to both real-time and post-call analyses.

  • Ready: The vocabulary is not being applied to analyses, but it is a valid file and available. To apply it to analyses, set it to default.

  • Processing: Amazon Connect is validating your uploaded vocabulary and trying to apply it to the analyses to generate transcripts.

  • Deleting: You chose to Remove the vocabulary, and Amazon Connect is deleting it now.

    It takes about 90 minutes for Amazon Connect to delete a vocabulary.

If you attempt to upload a vocabulary that does not validate, it results in a Failed state. For example, if you add multiple-word phrases to the Phrase column, and separate them with spaces instead of hyphens, it will fail.

Download and view a custom vocabulary

To view a custom vocabulary that has been uploaded, you download and open the file. Only files in the Ready state can be downloaded and viewed.

  1. Navigate to Analytics and optimization, Custom vocabularies.

  2. Choose More, Download. The location of Download is shown in the following image.

    The custom vocabularies page, a list of vocabularies, the more dropdown menu, the download option.

  3. Open the download to view the contents.

  4. You can change the contents, and then choose Save and upload.