Skip to navigation

Language Settings (MLS)

View as Markdown

assistant.mls

Language/translation settings.

  • Endpoint: /assistant/mls | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/assistant/mlsGet language settings
PATCH/assistant/mlsUpdate language settings

Fields

FieldTypeRequiredNotes
installed_localesarray<string>Core languages installed for the organization, such as EN_US or FR_CA. Managed with the Moveworks MLS Operations team and cannot be changed through this API.
pending_translation_localesarray<string>Languages requested for human translation, used only in the Moveworks Classic experience. Managed with the Moveworks MLS Operations team and cannot be changed through this API.
machine_translation_localesarray<string>Languages enabled through machine translation. They are instantly available in both the Moveworks Classic and AI Assistant experiences.
default_dm_localestringDefault non-English response language for all users. Leave blank for English. Must be an installed locale and cannot be changed through this API.
multi_languages_enabledstringMoveworks DSL rule for which users get multilingual support. Use ‘true’ to enable for all users.
ticket_translation_enabledstringMoveworks DSL rule for which users get translation of ticket filing and ticket comments.
use_ingested_user_default_localebooleanIf true, a user’s preferred language from your ingested user records is used instead of the organization-wide default response language.
display_record_translation_enabledbooleanIf true, field values in display records such as ticket notifications and people cards are translated.
translation_override_configsarray<TranslationOverrideConfig>Custom translations that replace the machine translation of specific source strings.
disable_translation_configsarray<MLSDisableTranslationConfig>Keywords after which text is not translated, per machine translation source.
locale_prompt_override_configsarray<MLSLocalePromptOverrideConfig>Custom gender and formality instructions for specific locales.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"installed_locales": [],
"pending_translation_locales": [],
"machine_translation_locales": [],
"default_dm_locale": "EN_US",
"multi_languages_enabled": "<string>",
"ticket_translation_enabled": "<string>",
"use_ingested_user_default_locale": true,
"display_record_translation_enabled": true
}