Audiocodes: Advanced Configuration

Defines the language (e.g., "en-ZA" for South African English) of the voicebot conversation and is used for TTS and STT functionality. The value is obtained from the service provider.

Prevents the STT response from Audiocodes to include punctuation marks.

Note: This requires support from the STT engine

Defines the voice name for the TTS service.

Enables caching of TTS (audio) results from the Flow. Therefore, if Audiocodes needs to send a request for TTS to a TTS provider and this text has been requested before, it retrieves the result from its cache instead of requesting it again from the TTS provider.

Enables the sending of DTMF events to the Flow.

Note: For configuring the DTMF collection and sending method, see the dtmfCollect parameter.

Defines the DTMF digit collection and sending method.

Note:

Defines the timeout (in milliseconds) that Audiocodes waits for the user to press another digit before it sends all the digits to the Flow. If the timeout expires since the last digit entered by the user, Audiocodes sends all the collected digits to the Flow(as a DTMF message), without waiting for the maximum number of expected digits or for the "submit" digit. The timeout is triggered after the user enters the first DTMF digit and is reset after each digit.

The valid value range is 0 to unlimited. The default is 2000.

Defines the maximum number of DTMF digits that Audiocodes expects to receive from the user. Once Audiocodes receives and collects this number of digits entered by the user, it immediately sends all the digits to the Flow (as a DTMF message), without waiting for the timeout to expire or for the "submit" digit.

The valid value range is 0 (disabled) to unlimited. The default is 5. If configured to 0, the DTMF collection and sending method is according to dtmfCollectInterDigitTimeoutMS or dtmfCollectSubmitDigit.

Defines a special DTMF "submit" digit that when received from the user, Audiocodes immediately sends all the collected digits to the Flow (as a DTMF message), without waiting for the timeout to expire or for the maximum number of expected digits.

The valid value is any symbol on a phone keypad. The default is # (pound key). If you want to disable this parameter, configure it to "" (empty string).

Enables the Barge-In feature.

Enables the Barge-In on DTMF feature.

Note:

Defines the minimum number of words that the user must say for Audiocodes to consider it a barge-in. For example, if configured to 4 and the user only says 3 words during the bot's playback response, no barge-in occurs.

The valid range is 1 to 5. The default is 1.

Enable Continuous ASR

Enables the Continuous ASR feature. Continuous ASR enables Audiocodes to concatenate multiple STT recognitions of the user and then send them as a single textual message to the bot.

This parameter is applicable when the Continuous ASR feature is enabled.

