Share via


Select a language

DAX Copilot defines encounter locales as follows:

  • Recording locales: The languages spoken in a recording. This is set per recording. The default is en-US.

  • Encounter report locale: The language of the AI-generated report. This is set once when a new encounter is created and is the same for all sessions in the encounter. The default is en-US.

  • UX locale: The user interface language. This is set once when a new encounter is created and is the same for all sessions in the encounter. The default is en-US.

Format for locale identifiers

The identifier for a locale is an ALPHA-2 ISO 639 language code followed by a hyphen and an ALPHA-2 ISO 3166-1 country code. For example: en-US, es-US. You can define locales using identifiers as follows:

let unitedStatesSpanish = Locale(identifier: "es-US")
let unitedStatesEnglish = Locale(identifier: "en-US")

Retrieving supported languages

The didReceiveSupportedLanguages() callback on the DAXKitDelegate retrieves supported languages for the audio recording and the AI-generated report.

func didReceiveSupportedLanguages(recordingLocales: [Locale], reportLocales: [Locale])

Called to inform the integration about supported languages for recording and for the AI-generated report. The values passed to this callback can be supplied to the DAX.shared.session() and DAXSession.startRecording() functions.

Parameters

  • recordingLocales - a list of locales supported for recording audio.
  • reportLocales - a list of locales supported for the AI-generated report.

Important

 If the didReceiveSupportedLanguages() callback retrieves an empty list of recording locales, the client should not set the recording language, but instead leave it empty and let Dragon Copilot use its own defaults. This is important in case there are per-user or per-organization language settings, where we can't pick a reasonable default.

Specifying languages for a session

The DAX.shared.session() function includes optional reportLocale and uxLocale parameters. We default these parameters to nil so they can be omitted at the call site for backward compatibility. If either parameter isn't specified, Dragon Copilot assumes the language is en-US.

Specifying the language for a recording

The DAXSession.startRecording() function includes an optional locales parameter. We default this to an empty list [] so it can be omitted at the call site for backward compatibility. If the locale isn't specified, DAXKit assumes the language is en-US. Currently, if there are multiple locales in the list, Dragon Copilot only uses the first one.