Custom Vocabulary Configuration API

Feature Release

This is the announcement for an upcoming ASAPP feature. Your ASAPP account team will provide a target release date and can direct you to more detailed information as needed.

Overview

AutoTranscribe is being extended with a new self-serve feature for ASAPP’s partners, Custom Vocabulary. This feature allows users to independently add or delete business-specific keywords within a custom vocabulary set. These keywords will be included during the ASAPP’s ASR model fine-tuning, enhancing transcription accuracy to better suit their specific needs.

Use and Impact

The custom vocab features aim to deliver significant benefits to the customers and partners:

• Faster onboarding Enables swift initial configuration, expediting the onboarding process for customers. This feature reduces dependency on the ASAPP Delivery team.
• Business-Specific Terminology & Contextual Relevance By allowing clients to add industry-specific terms/words, and names, the ASR model can better recognize and accurately transcribe these words and generate more precise transcriptions, which are often missed or misinterpreted by generic models. This feature is fully customizable and self-serviceable. Users can create/update/delete a custom vocabulary containing specific keywords tailored to their domain and line of business. The scenarios where this feature is particularly beneficial include:
• When the Speech-to-Text (ASR) service needs to incorporate business-specific terminologies and keywords.

How It Works

Field Description

Field Name	Type	Description
custom-vocabularies	list	Custom vocabularies list By default, the list will display up to 20 custom vocabs. Can be configured.
custom-vocabularies[].id	string	System generated id
custom-vocabularies[].phrase	string	The phrase to place in the transcribed text
custom-vocabularies[].soundsLike	list	List of similar phrases for the received sound
nextCursor	id	Next field ID Will be null for the first page
prevCursor	id	Previous field ID Will be null for the last page

1. List all custom vocabs GET /configuration/v1/auto-transcribe/custom-vocabularies Sample response

   {
     "customVocabularies": 
   [
       {
         "id": "563a0954-1db7-4b96-bf21-fa84de137742",
         "phrase": "IEEE",
         "soundsLike": [
                      "I triple E"
                      ]
        },
        {
          "id": "7939d838-774c-46fe-9f18-5ebf15cf3e9c",
          "phrase": "NATO",
          "soundsLike": [
                      "Nae tow",
                      "Naa toe"
                      ]
        }
     ],
      "nextCursor": "4c576035-870e-47cf-88ef-8d29e6b5d7e8",
      "prevCursor": null 
    }
   

2. Details of a particular custom vocab GET /configuration/v1/auto-transcribe/custom-vocabularies/\{customVocabularyId\} Sample response

   {
     "id": "6B29FC40-CA47-1067-B31D-00DD010662DA", 
     "phrase": "IEEE",
     "soundsLike":[
       "I triple E"
     ]
   }
   

3. Create a custom vocab POST /configuration/v1/auto-transcribe/custom-vocabularies Sample Request

   {
     "phrase": "IEEE",
     "soundsLike": [
       "I triple E"
     ]
   }
   

   Sample response

   {
     "id": "6B29FC40-CA47-1067-B31D-00DD010662DA", 
     "phrase": "IEEE",
     "soundsLike":[
       "I triple E"
     ]
   }
   

4. Delete a custom vocab DELETE /configuration/v1/auto-transcribe/custom-vocabularies/\{customVocabularyId\}

FAQs

• Can I modify the custom vocabulary after it’s been created? Yes, users can update the custom vocabulary at any time. To do so, first delete the existing vocabulary and then submit a new create request. This process ensures that the vocabulary remains current and relevant.
• Can I send the create request for multiple custom vocab additions? Currently multiple custom vocab addition capability is not live, users must submit individual create requests for each addition. That said, If a large number of additions are required, please contact ASAPP’s support team for assistance.
• Is there a limit to the number of custom vocabularies that can be added? Yes, The maximum number of custom vocabulary entries is 200 However, this limit is subject to change as ASAPP continuously updates and expands its backend capabilities to support more custom vocab.
• Is there a limit to the number of sounds like items within the custom vocab? The maximum number of sounds like items should be 5 and length of each item should be 40 characters