Add a Machine Translation Provider
- In the left-side menu of the Project, go to Manage > Settings.
- In the Translation settings section, select one of the following providers and configure the settings:
- Microsoft Translator
- Google Cloud Translation
- DeepL Translate Pro
| Setting | Description |
|---|---|
| Translation Provider API Key | Enter your unique API key provided by Microsoft Translator. It’s necessary for authentication and allows you to access translation services. |
| Request Retries | Enter how often Cognigy.AI should attempt to call the translation provider if an error occurs during the initial request. For example, if you set it to 3, Cognigy.AI tries three times before giving up on a translation request. |
| Request Timeout | Enter how long Cognigy.AI should wait for a response from the translation provider after making a request, in milliseconds. If the provider doesn’t respond within this time frame, it’s considered a timeout. |
| Sentence Cache Expiry Timeout | Enter how long translations should be kept in the cache before they are considered outdated and removed. The default value is 84,600 seconds, which corresponds to 1 day. For no caching, set it to 0. |
| Custom API Base URL | This setting is optional. If you have specific requirements or need to connect to a custom instance of the Microsoft Translator API different from the default one https://api.cognitive.microsofttranslator.com/, you can use this field to specify a custom base URL. It allows you to define the URL, including the protocol scheme, for example https://api-eur.cognitive.microsofttranslator.com, to tailor the API connection to your needs. |
| Custom Subscription Region | This setting is optional. It represents the location or region of your Azure AI Translator resource. You may need to use this field when calling this API, especially if you have specified a specific region in your Azure account. |
| Setting | Description |
|---|---|
| Translation Provider API Key | Enter your unique API key provided by Google Cloud Translation. It’s necessary for authentication and allows you to access translation services. |
| Request Retries | Enter how often Cognigy.AI should attempt to call the translation provider if an error occurs during the initial request. For example, if you set it to 3, Cognigy.AI tries three times before giving up on a translation request. |
| Request Timeout | Enter how long Cognigy.AI should wait for a response from the translation provider after making a request, in milliseconds. If the provider doesn’t respond within this time frame, it’s considered a timeout. |
| Sentence Cache Expiry Timeout | Enter how long translations should be kept in the cache before they are considered outdated and removed. The default value is 84,600 seconds, which corresponds to 1 day. For no caching, set it to 0. |
| Setting | Description |
|---|---|
| Translation Provider API Key | Enter your unique API key provided by DeepL Translate Pro. It’s necessary for authentication and allows you to access translation services. |
| Request Retries | Enter how often Cognigy.AI should attempt to call the translation provider if an error occurs during the initial request. For example, if you set it to 3, Cognigy.AI tries three times before giving up on a translation request. |
| Request Timeout | Enter how long Cognigy.AI should wait for a response from the translation provider after making a request, measured in milliseconds. If the provider doesn’t respond within this time frame, it’s considered a timeout. |
| Sentence Cache Expiry Timeout | Enter how long translations should be kept in the cache before they are considered outdated and removed. The default value is 84,600 seconds, which corresponds to 1 day. For no caching, set it to 0. |
| Custom API Base URL | This setting is optional. If you have specific requirements or need to connect to a custom instance of the DeepL Translate Pro API, you can use this field to specify a custom base URL. It allows you to define the URL, including the protocol scheme, for example https://api-free.deepl.com/, to tailor the API connection to your needs. |
- Click Save.
Real-Time Translation Settings
Updated in 4.63| Parameter | Description | Providers |
|---|---|---|
| Enable Translation | Activate real-time translation for the Endpoint. | Microsoft, Google, DeepL Translate Pro |
| User Input Language | Select the language of the user input or the Auto-Detect option. This option detects the language of the user automatically in their first messages. | Microsoft, Google, DeepL Translate Pro |
| Flow Language | Select the AI Agent’s language. | Microsoft, Google, DeepL Translate Pro |
| Set user input language on execution count | This setting applies if you’ve selected the Auto-Detect option in the User Input Language list. Set the number of user inputs the AI Agent uses to determine the language of the user. After this number of user inputs, the AI Agent stops trying to detect the user language. | Microsoft, Google, DeepL Translate Pro |
| Glossary ID Output | Enter the glossary ID for the AI Agent’s output translations. To ensure that the translations work correctly, the source and target languages of the glossary must match the selected language in the Flow Language and User Input Language fields. | DeepL Translate Pro |
| Glossary ID Input | Enter the glossary ID for user input translations. To ensure that the glossary works correctly, the source and target languages of the glossary must match the selected language in the Flow Language and User Input Language fields. If you’ve selected Auto-Detect in the User Input Language field, the glossary isn’t used for input translations. | DeepL Translate Pro |
| Formality | Select the level of formality for the translated text. This setting applies only to the following target languages:
| DeepL Translate Pro |
| No-Translation Marker | Enter the marker for excluding text segments from translation. Any text enclosed in the no-translation marker isn’t translated. By default, the no-translation marker is **. In this case, if you enter, for example, Willkommen, **Moin**! in the Text field of a Say Node and the detected user language is English, the AI Agent outputs Welcome, Moin! to the user. Moin isn’t translated as Good Morning. This setting can be useful, for example, to avoid translating product and brand names. | Microsoft, Google, DeepL Translate Pro |
| Always remove No-Translation Markers | When you activate this setting, the AI Agent always removes the no-translation markers before outputting any text, even if you deactivate real-time translation. | Microsoft, Google, DeepL Translate Pro |
| Prevent payloads from being translated | When you activate this setting, user inputs received via payload aren’t translated. | Microsoft, Google, DeepL Translate Pro |