Reference14r2:Concept App Service Translations

FIXME: This product is in the beta phase and is not yet finished

Applies To

• innovaphone from version 14r2

Overview

The idea of the translations App is to provide an interface for other Apps to translate user content on-the-fly. So other apps can integrate the translation service via the local JavaScript API in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. Currently, deepl.com is supported as a backend. (This means that you need your own deepl.com account and can configure your API key in the PBX Manager for this app service).

deepl.com

Privacy

https://www.deepl.com/de/privacy#section_5

Cost model

Pay per character (To save costs, the app service offers a cache to avoid multiple translations)

Licensing

FIXME: tbd

Installation

Go to the PBX manager and open the "AP app installer" plugin. On the right panel, the App Store will be shown. Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"

• In the search field located on the top right corner of the store, search for "Translations" and click on it
• Select the proper firmware version, here "v14" and click on install
• Tick "I accept the terms of use" and continue by clicking on the install yellow button
• Wait until the install has been finished
• Close and open the PBX manager to refresh the list of the available colored AP plugin
• Click on the "AP Translations" and click on " + Add an App"
• Enter a "Name" that is used as display name (all character allowed) for it and the "SIP" name that is the administrative field (no space, no capital letters). e.g : Name: Translations, SIP: translations
• Tick the appropriate template to distribute the App
• Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

Translation - Client

There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

Translation - App Service

The App Service performs tasks in the following areas:

• Speech recognition
• Caching
• Translations against the backend (deepl.com)

Speech recognition

An API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented).

Caching

To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

Translations against the backend

Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

Troubleshooting

To troubleshoot this App Service, you need the traceflags App, Database, HTTP-Client in your App instance.

Related Articles

• SDK Documentation - Translation API
• Reference14r2:Apps/PbxManager/App_Translations