Initialize a speech recognition session (.NET)

Procedure

When a user wants to initiate a speech recognition session via your app, do the following:

1. Use the static property Session.SharedSession to access the singleton session object.

2. Open the session: Call Open() on the shared session object to open the session. For example:

   Session.SharedSession.Open("<user ID>", "<your organization token>", "<your partner GUID>", "<your application name>")

   The user's speech profile is retrieved by the Dragon Medical SpeechKit infrastructure and a license check is performed.

   The organization token is an organization-wide revocable password and should be treated as such.

   Note

   Dragon Medical SpeechKit uses the user name for license verification and speech profile assignment. You can use your app's user login name for Dragon Medical SpeechKit but Dragon Medical SpeechKit doesn't provide any kind of user-specific password check and thus relies on your app for user authentication.

3. Use the Nuance.SpeechAnywhere.WindowsForms.VuiController or Nuance.SpeechAnywhere.WPF.VuiController class to activate speech recognition (see: Speech-enabling your app).

For future use: Authentication using Microsoft Entra ID

To open the session using an ID token issued by your Microsoft Entra tenant, use the authenticationToken parameter in addition to the Partner GUID, and application name:

Session.SharedSession.Open("your partner GUID>", "<your application name>", authenticationToken)

Call UpdateAuthenticationToken(authenticationToken) to update the authentication token for the session.

This authentication method is still in development; it requires additional updates to backend components before it can be used.

Important information

• User names and app names can have a maximum of 75 characters.

• The app name can't consist of only numbers.