Skip to content

Commit ee75fed

Browse files
committed
Fixed PR warnings
1 parent 58542f0 commit ee75fed

7 files changed

+25
-21
lines changed

articles/cognitive-services/Speech-Service/how-to-windows-voice-assistants-get-started.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,17 @@ ms.topic: conceptual
1111
ms.date: 04/15/2020
1212
ms.author: travisw
1313
---
14-
## Overview
14+
# Getting started with voice assistants on Windows
1515

1616
This guide will take you through the steps to begin developing a voice assistant on Windows.
1717

1818
## Set up your development environment
19+
1920
To start developing a voice assistant for Windows, you will need to make sure you have the proper development environment.
21+
2022
- **Visual Studio:** You will need to install [Microsoft Visual Studio 2017](https://visualstudio.microsoft.com/), Community Edition or higher
2123
- **Windows version**: A PC with a Windows Insider fast ring build of Windows and the Windows Insider version of the Windows SDK. This sample code is verified as working on Windows Insider Release Build 19025.vb_release_analog.191112-1600 using Windows SDK 19018. Any Build or SDK above the specified versions should be compatible.
22-
- **UWP development tools**: The Universal Windows Platform development workload in Visual Studio. See the UWP [Get set up](https://docs.microsoft.com/en-us/windows/uwp/get-started/get-set-up) page to get your machine ready for developing UWP Applications.
24+
- **UWP development tools**: The Universal Windows Platform development workload in Visual Studio. See the UWP [Get set up](https://docs.microsoft.com/windows/uwp/get-started/get-set-up) page to get your machine ready for developing UWP Applications.
2325
- **A working microphone and audio output**
2426

2527
## Obtain resources from Microsoft
@@ -40,8 +42,8 @@ For a complete voice assistant experience, the application will need a dialog se
4042

4143
The following provides the requirements to create a simple dialog service using Direct Line Speech.
4244

43-
- **Speech Services subscription:** A subscription for Cognitive Speech Services for speech-to-text and text-to-speech conversions. Try Speech Services for free [here](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/get-started).
44-
- **Bot Framework bot:** A bot created using Bot Framework version 4.2 or above that's subscribed to to [Direct Line Speech](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/direct-line-speech) to enable voice input and output. [This guide](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/tutorial-voice-enable-your-bot-speech-sdk) contains step-by-step instructions to make a simple "echo bot" and subscribe it to Direct Line Speech. You can also go go [here](https://blog.botframework.com/2018/05/07/build-a-microsoft-bot-framework-bot-with-the-bot-builder-sdk-v4/) for steps on how to create a customized bot, then follow the same steps [here](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/tutorial-voice-enable-your-bot-speech-sdk) to subscribe it to Direct Line Speech, but with your new bot rather than the "echo bot".
45+
- **Speech Services subscription:** A subscription for Cognitive Speech Services for speech-to-text and text-to-speech conversions. Try Speech Services for free [here](https://docs.microsoft.com/azure/cognitive-services/speech-service/get-started).
46+
- **Bot Framework bot:** A bot created using Bot Framework version 4.2 or above that's subscribed to to [Direct Line Speech](https://docs.microsoft.com/azure/cognitive-services/speech-service/direct-line-speech) to enable voice input and output. [This guide](https://docs.microsoft.com/azure/cognitive-services/speech-service/tutorial-voice-enable-your-bot-speech-sdk) contains step-by-step instructions to make a simple "echo bot" and subscribe it to Direct Line Speech. You can also go go [here](https://blog.botframework.com/2018/05/07/build-a-microsoft-bot-framework-bot-with-the-bot-builder-sdk-v4/) for steps on how to create a customized bot, then follow the same steps [here](https://docs.microsoft.com/azure/cognitive-services/speech-service/tutorial-voice-enable-your-bot-speech-sdk) to subscribe it to Direct Line Speech, but with your new bot rather than the "echo bot".
4547

4648
## Try out the sample app
4749

articles/cognitive-services/Speech-Service/windows-voice-assistants-automatic-enablement-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Privacy guidelines for Windows Voice Assistants
33
titleSuffix: Azure Cognitive Services
44
description: The instructions to enable voice activation for a voice agent by default.
55
services: cognitive-services
6-
author: cofogg
6+
author: cfogg6
77
manager: trrwilson
88
ms.service: cognitive-services
99
ms.subservice: speech-service

articles/cognitive-services/Speech-Service/windows-voice-assistants-best-practices.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Voice assistants developed on Windows 10 must implement the user experience guid
1919

2020
## Contents
2121

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)
2828

2929
## Summary of voice activation views supported in Windows 10
3030

@@ -81,7 +81,7 @@ Available with 19H2, assistants built on Windows voice activation platform are a
8181
8282
### Customer opt-in
8383

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).
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#detecting-above-lock-activation-user-preference).
8585

8686
### Not a lock-screen replacement
8787

@@ -156,7 +156,7 @@ The Contoso assistant has a home on the taskbar: their swirling, circular icon.
156156

157157
![Screenshot of voice assistant on Windows replying in compact view](media/voice-assistants/windows_voice_assistant/compact_view_response.png)
158158

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.
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.
160160

161161
![Screenshots of voice assistant on Windows before and after expanding the compact view](media/voice-assistants/windows_voice_assistant/compact_transition.png)
162162

articles/cognitive-services/Speech-Service/windows-voice-assistants-implementation-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ MVA needs a microphone to be present and accessible to be able to detect a voice
2929

3030
### Register the application with the background service
3131

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).
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/windows/uwp/launch-resume/register-a-background-task).
3333

