AutoTranscribe Updates

​

How It Works

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

   Ask AI

   {
   "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
   Copy

   Ask AI

   {
   "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
   Copy

   Ask AI

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

   Sample response
   Copy

   Ask AI

   {
   "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

​

How It Works

1. List redaction entities GET /configuration/v1/redaction/redaction-entities Sample Response
   Copy

   Ask AI

   {
       "redactionEntities": [
   {
       "id": "DOB",
       "name": "DOB",
       "description": "It redacts Data of birth content of data",
       "active": false
   },
   {
       "id": "PASSWORD",
       "name": "PASSWORD",
       "description": "It redacts passwords",
       "active": true
   },
   {
       "id": "PROFANITY",
       "name": "PROFANITY",
       "description": "It redacts words and phrases present in a list of known bad words",
       "active": false
   },
   {
       "id": "EMAIL",
       "name": "EMAIL",
       "description": "It redacts any well-formed email address (abc@asapp.com)",
       "active": true
   },
   {
       "id": "PHONE_NUMBER",
       "name": "PHONE_NUMBER",
       "description": "Redacts sequences of digits that could be phone numbers based on phone number formats.",
       "active": false
   },
   {
       "id": "CREDIT_CARD_NUMBER",
       "name": "CREDIT_CARD_NUMBER",
       "description": "Redacts credit card data",
       "active": true
   },
   {
       "id": "PIN",
       "name": "PIN",
       "description": "Redacts the pin",
       "active": true
   },
   {
       "id": "SSN",
       "name": "SSN",
       "description": "It redacts all the digits in next few sentences containing ssn keyword",
       "active": true
   }
   ],
       "nextCursor": null,
       "prevCursor": null
   }
   

2. List current active redaction entities GET/configuration/v1/redaction/redaction-entities?active=true Querying the redaction entities with the active flag shows which redaction rules are currently active. By default, all auto-enabled entities will be active for every user, however, users can update these rules to suit their individual needs Sample Response
   Copy

   Ask AI

   {
       "redactionEntities": [
   {
       "id": "PASSWORD",
       "name": "PASSWORD",
       "description": "It redacts passwords",
       "active": true
   },
   {
       "id": "EMAIL",
       "name": "EMAIL",
       "description": "It redacts any well-formed email address (test@asapp.com)",
       "active": true
   },
   {
       "id": "CREDIT_CARD_NUMBER",
       "name": "CREDIT_CARD_NUMBER",
       "description": "Redacts credit card data",
       "active": true
   },
   {
       "id": "PIN",
       "name": "PIN",
       "description": "Redacts the pin",
       "active": true
   },
   {
       "id": "SSN",
       "name": "SSN",
       "description": "It redacts all the digits in next few sentences containing ssn keyword",
       "active": true
   }
   ],
       "nextCursor": null,
       "prevCursor": null
   }
   

3. Fetch a redaction entity: GET /configuration/v1/redaction/redaction-entity/\{entityId\} Sample Response
   Copy

   Ask AI

   HTTP 200
   // Returns the redaction entity resource.
   

4. Activate or Disable a redaction entity Change an entity to active or not by setting the active flag. PATCH /configuration/v1/redaction/redaction-entity/\{entityId\} Sample Request Body
   Copy

   Ask AI

   {
       "active":true
   }
   

   On success, returns HTTP 200 and the Redaction entity resource. Sample Response
   Copy

   Ask AI

   {
       "id": "PASSWORD",
       "name": "PASSWORD",
       "description": "It redacts passwords",
       "active": true
   }
   

​

Example Entities

​

FAQs

• What is an entity? In the context of redaction, an entity refers to a specific type or category of information that you want to remove or obscure from the response text. Entities are the “labels” for the pieces of information you want redacted. For example, “NAME” is an entity that represents personal names, “ADDRESS” represents physical addresses, and “ZIP” represents postal codes. When you wish to redact, you specify which entities you want redacted from your text.
• Can I delete existing redaction entities? Users can only enable or disable the predefined entities listed in the previous section. Due to PCI compliance regulations, two entities (CREDIT_CARD_NUMBER and CVV) are initially disabled and can only be removed through ASAPP’s compliance process. All other entities are not enabled by default, but users have the flexibility to enable any of these according to their specific requirements. Users cannot create new entities or modify existing ones; they can only control the activation status of the predefined set.
• What is the accuracy of the redaction service of ASAPP? Our redaction service currently supports over 50 Out of the box (OOTB) entities, with the flexibility to expand and update this set as required. For specific entity customization, including enabling or disabling particular entities or suggesting new entities to tailor to your specific needs, please contact ASAPP’s support team.