Update Deepgram ASR Configuration

This API allows you to add Deepgram ASR to the Uniphore Voice Connector and update the configuration. Currently supports US English (en-us).

Endpoint

Method: PUT

URL: https://<<hostname>>/cse/connector/uvc/interactDomain/virtualAgent/<<vrmId>>/language/<<langID>>/updateDeepgramAsrConfig?currentAsrProvider=DEEPGRAM-ASR' \

curl -X 'PUT' \
  'https://<<hostname>>/cse/connector/uvc/interactDomain/virtualAgent/2/language/4/updateDeepgramAsrConfig?currentAsrProvider=DEEPGRAM-ASR' \
      -H 'accept: application/json' \
      -H 'Tenant-Id: <<TenantName>>' \
      -H 'Environment-Name: dev' \
      -H 'Authorization: Bearer 1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJpc3MiOiJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vIiwic3ViIjoiMWd1UEFna3lPY2haUUl5Q1NEU3JCZ3hHanZiT3dhUk9AY2xpZW50cyIsImF1ZCI6ImFwaS51bmlwaG9yZS5jb20iLCJpYXQiOjE3NDg5NDc4MTYsImV4cCI6MTc0OTU1MjYxNiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwiYXpwIjoiMWd1UEFna3lPY2haUUl5Q1NEU3JCZ3hHanZiT3dhUk8iLCJwZXJtaXNzaW9ucyI6W119.Sb8HMHlFcuMRg_F6hcJ-24PyiLJjN-0fO_Fcqo4sJ9O4MKOa5n20bxG-47cPbpy5Cy-ZU7JNvEzIAFmvqqY9zmFkM55I00lu94mlXyHv9jcjM70-XHuYwtuXhcFEizfTy6Foz6iq5hIfNRaKFdJb5KulgCPyHPHWXUh2vqXlaQlSTQpn5CSss0rW5939pUQ-eA1M573tBaZoR1pBDQc24RVw-5rQUNa8D8toMoe5lQQuOuahOsE945dkVCEg1h4CGfKYH62LRvdUbnFmc948YKsu4nS5tbSFgCMx6x1lTj_5mSFKgP-A-rjCtr6AEmqLgp7MvMYz13WoIQYpxQp61A' \
      -H 'Content-Type: application/json' \
      -d '{
              "bufferSize": 320,
              "enableSpeechFinal": true,
              "endpointingInMilliSeconds": 300,
              "utteranceEndInMilliSeconds": 1000,
              "licenseKey": "aec2fabf8452c0bce659830246877d81c9d9095"
            }'

Header Parameter

Authorization - <Bearer

To learn more about Authorization, click here.

Path Parameter

Parameter Name	Data Type	Description	Required/ Optional
vrmId	String	ID of the Virtual Agent and Role combination	Required
langId	String	ID of the language	Required

Note

To obtain vrmId and langId, refer to the Fetch Virtual Agent Details API.

Query Parameter

Parameter Name	Data Type	Description	Required/ Optional
currentAsrProvider	String	Enter the name of the ASR provider. Currently, only Deepgram ASR is supported and it is therfore set as the default value.	Required

Request Parameter

Parameter Name	Data Type	Description	Required/ Optional
bufferSize	Number	The default value is set to 320, which represents the size of the packet sent to Deepgram ASR. Always use the given default value. Do not modify the value unless required.	Required
enableSpeechFinal	Boolean	If set to True, ends the transcription immediately once it detects the end of speech. The value is set to True by default. Always use the given default value. Do not modify the value unless required.	Required
endpointingInMilliSeconds	Number	Instructs Deepgram to treat 300 milliseconds of silence as the end of the user's speech. The value is set to 300 by default. Always use the given default value. Do not modify the value unless required.	Required
utteranceEndInMilliSeconds	Number	Defines the duration of silence (in milliseconds) required to consider that the user has finished speaking. The value is set to 1000 by default. If there is a 1000 millisecond pause in speech, Deepgram treats it as the end of the utterance. Always use the given default value. Do not modify the value unless required.	Required
licenseKey	String	License key of the ASR.	Required

Sample Request

{
  "bufferSize": 320,
  "enableSpeechFinal": true,
  "endpointingInMilliSeconds": 300,
  "utteranceEndInMilliSeconds": 1000,
  "licenseKey": "aec2fabf8452c0bce659830246877d81c9d9095"
}

Response and Error Codes

Response Code	Condition
200	OK
400	Bad Request
401	Unauthorized
500	Internal Server Error

In this section:

Uniphore Help Center Portal