The Translation module establishes methods for the machine translation of text, HTML and various Orbita objects through Google Translate.

Dependencies

The Translation module is dependent on the following modules:

• Project Context

• Utilities

• Error Handling

Methods

translateText

Translates the input text from the source language to the target language.

Parameters:

• input (string): The text to translate

• sourceLanguage (string): The language code of the input language (ex. “en”, “es”, “de”)

• targetLanguage (string): The language code of language to translate to (ex. “en”, “es”, “de”)

Returns: A promise that will be resolved when Google Translate has responded to the translation request. The resolved value will be the raw response from Google Translate.

translateHTML

Translates the input HTML from the source language to the target language.

Parameters:

• input (string): The HTML string to translate

• sourceLanguage (string): The language code of the input language (ex. “en”, “es”, “de”)

• targetLanguage (string): The language code of language to translate to (ex. “en”, “es”, “de”)

Returns: A promise that will be resolved when Google Translate has responded to the translation request. The resolved value will be the raw response from Google Translate.

translateAdaptiveCard

Translates any recognized labels in the adaptive card.

Parameters:

• input (object): The adaptive card JSON to translate. Assumes the presence of a property, “labels” in the adaptive card template data, each property value in “labels” will be translated as a string using translateText.

• sourceLanguage (string): The language code of the input language (ex. “en”, “es”, “de”)

• targetLanguage (string): The language code of language to translate to (ex. “en”, “es”, “de”)

Returns: A promise that will be resolved when Google Translate has responded to the translation request. The resolved value will be the adaptive card JSON with any labels translated.

translateMultiagent

Translates relevant portions of an Orbita multiagent object.

Parameters:

• input (object): The multiagent JSON to translate. Assumes a standard Orbita multiagent object.

• sourceLanguage (string): The language code of the input language (ex. “en”, “es”, “de”)

• targetLanguage (string): The language code of language to translate to (ex. “en”, “es”, “de”)

Returns: A promise that will be resolved when Google Translate has responded to the translation request. The resolved value will be the multiagent JSON with voice response, chat response and buttons translated.

translateOrbitaPayload

Translates relevant portions of an Orbita payload object.

Parameters:

• input (object): The Orbita payload object to translate. Assumes a standard Orbita payload object. Supported directives for translation are button directives and adaptive cards.

• sourceLanguage (string): The language code of the input language (ex. “en”, “es”, “de”)

• targetLanguage (string): The language code of language to translate to (ex. “en”, “es”, “de”)

Returns: A promise that will be resolved when Google Translate has responded to the translation request. The resolved value will be the Orbita payload JSON with multiagent and directives (button and adaptive cards only) translated.

detectLanguage

Detects the user’s language from the “accept-language” header of the request.

Parameters:

• msg (object): The Node-RED message object for an Orbita request.

Returns: The highest priority language from the “accept-language” header that is a supported language for machine translation. If there are no matches, the default language is returned.

Constants

The Translation module also exposes the following constants:

LANGUAGE_CODES

• AFRIKAANS: "af"

• ALBANIAN: "sq"

• AMHARIC: "am"

• ARABIC: "ar"

• ARMENIAN: "hy"

• ASSAMESE: "as"

• AYMARA: "ay"

• AZERBAIJANI: "az"

• BAMBARA: "bm"

• BASQUE: "eu"

• BELARUSIAN: "be"

• BENGALI: "bn"

• BHOJPURI: "bho"

• BOSNIAN: "bs"

• BULGARIAN: "bg"

• CATALAN: "ca"

• CEBUANO: "ceb"

• CHINESE_SIMPLIFIED: "zh-CN"

• CHINESE_TRADITIONAL: "zh-TW"

• CORSICAN: "co"

• CROATIAN: "hr"

• CZECH: "cs"

• DANISH: "da"

• DHIVEHI: "dv"

• DOGRI: "doi"

• DUTCH: "nl"

• ENGLISH: "en"

• ESPERANTO: "eo"

• ESTONIAN: "et"

• EWE: "ee"

• FILIPINO: "fil"

• FINNISH: "fi"

• FRENCH: "fr"

• FRISIAN: "fy"

• GALICIAN: "gl"

• GEORGIAN: "ka"

• GERMAN: "de"

• GREEK: "el"

• GUARANI: "gn"

• GUJARATI: "gu"

• HAITIAN_CREOLE: "ht"

• HAUSA: "ha"

• HAWAIIAN: "haw"

• HEBREW: "he"

• HINDI: "hi"

• HMONG: "hmn"

• HUNGARIAN: "hu"

• ICELANDIC: "is"

• IGBO: "ig"

• ILOCANO: "ilo"

• INDONESIAN: "id"

• IRISH: "ga"

• ITALIAN: "it"

• JAPANESE: "ja"

• JAVANESE: "jv"

• KANNADA: "kn"

• KAZAKH: "kk"

• KHMER: "km"

• KINYARWANDA: "rw"

• KONKANI: "gom"

• KOREAN: "ko"

• KRIO: "kri"

• KURDISH: "ku"

• SORANI: "ckb"

• KYRGYZ: "ky"

• LAO: "lo"

• LATIN: "la"

• LATVIAN: "lv"

• LINGALA: "ln"

• LITHUANIAN: "lt"

• LUGANDA: "lg"

• LUXEMBOURGISH: "lb"

• MACEDONIAN: "mk"

• MAITHILI: "mai"

• MALAGASY: "mg"

• MALAY: "ms"

• MALAYALAM: "ml"

• MALTESE: "mt"

• MAORI: "mi"

• MARATHI: "mr"

• MEITEILON: "mni-Mtei"

• MIZO: "lus"

• MONGOLIAN: "mn"

• MYANMAR: "my"

• NEPALI: "ne"

• NORWEGIAN: "no"

• NYANJA: "ny"

• ODIA: "or"

• OROMO: "om"

• PASHTO: "ps"

• PERSIAN: "fa"

• POLISH: "pl"

• PORTUGUESE: "pt"

• PUNJABI: "pa"

• QUECHUA: "qu"

• ROMANIAN: "ro"

• RUSSIAN: "ru"

• SAMOAN: "sm"

• SANSKRIT: "sa"

• SCOTS_GAELIC: "gd"

• SEPEDI: "nso"

• SERBIAN: "sr"

• SESOTHO: "st"

• SHONA: "sn"

• SINDHI: "sd"

• SINHALA: "si"

• SLOVAK: "sk"

• SLOVENIAN: "sl"

• SOMALI: "so"

• SPANISH: "es"

• SUNDANESE: "su"

• SWAHILI: "sw"

• SWEDISH: "sv"

• TAGALOG: "tl"

• TAJIK: "tg"

• TAMIL: "ta"

• TATAR: "tt"

• TELUGU: "te"

• THAI: "th"

• TIGRINYA: "ti"

• TSONGA: "ts"

• TURKISH: "tr"

• TURKMEN: "tk"

• TWI: "ak"

• UKRAINIAN: "uk"

• URDU: "ur"

• UYGHUR: "ug"

• UZBEK: "uz"

• VIETNAMESE: "vi"

• WELSH: "cy"

• XHOSA: "xh"

• YIDDISH: "yi"

• YORUBA: "yo"

• ZULU: "zu"

DEFAULT_LANGUAGE

LANGUAGE_CODES.ENGLISH