Initialize Dragon Copilot SDK for JavaScript

To initialize the Dragon Copilot SDK, call DragonCopilotSDK.dragon.initialize with initialization options.

Prerequisites

• You've added the Dragon Copilot SDK to your page.

• You've registered event handlers for events that are raised when you initialize the SDK. For example, the list of connected microphones.

Initialization options

For detailed information on the data types used by the initialization options, see the API reference.

Examples

Minimal initialization

await DragonCopilotSDK.dragon.initialize({
  services: "us",
  authentication: {
    acquireAccessToken: acquireAccessTokenCallback,
  },
  partnerGuid: "MyPartnerGuid",
  applicationName: "MyApp",
});

Advanced initialization

await DragonCopilotSDK.dragon.initialize({
  applicationName: "Sample2",
  enableAll: true,
  partnerGuid: settings.partnerGuid,
  authentication: {
    acquireAccessToken: acquireAccessTokenCallback,
  },
  services: "us",
  speechOptions: {
      language: "en-US",
      topic: dragon.Topics.GeneralMedicine,
  },
  useConsoleLogger: false,
  isAmbientEnabled: false,
  isDictationEnabled: true,
  daxProductId: "",
  traceId: "",
  customControlOptions: {
      webCustomControlTypes: {
          lexicalControl,
      },
  },
  dispatchAllCommands: true,
  environmentId: "test-app",
  platformGuid: "",
  preferredMicrophone: {
      label: "",
  },
});

Initialization errors

The Dragon Copilot SDK can throw one of the following errors when you call DragonCopilotSDK.dragon.initialize():

See also

API reference