Voice Gateway Parameter Details - Cognigy Documentation
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Parameters
Synthesizer (TTS)
The Text-To-Speech (TTS) settings can be chosen from a pre-filled dropdown for Microsoft Azure, AWS, Google, Nuance, or a custom vendor.
| Parameter | Type | Description |
|---|---|---|
| TTS Vendor | Dropdown | Defines the TTS vendor. You can select a custom vendor. The Default option’s behavior… |
| Custom (Vendor) | CognigyScript | Allows for specifying a TTS Vendor, which isn’t in the dropdown list… |
| TTS Language | Dropdown | Defines the language of the Voice AI Agent output. |
| Custom (Language) | CognigyScript | Allows for choosing a TTS language, which isn’t in the dropdown list… |
| TTS Voice | Dropdown | Defines the voice that should be used for the voice AI Agent output. |
| Custom (Voice) | CognigyScript | Allows for choosing a TTS voice, which isn’t in the dropdown list… |
| TTS Label | CognigyScript | The alternative name of the vendor… |
| Enable Advanced TTS Config | Toggle | Enables the addition of a URL for an Azure Custom Voice Endpoint. |
| Disable TTS Audio Caching | Toggle | Disables TTS audio caching… |
Recognizer (STT)
The Speech-To-Text (STT) settings can be chosen from a pre-filled dropdown for supported vendors, or you can select a custom vendor.
| Parameter | Type | Description |
|---|---|---|
| STT Vendor | Dropdown | Defines the STT vendor. You can select a custom vendor… |
| STT Language | Dropdown | Select the desired STT Language… |
| Custom (Vendor) | CognigyScript | Allows for specifying an STT Vendor… |
| STT Language | Dropdown | Defines the language that should be recognized. |
| Custom (Language) | CognigyScript | Allows for choosing an STT language, which isn’t in the dropdown list… |
| Deepgram Model | Dropdown | This parameter is active only if Deepgram is selected… |
| Endpointing | Toggle | This parameter is active only if Deepgram or Deepgram Flux is selected… |
| Endpointing Time | Number | This parameter is active only when Deepgram is selected… |
| Smart Formatting | Toggle | This parameter is active only if Deepgram is selected… |
| End of Turn Threshold | Slider | This parameter is active only if Deepgram Flux is selected… |
| End of Turn Timeout in Milliseconds | Number | This parameter is active only if Deepgram Flux is selected… |
| STT Hints | Text | Array of words or phrases to assist speech detection. |
| Dynamic Hints | CognigyScript | Uses context or input for adding array hints… |
| STT Label | CognigyScript | The alternative name of the vendor… |
| Google Model | Dropdown | This parameter is active only when Google is selected… |
| Enable Voice Activity Detection | Toggle | Delays connection to cloud recognizer until the speech is detected. |
| VAD Sensitivity | Slider | Detection sensitivity, the lowest value has the highest sensitivity. |
| Minimal Voice Duration | Slider | Milliseconds of speech activity required before connecting to the cloud recognizer. |
| Disable STT Punctuation | Toggle | This parameter appears only when Google, Deepgram, or Deepgram Flux is selected… |
| Enable Advanced TTS Config | Toggle | Enables the addition of an ID for an Azure’s Custom Speech model deployment. |
| Profanity Filter | Dropdown | Defines how offensive, inappropriate… |
| Enable Audio Logging | Toggle | Enables recording and logging of audio… |
| Recognize Language | Toggle | Enables the addition of alternative languages for recognition.. |
Barge In
Barge In is a feature that allows the caller to interrupt the voice AI Agent by using speech input or DTMF digits during the entire call.
| Parameter | Type | Description |
|---|---|---|
| Barge In On Speech | Toggle | Enables interrupting the voice AI Agent with speech… |
| Barge In On DTMF | Toggle | Enables interrupting the voice AI Agent with DTMF digits… |
| Barge In Minimum Words | Slider | Defines the minimum number of words that the user must say… |
User Input Timeout
This feature defines what should happen when there is no input from the user.
| Parameter | Type | Description |
|---|---|---|
| Enable User No Input Timeout | Toggle | Enables or disables the User No Input Timeout parameter. |
| User No Input Mode | Dropdown | This parameter is active only when Enable User No Input Timeout is enabled. |
| User No Input Timeout | Number | This parameter is active only when Enable User No Input Timeout is enabled. |
| User No Input Retries | Number | This parameter is active only when Enable User No Input Timeout is enabled… |
Flow Input Timeout
This feature is designed for use cases where response delays occur in a Flow…
| Parameter | Type | Description |
|---|---|---|
| Enable Flow No Input Timeout | Toggle | This parameter is disabled by default… |
| Flow No Input Mode | Dropdown | This parameter is active only when Enable Flow No Input Timeout is enabled. |
| Flow No Input URL | URL | This parameter is active only when the Play option… |
| Flow No Input Speech | CognigyScript | This parameter is active only when the Speak option… |
| Flow No Input Timeout | Number | This parameter is active only when Enable Flow No Input Timeout is enabled… |
| Flow No Input Retries | Number | This parameter is active only when Enable Flow No Input Timeout is enabled… |
| AI Agent Fails on Error | Toggle | This parameter is disabled by default… |
DTMF
Enables DTMF collection..
| Parameter | Type | Description |
|---|---|---|
| Capture DTMF signals | Toggle | Enables capturing DTMF signals by the AI Agent. |
| DTMF Inter Digit Timeout | Number | Defines the timeout between collected DTMF digits. |
| DTMF Max Digits | Number | Defines the maximum number of digits the user can enter. |
| DTMF Min Digits | Number | Defines the minimum number of digits before they are forwarded to the AI Agent. |
| DTMF Submit Digit | CognigyScript | Defines the DTMF submit digit… |
Continuous ASR
Continuous ASR enables the Voice Gateway to concatenate multiple STT recognitions.
| Parameter | Type | Description |
|---|---|---|
| Enable Continuous ASR | Toggle | Enable or disable Continuous ASR. |
| Continuous ASR Submit Digit | CognigyScript | Defines a special DTMF key… |
| Continuous ASR Timeout | Number | Defines the number of milliseconds of silence before… |
Atmosphere Sounds
This feature is useful in scenarios where users interact with an AI Agent…
| Parameter | Type | Description |
|---|---|---|
| Action | Dropdown | Selects an action to play, silence, or remove the track… |
| URL | Text | Accepts URL links to MP3 tracks… |
| Loop | Toggle | Turns on looping for the audio track. |
| Volume | Number | Adjusts the volume of the track… |
Silence Overlay
Silence Overlay enables you to play an MP3 file…
| Parameter | Type | Description |
|---|---|---|
| Action | Dropdown | Defines an action to play or remove the track… |
| URL | Text | Accepts URL links to an MP3 track… |
| Delay for starting the Silence Overlay | Number | Defines the wait time before the MP3 track plays… |
Advanced
| Parameter | Type | Description |
|---|---|---|
| Additional Session Parameters | JSON | Allows for configuring settings using JSON... |
List of Additional Session Parameters
| Feature | Parameter | Description | Type | Example |
|---|---|---|---|---|
| User Input Timeout | user |
The User Input Timeout feature. | Object | - |
noInputMode |
The mode when no input is detected… | String | "speech" |
|
noInputTimeout |
The timeout duration for no input… | Number | 5000 |