You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/how-to-windows-voice-assistants-get-started.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ To start developing a voice assistant for Windows, you will need to mak
24
24
25
25
## Obtain resources from Microsoft
26
26
27
-
Some resources necessary for a completely customized voice agent on Windows will require resources from Microsoft. The [UWP Voice Assistant Sample](windows-voice-assistants-sample-info) provides sample versions of these resources for initial development and testing, so this section is unnecessary for initial development.
27
+
Some resources necessary for a completely customized voice agent on Windows will require resources from Microsoft. The [UWP Voice Assistant Sample](windows-voice-assistants-sample-info.md) provides sample versions of these resources for initial development and testing, so this section is unnecessary for initial development.
28
28
29
29
-**Keyword model:** Voice activation requires a keyword model from Microsoft in the form of a .bin file. Note that the .bin file provided in the UWP Voice Assistant Sample is trained on the keyword "Contoso".
30
30
-**Limited Access Feature Token:** Since the ConversationalAgent APIs provide access to microphone audio, they are protected under Limited Access Feature restrictions. To use a Limited Access Feature, you will need to obtain a Limited Access Feature token connected to the package identity of your application from Microsoft.
@@ -45,7 +45,7 @@ The following provides the requirements to create a simple dialog service using
45
45
46
46
## Try out the sample app
47
47
48
-
With the subscription key from your Speech Services subscription and bot id from your echo bot, you are ready to try out the [UWP Voice Assistant sample](windows-voice-assistants-sample-info). Follow the instructions in the readme to run the app and enter your credentials.
48
+
With the subscription key from your Speech Services subscription and bot id from your echo bot, you are ready to try out the [UWP Voice Assistant sample](windows-voice-assistants-sample-info.md). Follow the instructions in the readme to run the app and enter your credentials.
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/windows-voice-assistants-best-practices.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,12 +19,12 @@ Voice assistants developed on Windows 10 must implement the user experience guid
19
19
20
20
## Contents
21
21
22
-
-[Summary of voice activation views supported in Windows 10](Summary-of-voice-activation-views-supported-in-Windows-10)
23
-
-[Requirements summary](Requirements-summary)
24
-
-[Best practices for good listening experiences](Best-practices-for-good-listening-experiences)
25
-
-[Design guidance for in-app voice activation](Design-guidance-for-in-app-voice-activation)
26
-
-[Design guidance for voice activation above lock](Design-guidance-for-voice-activation-above-lock)
27
-
-[Design guidance for voice activation preview](Design-guidance-for-voice-activation-preview)
22
+
-[Summary of voice activation views supported in Windows 10](summary-of-voice-activation-views-supported-in-windows-10)
23
+
-[Requirements summary](requirements-summary)
24
+
-[Best practices for good listening experiences](best-practices-for-good-listening-experiences)
25
+
-[Design guidance for in-app voice activation](design-guidance-for-in-app-voice-activation)
26
+
-[Design guidance for voice activation above lock](design-guidance-for-voice-activation-above-lock)
27
+
-[Design guidance for voice activation preview](design-guidance-for-voice-activation-preview)
28
28
29
29
## Summary of voice activation views supported in Windows 10
30
30
@@ -81,7 +81,7 @@ Available with 19H2, assistants built on Windows voice activation platform are a
81
81
82
82
### Customer opt-in
83
83
84
-
Voice activation above lock is always disabled by default. Customers opt-in through the Windows settings>Privacy>Voice Activation. For details on monitoring and prompting for this setting, see the [above lock implementation guide](windows-voice-assistants-implement-above-lock#Detect-user-preference).
84
+
Voice activation above lock is always disabled by default. Customers opt-in through the Windows settings>Privacy>Voice Activation. For details on monitoring and prompting for this setting, see the [above lock implementation guide](windows-voice-assistants-implementation-guide.md#detect-user-preference).
85
85
86
86
### Not a lock-screen replacement
87
87
@@ -105,7 +105,7 @@ The assistant must implement the dismissal guidance in this section to make it e
105
105
-**Pressing any key must also dismiss the assistant app**. Keyboard input is a traditional lock app signal that the customer wants to log-in, so any keyboard/text input should not be directed to the app. Instead, the app should self-dismiss when keyboard input is detected, so the customer can easily log-in to their device.
106
106
-**If the screen goes off, the app must self-dismiss.** This ensures that the next time the customer uses their PC, the log-in screen will be ready and waiting for them.
107
107
- If the app is "in use", it may continue above lock. "in use" constitutes any input or output. For example, when streaming music or video the app may continue above lock. "Follow on" and other multiturn dialog steps are permitted to keep the app above lock.
108
-
-**Implementation details on dismissing the application** can be found [in the above lock implementation guide](windows-voice-assistants-implement-above-lock#Closing-the-application).
108
+
-**Implementation details on dismissing the application** can be found [in the above lock implementation guide](windows-voice-assistants-implementation-guide.md#closing-the-application).
109
109
110
110

111
111
@@ -135,7 +135,7 @@ In order to further secure the experience, **weblinks or other app-to-app launch
135
135
136
136
Below lock, when the assistant app does _not_ have focus, Windows provides a less intrusive voice activation UI to help keep the customer in flow. This is especially true for the case of false activations which would be highly disruptive if they launched the full app. The core idea is that each assistant has another home in the Shell, the assistant taskbar icon. When the request for background activation occurs, a small view above the assistant taskbar icon appears. Assistants should provide a small listening experience in this canvas. After processing the requests, assistants can choose to resize this view to show an in-context answer or to hand off their main app view to show larger, more detailed visuals.
137
137
138
-
- In order to stay minimal, the preview does not have a title bar, so **the assistant must draw an X in the top right to allow customers to dismiss the view.** Refer to [Closing the Application](windows-voice-assistants-implement-above-lock#Closing-the-application) for the specific APIs to call when the dismiss button is pressed.
138
+
- In order to stay minimal, the preview does not have a title bar, so **the assistant must draw an X in the top right to allow customers to dismiss the view.** Refer to [Closing the Application](windows-voice-assistants-implementation-guide.md#closing-the-application) for the specific APIs to call when the dismiss button is pressed.
139
139
- To support voice activation previews, assistants may invite customers to pin the assistant to the taskbar during first run.
140
140
141
141
**Voice activation preview: Initial state**
@@ -156,7 +156,7 @@ The Contoso assistant has a home on the taskbar: their swirling, circular icon.
156
156
157
157

158
158
159
-
**Hand-off**. At any point, the assistant may handoff to its main app view to provide more information or answers or dialogue that require more screen real estate. Please refer to the [Transition from compact view to full view](windows-voice-assistants-implementation-guide#Transition-from-compact-view-to-full-view) section for implementation details.
159
+
**Hand-off**. At any point, the assistant may handoff to its main app view to provide more information or answers or dialogue that require more screen real estate. Please refer to the [Transition from compact view to full view](windows-voice-assistants-implementation-guide.md#Transition-from-compact-view-to-full-view) section for implementation details.
160
160
161
161

Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/windows-voice-assistants-faq.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ ms.author: travisw
21
21
22
22
## My app is showing in a small window when I activate it by voice. How can I transition from the compact view to a full application window?
23
23
24
-
When your application is first activated by voice, it is started in a compact view. Please read the [Design guidance for voice activation preview](windows-voice-assistants-best-practices#Design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
24
+
When your application is first activated by voice, it is started in a compact view. Please read the [Design guidance for voice activation preview](windows-voice-assistants-best-practices.md#design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
25
25
26
26
To make the transition from compact view to full app view, use the appView API `TryEnterViewModeAsync`:
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/windows-voice-assistants-implementation-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,21 +19,21 @@ This guide walks through important implementation details for creating a voice a
19
19
20
20
## Implementing voice activation
21
21
22
-
After [setting up your environment](how-to-windows-voice-assistants-get-started) and learning [how voice activation works](windows-voice-assistants-voice-activation), you can start implementing voice activation for your own voice assistant application.
22
+
After [setting up your environment](how-to-windows-voice-assistants-get-started.md) and learning [how voice activation works](windows-voice-assistants-voice-activation.md), you can start implementing voice activation for your own voice assistant application.
23
23
24
24
### Registration
25
25
26
26
#### Ensure that the microphone is available and accessible, then monitor its state
27
27
28
-
MVA needs a microphone to be present and accessible to be able to detect a voice activation. Use the [AppCapability](https://docs.microsoft.com/en-us/uwp/api/windows.security.authorization.appcapabilityaccess.appcapability?view=winrt-18362), [DeviceWatcher](https://docs.microsoft.com/en-us/uwp/api/windows.devices.enumeration.devicewatcher?view=winrt-18362), and [MediaCapture](https://docs.microsoft.com/en-us/uwp/api/windows.media.capture.mediacapture?view=winrt-18362) classes to check for microphone privacy access, device presence, and device status (like volume and mute) respectively.
28
+
MVA needs a microphone to be present and accessible to be able to detect a voice activation. Use the [AppCapability](https://docs.microsoft.com/uwp/api/windows.security.authorization.appcapabilityaccess.appcapability?view=winrt-18362), [DeviceWatcher](https://docs.microsoft.com/uwp/api/windows.devices.enumeration.devicewatcher?view=winrt-18362), and [MediaCapture](https://docs.microsoft.com/uwp/api/windows.media.capture.mediacapture?view=winrt-18362) classes to check for microphone privacy access, device presence, and device status (like volume and mute) respectively.
29
29
30
30
### Register the application with the background service
31
31
32
32
In order for MVA to launch the application in the background, the application needs to be registered with the Background Service. See a full guide for Background Service registration [here](https://docs.microsoft.com/en-us/windows/uwp/launch-resume/register-a-background-task).
33
33
34
34
### Unlock the Limited Access Feature
35
35
36
-
Use your Microsoft-provided Limited Access Feature key to unlock the voice assistant feature. Use the [LimitedAccessFeature](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.limitedaccessfeatures?view=winrt-18362) class from the Windows SDK to do this.
36
+
Use your Microsoft-provided Limited Access Feature key to unlock the voice assistant feature. Use the [LimitedAccessFeature](https://docs.microsoft.com/uwp/api/windows.applicationmodel.limitedaccessfeatures?view=winrt-18362) class from the Windows SDK to do this.
37
37
38
38
### Register the keyword for the application
39
39
@@ -82,7 +82,7 @@ Once a voice agent application is activated by voice, the next step is to verify
82
82
83
83
### Retrieve activation audio
84
84
85
-
Create an [AudioGraph](https://docs.microsoft.com/en-us/uwp/api/windows.media.audio.audiograph) and pass it to the `CreateAudioDeviceInputNodeAsync` of the `ConversationalAgentSession`. This will load the graph's audio buffer with the audio *starting approximately 3 seconds before the keyword was detected*. This additional leading audio is included to accommodate a wide range of keyword lengths and speaker speeds. Then, handle the [QuantumStarted](https://docs.microsoft.com/en-us/uwp/api/windows.media.audio.audiograph.quantumstarted?view=winrt-18362) event from the audio graph to retrieve the audio data.
85
+
Create an [AudioGraph](https://docs.microsoft.com/uwp/api/windows.media.audio.audiograph) and pass it to the `CreateAudioDeviceInputNodeAsync` of the `ConversationalAgentSession`. This will load the graph's audio buffer with the audio *starting approximately 3 seconds before the keyword was detected*. This additional leading audio is included to accommodate a wide range of keyword lengths and speaker speeds. Then, handle the [QuantumStarted](https://docs.microsoft.com/uwp/api/windows.media.audio.audiograph.quantumstarted?view=winrt-18362) event from the audio graph to retrieve the audio data.
@@ -99,7 +99,7 @@ When keyword verification succeeds, the application needs to move to the foregro
99
99
100
100
### Transition from compact view to full view
101
101
102
-
When your application is first activated by voice, it is started in a compact view. Please read the [Design guidance for voice activation preview](windows-voice-assistants-best-practices#Design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
102
+
When your application is first activated by voice, it is started in a compact view. Please read the [Design guidance for voice activation preview](windows-voice-assistants-best-practices#design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
103
103
104
104
To make the transition from compact view to full app view, use the ApplicationView API `TryEnterViewModeAsync`:
The following steps cover the requirements to enable a voice assistant on Windows to run above lock, including references to example code and guidelines for managing the application lifecycle. For guidance on designing above lock experiences, visit the [best practices guide](windows-voice-assistants-best-practices).
113
+
The following steps cover the requirements to enable a voice assistant on Windows to run above lock, including references to example code and guidelines for managing the application lifecycle. For guidance on designing above lock experiences, visit the [best practices guide](windows-voice-assistants-best-practices.md).
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/windows-voice-assistants-overview.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,6 @@ On Windows 10 version 2004 and up, voice assistant applications can take advanta
28
28
29
29
## Getting Started
30
30
31
-
-**Review the design guidelines:** Our [design guidelines](windows-voice-assistants-best-practices) lay out the key work required to provide the best possible experiences for voice activation on Windows 10.
31
+
-**Review the design guidelines:** Our [design guidelines](windows-voice-assistants-best-practices.md) lay out the key work required to provide the best possible experiences for voice activation on Windows 10.
32
32
-**Visit the Getting Started Guide:** Start [here](windows-voice-assistants-get-started) for the steps to begin implementing voice assistants on Windows, from setting your development environment through an introduction to the UWP Voice Assistant Sample.
33
-
-**Try out the sample app**: To experience these capabilities firsthand, visit the [UWP Voice Assistant Sample](windows-voice-assistants-sample-info) page and follow the steps to get the sample client running.
33
+
-**Try out the sample app**: To experience these capabilities firsthand, visit the [UWP Voice Assistant Sample](windows-voice-assistants-sample-info) page and follow the steps to get the sample client running.
Copy file name to clipboardExpand all lines: articles/cognitive-services/Speech-Service/windows-voice-assistants-voice-activation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,9 @@ AAR still signals active applications when their keyword is spoken. Rather than
51
51
52
52
## Voice Activation Example
53
53
54
-
For a walk through of example code that completes registration and handles voice activation and keyword verification, visit the [UWP Voice Assistant Sample App](windows-voice-assistants-sample-info).
54
+
For a walk through of example code that completes registration and handles voice activation and keyword verification, visit the [UWP Voice Assistant Sample App](windows-voice-assistants-sample-info.md).
55
55
56
56
## Next steps
57
57
58
58
> [!div class="nextstepaction"]
59
-
> [Learn how to implement a voice assistant on Windows](windows-voice-assistants-implementation-guide.md)
59
+
> [Learn how to implement a voice assistant on Windows](windows-voice-assistants-implementation-guide.md)
0 commit comments