3434
### Unlock the Limited Access Feature
3535

@@ -99,7 +99,7 @@ When keyword verification succeeds, the application needs to move to the foregro
9999

100100
### Transition from compact view to full view
101101

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.md#design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
103103

104104
To make the transition from compact view to full app view, use the ApplicationView API `TryEnterViewModeAsync`:
105105

articles/cognitive-services/Speech-Service/windows-voice-assistants-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@ On Windows 10 version 2004 and up, voice assistant applications can take advanta
2929
## Getting Started
3030

3131
- **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-
- **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.
32+
- **Visit the Getting Started Guide:** Start [here](windows-voice-assistants-get-started.md) 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.md) page and follow the steps to get the sample client running.

articles/cognitive-services/Speech-Service/windows-voice-assistants-sample-info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The UWP Voice Assistant sample is a Windows Conversational Agent application tha
2626
The documentation provided with the sample app walks through the code path of voice activation and agent management, from the prerequisites of startup through proper cleanup.
2727

2828
## Links
29-
[The UWP Voice Assistant Sample](aka.ms/MVA/sample)
29+
[The UWP Voice Assistant Sample](https://aka.ms/MVA/sample)
3030

3131
[Readme with startup instructions](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/blob/master/clients/csharp-uwp/README.md)
3232

articles/cognitive-services/Speech-Service/windows-voice-assistants-voice-activation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ ms.date: 04/15/2020
1313
ms.author: travisw
1414
---
1515

16-
## Voice Activation
16+
# Voice Activation
1717

18-
Windows supports voice activation for UWP applications. The following is a walk-through of the voice activation system.
18+
## Walk through of voice activation
19+
20+
Windows supports voice activation for UWP applications. The following summarizes the steps of the voice activation process, including the steps an application must take to register as activatable by voice.
1921

2022
### Agent Activation Runtime
2123

@@ -25,7 +27,7 @@ The Agent Activation Runtime (AAR) is the ongoing process in Windows that manage
2527

2628
The first time a voice activated application is run, it registers its app id and keyword information in a global signal configuration mapping through the ConversationalAgent APIs. Keyword information includes the location of the keyword model file, the language the keyword is in, and an ID to assign to the keyword. AAR registers all configurations in the global mapping with the hardware or software keyword spotter on the system, allowing them to detect the application's keyword.
2729

28-
The application also [registers with the Background Service](https://docs.microsoft.com/en-us/windows/uwp/launch-resume/register-a-background-task), another process within Windows.
30+
The application also [registers with the Background Service](https://docs.microsoft.com/windows/uwp/launch-resume/register-a-background-task), another process within Windows.
2931

3032
Note that this means an application cannot be activated by voice until it has been run once and registration has been allowed to complete.
3133

0 commit comments

Comments
 (0)