DynamicTranslation - Scoped
-
- UpdatedJan 30, 2025
- 17 minutes to read
- Yokohama
- API reference
The DynamicTranslation API provides methods that translate text, in real time, into multiple languages using translation service providers.
In addition, you can use this API to detect the language of a specific string and check whether the DynamicTranslation methods are enabled for a translation service. Use this API to create a seamless localization experience for your user interface, enabling one interface to service multiple countries.
Currently this API supports two translation service providers: Microsoft Azure Translator Service and Google Cloud Translator Service. You can also configure other translation services within your instance and then use the DynamicTranslation API to translate your text.
When using these methods in a server-side script, use the sn_dt_api
namespace identifier. Before you are able to use this API, you must activate the DynamicTranslation (com.glide.dynamic_translation) plugin. For
information on this plugin and additional information on Dynamic Translation, refer to Dynamic translation overview.
DynamicTranslation - getDetectedLanguage(String text, Object parms)
Detects the language of the passed in text.
If you pass in a translator, the method uses that translation service to detect the source language. Otherwise, the detection is performed by the default translation service. Ensure that the text strings that you provide contain enough verbiage to enable proper language detection.
In addition to the detected language, the response contains a confidence level of the detection, along with other possible language alternatives. If a translator is not passed in, the method also returns the default translation service used to detect the language.
Name | Type | Description |
---|---|---|
text | String | Text to use to detect the language. |
parms | Object | Optional. JSON object that contains additional translation parameters. |
parms.translator | String | Optional. Translation service to use to translate the
text (not case-sensitive). Valid values:
Note: To use custom translation services you must first configure the translation
service in your instance. For details, see Integrate with a translation
service provider.
Default: Translation service configured in the Translator Configuration [sn_dt_translator_configuration] table. |
Example
This example shows code in a server-side script that detects a string in English using IBM's translation service.
Output:
Example
This example shows a server script that throws an error when an invalid translation service is passed in.
Output:
DynamicTranslation - getDetectedLanguages(Array texts, Object parms)
Detects the languages of the passed in text strings.
If you pass in a translator, the method uses that translation service to detect the source language. Otherwise, the detection is performed by the default translation service. Ensure that the text strings that you provide contain enough verbiage to enable proper language detection.
In addition to the detected language, the response contains a confidence level of the detection, along with other possible language alternatives. If a translator is not passed in, the method also returns the default translation service used to detect the language.
Name | Type | Description |
---|---|---|
texts | Array | List of text strings to use to detect the language(s). |
parms | Object | Optional. JSON object that contains additional translation parameters. |
parms.translator | String | Translation service to use to detect the language of a string. Translation services are configured under the Translator Configuration menu. Possible values - not case-sensitive:
Note: To use custom translation services you must first configure the translation service in your instance. For details, see Integrate with a translation service provider. Default: Translation service configured in the Translator Configuration [sn_dt_translator_configuration] table. Table: Translator Configuration [sn_dt_translator_configuration] |
Example
This example shows code in a server script that detects English as the language of the passed-in strings using the Microsoft translation service.
Output
Example
This example shows code in a server script that returns a Partial status when two text strings are passed in and one of them is invalid.
Output
Example
This example shows code in a server script that throws an error when an invalid translation service is passed in.
Output
DynamicTranslation - getTranslation(String textToTranslate, Object parms)
Translates the passed in text to one or more languages.
The method uses translation services, such as Microsoft Azure Translator Service and Google Cloud Translator Service, to perform the translation. If you do not pass in translation parameters, the method uses the system default.
Example
This example shows a server script translating plain text from English (detected) into French and Italian using Microsoft's translation service.
Response:
Example
This example shows a server script that throws an error when an invalid target language is passed in.
Response:
DynamicTranslation - getTranslations(Array texts, Object parms)
Translates the passed in text strings to one or more languages.
The method uses translation services, such as Microsoft Azure Translator Service and Google Cloud Translator Service, to perform the translation. If you do not pass in translation parameters, the method uses the system default.
Example
This example shows code in a server-side script that translates a list of text strings into French and Italian using the Microsoft translation service.
Response:
Example
This example shows a server script that returns a Partial status when one of the two passed in text strings is invalid.
Response:
Example
This example shows a server script that throws an error when an invalid translation service is passed in.
Response:
DynamicTranslation - isEnabled(String translator)
Determines whether the various methods in the DynamicTranslation API are enabled for a translation service.
If you pass in a specific translation service, the method checks the method activation for that translation service; otherwise the method checks the default translation service.
Name | Type | Description |
---|---|---|
translator | String | Optional. Translation service to use to verify whether the methods are active. Translation services are configured under the Translator Configuration menu. Possible values - not case-sensitive:
Note: To use custom translation services you must first configure the translation service in your instance. For details, see Integrate with a translation service provider. Default: Default translation service. |
Example
This example shows a server script that checks whether the DynamicTranslation methods are active for the Microsoft translator.
Output:
Example
This example shows a server script that throws an error when an invalid translation service is passed in.
Output:
On this page
- DynamicTranslation - getDetectedLanguage(String text, Object parms)
- DynamicTranslation - getDetectedLanguages(Array texts, Object parms)
- DynamicTranslation - getTranslation(String textToTranslate, Object parms)
- DynamicTranslation - getTranslations(Array texts, Object parms)
- DynamicTranslation - isEnabled(String translator)