DeepL Translator
Description
DeepL is a machine translation service. The OMN integration works together with DeepL via an API.
On the one hand, DeepL offers a free translator with some limited features, such as translate up to 5,000 characters, translate three locked documents per month and use 10 glossary entries.
On the other hand, the Pro version can be subscribed for a fee so that users can use some extra features, for example to translate all from entire documents to web pages, images and emails.
To use the DeepL translator in the OMN context, a paid DeepL API Pro subscription must be purchased.
All information about DeepL API Pro can be found here.
Supported languages
The list of supported languages is the following:
Bulgarian, Chinese (both traditional and simplified), Czech, Danish, Dutch, English (American and British), Estonian, Finnish, French,
German, Greek, Hungarian, Indonesian, Italian, Japanese, Korean, Latvian, Lithuanian, Norwegian (Bokmål), Polish, Portuguese, Romanian, Russian, Slovak, Slovenian, Spanish, Swedish, Turkish, Ukrainian
All languages can be seen on this page.
| The languages can be adapted by the providers, which may result in discrepancies between the page and the languages actually supported. |
| As this Workflow uses write operations to PIM attributes via REST API, the OMN user executing this Workflow needs to be in an admin role. API admin roles are configured in property 'omn.eai.api.admin.roles' in EAI Properties |
Configuration Parameters
Workflow-Name: ai-translation
General parameters
| Key (* = required) | Type | Default | Description | Example |
|---|---|---|---|---|
ext.ai-translation.translationService* |
string |
Name of the AI translation service which should be used ('deepl', 'ms', 'google' or 'systran') |
deepl |
|
ext.ai-translation.attributes |
string (multi) |
List of attribute identifiers which should be translated (per default all language dependant attributes are translated) |
"Artikelnummer, Farbe" |
|
ext.ai-translation.sourceLanguages |
language (multi) |
required |
List of content source languages which should be translated |
English, German |
ext.ai-translation.targetLanguages |
language (multi) |
required |
List of content target languages which should be translated to |
French, Japanese |
|
string (multi) |
"en-US", "pt-PT" |
List of culture names that are used as country override for the specific language. Deprecated: Use the DeepL specific source- and targetLanguageTagMappings parameters (see also DeepL specific parameters). |
"en-GB", "pt-BZ" |
DeepL specific parameters
| Key (* = required) | Type | Default | Description | Example |
|---|---|---|---|---|
ext.ai-translation.deepl.apiUrl* |
string |
Base URL of the deepl translation service |
||
ext.ai-translation.deepl.apiKey* |
string |
API Key for the deepl translation service |
||
ext.ai-translation.deepl.sourceLanguageTagMappings |
string |
The mappings from language tags to the DeepL Source Languages. The language tag is constructed from the *_omnSourceLanguage and its configured ISO language and country code. For example 'German (Switzerland)' with a configured ISO language code of 'ch' and a country code of 'CH' will be translated to the language tag 'ch-CH', which then could be mapped to DeepL Source Language "DE" by using "ch-CH:DE". Multiple mappings need to be comma separated. There should usually be no need to set this parameter with another mapping. See also General Language Mapping. Note that the ".putAll", ".removeAllKeys" feature is not yet available here. By default no mappings are provided and the uppercase ISO language code will be used as DeepL Source Language. |
us-EN:EN,ch-CH:DE |
|
ext.ai-translation.deepl.targetLanguageTagMappings |
string |
The mappings from language tags to the DeepL Target Languages. The language tag is constructed from the *omnTargetLanguage and its configured ISO language and country code. For example 'English' with a configured ISO language code of 'en' and a country code of 'EN' will be translated to the language tag 'en-EN', which is mapped to DeepL Target Language 'EN-US' by default for backward compatibility reasons. To override that to "EN-GB" specify the mapping "en-EN:EN-GB" here. See also General Language Mapping. Note that the ".putAll", ".removeAllKeys" feature is not yet available here. By default no mappings are provided and the uppercase ISO language code will be used as DeepL Target Language. In case the OMN ISO Language Code is "en" then "en-US" will be used as DeepL Target Language, as mentioned above. The same for "pt" which will use "pt-PT" as default DeepL Target Language. This property should be used to control dialects instead of _ext.ai-translation.targetCultureOverrides. If both are configured then the Language Tag Mappings take precedence. |
en-EN:EN-GB,ch-CH:DE |
Example configuration
The following image shows what a sample configuration for DeepL Translator might look like.
A detailed step-by-step guide to the configuration of the Workflow Config Function plug-in can be found on this page.
Support
For questions users can directly contact the DeepL Help Center.