Create or Update ASR Properties for a Language

Creates or updates properties of classic ASR and context ASR for a given language.

Endpoint

Method: PUT

URL: https://uselfserve-<tenant-name>.uniphore.com/cse/connector/asrProperty/{language}

curl -X PUT "http://localhost:port/connector/asrProperty/English-US" 
	-H "accept: text/plain" 
	-H "Authorization: Bearer <token>" 
	-H "Content-Type: application/json" 
	-d "{ 
              "url": "wss://hostname:port",
              "contenderUrl": "wss://hostname:port/en-us",
              "considerOnlyFinal": true,
              "bufferSize": 8160,
              "passThreshold": 0,
              "failThreshold": 0,
              "worldLevelThreshold": 0,
              "wordPassPercentage": 0,
              "contextAsrUrl": "wss://hostname:port",
              "contextAsrConsiderOnlyFinal": true,
              "contextAsrBufferSize": 8160,
              "contextAsrPassThreshold": 0,
              "contextAsrFailThreshold": 0,
              "contextAsrWorldLevelThreshold": 0,
              "contextAsrWordPassPercentage": 0
           }"

Warning

Do not change any Parameter Value when a call is in progress.

Header Parameter

Authorization - Bearer <Token>

Path Parameter

Path Parameter Name	Data Type	Description	Required/ Optional
language	String	Language for which ASR properties need to be created or updated.	Required

Request Parameter

Request Parameter Name	Data Type	Description	Required/ Optional
`url`	String	The classic ASR URL of the language.	Required
`contenderUrl`	String	The additional ASR URL of the language. The ASR traffic can be divided between the `url` and `contenderUrl` based on the given percentage.	Optional.
`bufferSize`	Number	The default value is 4076 which represents the size of the packet to be sent to classic ASR. Always use the given default value. Do not modify the value unless required.	Required
`considerOnlyFinal`	String	Discards the partial transcripts sent by classic ASR and uses the final transcript only. To enable the feature, the value is set to true by default. Do not modify the value.	Required
`failThreshold`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. If the over all confidence returned by classic ASR for a turn is less than the given value then the transcription is discarded.	Required
`passThreshold`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. If the over all confidence returned by classic ASR for a turn is more than or equal to the given value then the transcription is processed.	Required
`wordLevelThreshold`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. `wordLevelThreshold` is used to calculate wordPassPercentage. The Threshold percentage returned by the classicASR for each word in a turn.	Required
`wordPassPercentage`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. `wordPassPercentage` is calculated based on the number of words with the confidence higher than the `wordLevelThreshold`. Example: (Number of of words with the confidence higher than `wordLevelThreshold`/Total number of words from classic ASR) * 100. Total number of words returned by classic ASR is 10. Number of of words with the confidence higher than `wordLevelThreshold` is 7. The `wordPassPercentage` is 70%.	Required
`contextAsrUrl`	String	The context ASR URL of the language.	Required
`contextAsrBufferSize`	Number	The default value is 4076 which represents the size of the packet to be sent to context ASR. Always use the given default value. Do not modify the value unless required.	Required
`contextAsrConsiderOnlyFinal`	String	Discards the partial transcripts sent by context ASR and uses the final transcript only. To enable the feature, the value is set to True by default. Do not modify the value.	Required
`contextAsrFailThreshold`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. When the over all confidence returned by context ASR for a turn is less than the given value, the transcription is discarded.	Required
`contextAsrPassThreshold`	Number	Enter the default value 0.5. Do not modify the default value unless required. When the over all confidence returned by context ASR for a turn is more than or equal to the given value, the transcription is processed.	Required
`contextAsrWordLevelThreshold`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. `contextAsrWordLevelThreshold` is used to calculate wordPassPercentage. The Threshold percentage returned by the context ASR for each word in a turn.	Required
`contextAsrWordPassPercentage`	Number	Enter the default value 0 (zero). Do not modify the default value unless required. `contextAsrwordPassPercentage` is calculated based on the number of words with the confidence higher than the `contextAsrwordLevelThreshold`. Example: (Number of of words with the confidence higher than `contextAsrPassThreshold`/Total number of words returned by context ASR) * 100. Total number of words returned by context ASR is 10. Number of of words with the confidence higher than `contextAsrwordLevelThreshold` is 8. The `contextAwordPassPercentage` is 80%.	Required

Response and Error Codes

Response Code	Condition
200	OK
401	Unauthorized
403	Forbidden
500	Internal Sample Error

Note

With the error codes, a summary containing the reason for failure is provided.

In this section:

Uniphore Customer Portal