Defines a special DTMF key, which if pressed, causes Audiocodes to immediately send the accumulated recognitions of the user to the Flow. For example, if configured to "#" and the user presses the pound key (#) on the phone's keypad, the device concatenates the accumulated recognitions and then sends them as one single textual message to the Flow.

The default is "#".

Note: Using this feature incurs an additional delay from the user’s perspective because the speech is not sent immediately to the Flow after it has been recognized. To overcome this delay, configure the parameter to a value that is appropriate to your environment.

This parameter is applicable when the Continuous ASR feature is enabled.

Defines the automatic speech recognition (ASR) timeout (in milliseconds). When the device detects silence from the user for a duration configured by this parameter, it concatenates all the accumulated STT recognitions and sends them as one single textual message to the Flow.

The valid value is 2,500 (i.e., 2.5 seconds) to 60,000 (i.e., 1 minute). The default is 3,000.

Defines the maximum time (in milliseconds) that Audiocodes waits for input from the user.

If no input is received when this timeout expires, you can configure Audiocodes to play a textual (see the "No User Input Prompt" parameter) or audio (see the "No User Input URL" parameter) prompt to ask the user to say something. If there is still no input from the user, you can configure Audiocodes to prompt the user again. The number of times to prompt is configured by the "No User Input Retries" parameter.

If the "Send No User Input Event" parameter is configured to "on" and the timeout expires, Audiocodes sends an event to Cognigy.AI, indicating how many times the timer has expired.

The default is 0 (i.e., feature disabled).

Note:

Defines the maximum number of allowed timeouts (configured by the "No User Input Timeout" parameter) for no user input. If you have configured a prompt to play (see the "No User Input Prompt" or "No User Input URL" parameter), the prompt is played each time the timeout expires.

The default is 0 (i.e., only one timeout).

For more information on the no user input feature, see the "No User Input Timeout" parameter.

Note: If you have configured a prompt to play upon timeout expiry, the timer is triggered only after playing the prompt to the user.

Enables Audiocodes to send an event message to the Flow if there is no user input for the duration configured by the "No User Input Timeout"parameter, indicating how many times the timer has expired ('value' field):

{"type": "event",
      "name": "noUserInput",
      "value": 1}

Defines the textual prompt to play to the user when no input has been received from the user when the timeout expires (configured by "No User Input Timeout").

The prompt can be configured in plain text or in Speech Synthesis Markup Language (SSML) format:

By default, the parameter is not configured.

{"name": "LondonTube",
      "provider": "my_azure",
      "displayName": "London Tube",
      "userNoInputTimeoutMS": 5000,
      "userNoInputSpeech":
        "Hi there. Please say something}

{"name": "LondonTube",
      "provider": "my_azure",
      "displayName": "London Tube",
      "userNoInputTimeoutMS": 5000,
      "userNoInputSpeech":
        <speak>
        "This is
        <say-as interpret-as="characters">
          SSML
        </say-as>
        "
        </speak>}

For more information on the no user input feature, see the "No User Input Timeout".

Note:

Defines the URL from where the audio prompt is played to the user when no input has been received from the user when the timeout expires (configured by "No User Input Timeout").

By default, the parameter is not configured.

For more information on the no user input feature, see the "No User Input Timeout".

Note: If you have also configured to play a textual prompt (see the "No User Input Prompt" parameter), the "No User Input Prompt" takes precedence.

Defines the maximum time (in milliseconds) that Audiocodes waits for input from the Flow.

If no input is received from the Flow when this timeout expires, you can configure Audiocodes to play a textual (see the "No Flow Input Prompt" parameter) or audio (see the "No Flow Input URL" parameter) prompt to the user.

The default is 0 (i.e., feature disabled).

Defines the maximum number of allowed timeouts (configured by the "No Flow Input Timeout" parameter) for Flow input. If you have configured a prompt to play (see the "No Flow Input Prompt" parameter) or audio (see the "No Flow Input URL" parameter), the prompt is played to the user each time the timeout expires.

The default is 0 (i.e., only one timeout – no retries).

For more information on the no flow input feature, see the "No Flow Input Timeout" parameter.

Note: If you have configured a prompt to play upon timeout expiry, the timer is triggered only after playing the prompt to the user.

Defines the textual prompt to play to the user when no input has been received from the Flows when the timeout expires (configured by "No Flow Input Timeout").

The prompt can be configured in plain text or in Speech Synthesis Markup Language (SSML) format:

{name": "LondonTube",
      "provider": "my_azure",
      "displayName": "London Tube",
      "botNoInputTimeoutMS": 5000,
      "botNoInputSpeech":
        "Please wait for bot input"}

{"name": "LondonTube",
      "provider": "my_azure",
      "displayName": "London Tube",
      "botNoInputTimeoutMS": 5000,
      "botNoInputSpeech":
        <speak>
        "This is
        <say-as interpret-as="characters">
          SSML
        </say-as>
        "
        </speak>}

By default, the parameter is not configured.

Note:

Defines the URL from where the audio prompt is played to the user when no input has been received from the Flow when the timeout expires (configured by "No Flow Input Timeout ").

By default, the parameter is not configured.

For more information on the no Flow input feature, see the "No Flow Input Timeout".

Note: If you have also configured to play a textual prompt (see the "No Flow Input Prompt" parameter), the "No Flow Input Prompt" takes precedence.

Defines the Azure STT recognition mode.

Note: The parameter is applicable only to the Microsoft Azure STT service.

Note:

Defines the customized synthetic voice model for Azure's text-to-speech Custom Neural Voice feature. Once you have deployed your custom text-to-speech endpoint on Azure, you can integrate it with Audiocodes using this parameter.

For more information on Azure's Custom Neural Voice feature, click here.

By default, this parameter is undefined.

Note:

• This parameter is applicable only to Azure.

Enables recording and logging of audio from the user (endpoint) that Audiocodes sends to the STT engine. The recording is done by the STT engine and stored on the STT engine.

When the parameter is not defined (default), audio logging is according to the STT engine.

Note: The parameter and audio logging is applicable only when using the Azure STT.

When using Google's Cloud STT engine, this parameter controls Speech Context phrases.

The parameter can list phrases or words that are passed to the STT engine as "hints" for improving the accuracy of speech recognition.

For more information on speech context (speech adaptation) as well details regarding tokens (class tokens) that can be used in phrases, go to https://cloud.google.com/speech-to-text/docs/speech-adaptation.

For example, whenever a speaker says "weather" frequently, you want the STT engine to transcribe it as "weather" and not "whether". To do this, the parameter can be used to create a context for this word (and other similar phrases associated with weather):

"sttContextPhrases": ["weather"]

Note:

Defines the boost number for context recognition of the speech context phrase configured by sttContextPhrases. Speech-adaptation boost allows you to increase the recognition model bias by assigning more weight to some phrases than others. For example, when users say "weather" or "whether", you may want the STT to recognize the word as weather.

For more information, see https://cloud.google.com/speech-to-text/docs/context-strength.  

Note: