Merge pull request #108338 from trrwilson/user/travisw/migrate-voice-assistant-to-pivots

Move voice assistant quickstarts into common pivot pattern

Author: v-albemi

.openpublishing.redirection.json

@@ -50325,6 +50325,18 @@
         "source_path": "articles/sql-data-warehouse/what-is-a-data-warehouse-unit-dwu-cdwu.md",
         "redirect_url": "/azure/synapse-analytics/sql-data-warehouse/what-is-a-data-warehouse-unit-dwu-cdwu",
         "redirect_document_id": true
+    },
+    {
+      "source_path": "articles/cognitive-services/speech-service/quickstart-voice-assistant-java-android.md",
+      "redirect_url": "/azure/cognitive-services/speech-service/quickstarts/voice-assistants?pivots=programming-language-java&tabs=android"
+    },
+    {
+      "source_path": "articles/cognitive-services/speech-service/quickstart-voice-assistant-java-jre.md",
+      "redirect_url": "/azure/cognitive-services/speech-service/quickstarts/voice-assistants?pivots=programming-language-java&tabs=jre"
+    },
+    {
+      "source_path": "articles/cognitive-services/Speech-Service/quickstart-voice-assistant-csharp-uwp.md",
+      "redirect_url": "/azure/cognitive-services/speech-service/quickstarts/voice-assistants?pivots=programming-language-csharp&tabs=uwp"
     }
   ]
 }

articles/cognitive-services/Speech-Service/includes/quickstarts/quickstart-list.md

@@ -5,3 +5,4 @@
 - [Quickstart: Synthesize text to an audio device](~/articles/cognitive-services/speech-service/quickstarts/text-to-speech.md)
 - [Quickstart: Synthesize text to a file](~/articles/cognitive-services/speech-service/quickstarts/text-to-speech-audio-file.md)
 - [Quickstart: Recognize Intents](~/articles/cognitive-services/speech-service/quickstarts/intent-recognition.md)
+- [Quickstart: Create a custom voice assistant](~/articles/cognitive-services/speech-service/quickstarts/voice-assistants.md)

articles/cognitive-services/Speech-Service/includes/quickstarts/voice-assistants/csharp/csharp.md

@@ -0,0 +1,16 @@
+---
+title: "Quickstart: Create a custom voice assistant, C# - Speech service"
+titleSuffix: Azure Cognitive Services
+services: cognitive-services
+author: trrwilson
+manager: nitinme
+ms.service: cognitive-services
+ms.subservice: speech-service
+ms.topic: include
+ms.date: 03/20/2020
+ms.author: travisw
+---
+
+[!INCLUDE [uwp](./uwp.md)]
+
+***

articles/cognitive-services/Speech-Service/includes/quickstarts/voice-assistants/csharp/footer.md

@@ -0,0 +1,15 @@
+---
+title: "Quickstart: Create a custom voice assistant, C# - Speech service"
+titleSuffix: Azure Cognitive Services
+services: cognitive-services
+author: trrwilson
+manager: nitinme
+ms.service: cognitive-services
+ms.subservice: speech-service
+ms.topic: include
+ms.date: 03/20/2020
+ms.author: travisw
+---
+
+> [!div class="nextstepaction"]
+> [Explore C# samples on GitHub](https://aka.ms/speech/github-csharp)

articles/cognitive-services/Speech-Service/includes/quickstarts/voice-assistants/csharp/header.md

@@ -0,0 +1,14 @@
+---
+title: "Quickstart: Create a custom voice assistant, C# - Speech service"
+titleSuffix: Azure Cognitive Services
+services: cognitive-services
+author: trrwilson
+manager: nitinme
+ms.service: cognitive-services
+ms.subservice: speech-service
+ms.topic: include
+ms.date: 03/20/2020
+ms.author: travisw
+---
+
+If you prefer to jump right in, view or download all [Speech SDK C# Samples](https://aka.ms/speech/github-csharp) on GitHub. Otherwise, let's get started.

articles/cognitive-services/Speech-Service/quickstart-voice-assistant-csharp-uwp.md renamed to articles/cognitive-services/Speech-Service/includes/quickstarts/voice-assistants/csharp/uwp.md

@@ -1,56 +1,35 @@
 ---
-title: 'Quickstart: Custom voice assistant, C# (UWP) - Speech service'
-titleSuffix: Azure Cognitive Services
-description: In this article, you create a C# Universal Windows Platform (UWP) application by using the Cognitive Services Speech Software Development Kit (SDK). You connect your client application to a previously created Bot Framework bot configured to use the Direct Line Speech channel. The application is built with the Speech SDK NuGet Package and Microsoft Visual Studio 2019.
-services: cognitive-services
-author: IEvangelist
-manager: nitinme
+author: trrwilson
 ms.service: cognitive-services
-ms.subservice: speech-service
-ms.topic: quickstart
-ms.date: 02/10/2020
-ms.author: dapine
+ms.topic: include
+ms.date: 03/20/2020
+ms.author: travisw
 ---
 
-# Quickstart: Create a voice assistant with the Speech SDK, UWP
-
-Quickstarts are also available for [speech recognition](~/articles/cognitive-services/Speech-Service/quickstarts/speech-to-text-from-microphone.md?pivots=programming-language-csharp&tabs=uwp), [speech synthesis](~/articles/cognitive-services/Speech-Service/quickstarts/text-to-speech.md?pivots=programming-language-csharp&tabs=uwp), and [speech translation](~/articles/cognitive-services/Speech-Service/quickstarts/translate-speech-to-text.md?pivots=programming-language-csharp&tabs=uwp).
-
-In this article, you'll develop a C# Universal Windows Platform (UWP) application using the [Speech SDK](speech-sdk.md). The program will connect to a previously authored and configured bot to enable a voice assistant experience from the client application. The application is built with the [Speech SDK NuGet Package](https://aka.ms/csspeech/nuget) and Microsoft Visual Studio 2019 (any edition).
-
-> [!NOTE]
-> The Universal Windows Platform lets you develop apps that run on any device that supports Windows 10, including PCs, Xbox, Surface Hub, and other devices.
-
 ## Prerequisites
 
-This quickstart requires:
-
-* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/).
-* An Azure subscription key for the Speech service. [Get one for free](get-started.md) or create it on the [Azure portal](https://portal.azure.com).
-* A previously created bot configured with the [Direct Line Speech channel](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-directlinespeech).
+Before you get started, make sure to:
 
+> [!div class="checklist"]
+> * [Create an Azure Speech resource](~/articles/cognitive-services/speech-service/get-started.md)
+> * [Set up your development environment and create an empty project](~/articles/cognitive-services/speech-service/quickstarts/setup-platform.md?tabs=uwp)
+> * Create a bot connected to the [Direct Line Speech channel](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-directlinespeech)
+> * Make sure that you have access to a microphone for audio capture
+> 
   > [!NOTE]
-  > Please refer to [the list of supported regions for voice assistants](regions.md#voice-assistants) and ensure your resources are deployed in one of those regions.
+  > Please refer to [the list of supported regions for voice assistants](~/articles/cognitive-services/speech-service/regions.md#voice-assistants) and ensure your resources are deployed in one of those regions.
 
-## Optional: Get started fast
+## Open your project in Visual Studio
 
-This quickstart will describe, step by step, how to make a client application to connect to your speech-enabled bot. If you prefer to dive right in, the complete, ready-to-compile source code used in this quickstart is available in the [Speech SDK Samples](https://aka.ms/csspeech/samples) under the `quickstart` folder.
+The first step is to make sure that you have your project open in Visual Studio.
 
-## Create a Visual Studio project
+## Start with some boilerplate code
 
-[!INCLUDE [](../../../includes/cognitive-services-speech-service-quickstart-uwp-create-proj.md)]
-
-## Add sample code
-
-Now add the XAML code that defines the user interface of the application, and add the C# code-behind implementation.
-
-### XAML code
-
-First, you'll create the application's user interface by adding the XAML code:
+Let's add some code that works as a skeleton for our project.
 
 1. In **Solution Explorer**, open `MainPage.xaml`.
 
-1. In the designer's XAML view, replace the entire contents with the following code snippet:
+1. In the designer's XAML view, replace the entire contents with the following snippet that defines a rudimentary user interface:
 
     ```xml
     <Page
@@ -99,9 +78,7 @@ First, you'll create the application's user interface by adding the XAML code:
 
 The Design view is updated to show the application's user interface.
 
-### C# code-behind source
-
-Then you add the code-behind source so that the application works as expected. The code-behind source includes:
+1. In **Solution Explorer**, open the code-behind source file `MainPage.xaml.cs`. (It's grouped under `MainPage.xaml`.) Replace the contents of this file with the below, which includes:
 
 - `using` statements for the `Speech` and `Speech.Dialog` namespaces
 - A simple implementation to ensure microphone access, wired to a button handler
@@ -110,12 +87,6 @@ Then you add the code-behind source so that the application works as expected. T
 - A helper to play back text-to-speech (without streaming support)
 - An empty button handler to start listening that will be populated later
 
-To add the code-behind source, follow these steps:
-
-1. In **Solution Explorer**, open the code-behind source file `MainPage.xaml.cs`. (It's grouped under `MainPage.xaml`.)
-
-1. Replace the file's contents with the following code snippet:
-
     ```csharp
     using Microsoft.CognitiveServices.Speech;
     using Microsoft.CognitiveServices.Speech.Audio;
@@ -283,7 +254,6 @@ To add the code-behind source, follow these steps:
         }
     }
     ```
-
 1. Add the following code snippet to the method body of `InitializeDialogServiceConnector`. This code creates the `DialogServiceConnector` with your subscription information.
 
     ```csharp
@@ -298,12 +268,12 @@ To add the code-behind source, follow these steps:
     ```
 
    > [!NOTE]
-   > Please refer to [the list of supported regions for voice assistants](regions.md#voice-assistants) and ensure your resources are deployed in one of those regions.
+   > Please refer to [the list of supported regions for voice assistants](~/articles/cognitive-services/speech-service/regions.md#voice-assistants) and ensure your resources are deployed in one of those regions.
 
    > [!NOTE]
-   > For information on configuring your bot and retrieving a channel secret, see the Bot Framework documentation for [the Direct Line Speech channel](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-directlinespeech).
+   > For information on configuring your bot, see the Bot Framework documentation for [the Direct Line Speech channel](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-directlinespeech).
 
-1. Replace the strings `YourChannelSecret`, `YourSpeechSubscriptionKey`, and `YourServiceRegion` with your own values for your bot, speech subscription, and [region](regions.md).
+1. Replace the strings `YourSpeechSubscriptionKey` and `YourServiceRegion` with your own values for your speech subscription and [region](~/articles/cognitive-services/speech-service/regions.md).
 
 1. Append the following code snippet to the end of the method body of `InitializeDialogServiceConnector`. This code sets up handlers for events relied on by `DialogServiceConnector` to communicate its bot activities, speech recognition results, and other information.
 
@@ -388,36 +358,23 @@ To add the code-behind source, follow these steps:
         NotifyUser($"Exception: {ex.ToString()}", NotifyType.ErrorMessage);
     }
     ```
+    
+## Build and run your app
 
-1. From the menu bar, choose **File** > **Save All** to save your changes.
-
-## Build and run the application
-
-Now you are ready to build and test your application.
+Now you're ready to build your app and test your custom voice assistant using the Speech service.
 
 1. From the menu bar, choose **Build** > **Build Solution** to build the application. The code should compile without errors now.
 
 1. Choose **Debug** > **Start Debugging** (or press **F5**) to start the application. The **helloworld** window appears.
 
-   ![Sample UWP voice assistant application in C# - quickstart](media/sdk/qs-voice-assistant-uwp-helloworld-window.png)
+   ![Sample UWP voice assistant application in C# - quickstart](~/articles/cognitive-services/Speech-Service/media/sdk/qs-voice-assistant-uwp-helloworld-window.png)
 
 1. Select **Enable Microphone**, and when the access permission request pops up, select **Yes**.
 
-   ![Microphone access permission request](media/sdk/qs-csharp-uwp-10-access-prompt.png)
+   ![Microphone access permission request](~/articles/cognitive-services/Speech-Service/media/sdk/qs-csharp-uwp-10-access-prompt.png)
 
 1. Select **Talk to your bot**, and speak an English phrase or sentence into your device's microphone. Your speech is transmitted to the Direct Line Speech channel and transcribed to text, which appears in the window.
-<!--
-    ![Successful bot response](media/voice-assistants/quickstart-cs-uwp-bot-successful-turn.png)
--->
-## Next steps
 
-> [!div class="nextstepaction"]
-> [Create and deploy a basic bot](https://docs.microsoft.com/azure/bot-service/bot-builder-tutorial-basic-deploy?view=azure-bot-service-4.0)
-
-## See also
+## Next steps
 
-- [About voice assistants](voice-assistants.md)
-- [Get a Speech service subscription key for free](get-started.md)
-- [Custom keywords](speech-devices-sdk-create-kws.md)
-- [Connect Direct Line Speech to your bot](https://docs.microsoft.com/azure/bot-service/bot-service-channel-connect-directlinespeech)
-- [Explore C# samples on GitHub](https://aka.ms/csspeech/samples)
+[!INCLUDE [footer](./footer.md)]

articles/cognitive-services/Speech-Service/includes/quickstarts/voice-assistants/header.md

@@ -0,0 +1,21 @@
+---
+title: 'Quickstart: Create a custom voice assistant - Speech service'
+titleSuffix: Azure Cognitive Services
+services: cognitive-services
+author: trrwilson
+manager: nitinme
+ms.service: cognitive-services
+ms.subservice: speech-service
+ms.topic: include
+ms.date: 03/20/2020
+ms.author: travisw
+---
+
+In this quickstart, you will use the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) to create a custom voice assistant application that connects to a bot that you have already authored and configured. If you need to create a bot, see [the related tutorial](~/articles/cognitive-services/speech-service/tutorial-voice-enable-your-bot-speech-sdk.md) for a more comprehensive guide.
+
+After satisfying a few prerequisites, connecting your custom voice assistant takes only a few steps:
+> [!div class="checklist"]
+> * Create a `BotFrameworkConfig` object from your subscription key and region.
+> * Create a `DialogServiceConnector` object using the `BotFrameworkConfig` object from above.
+> * Using the `DialogServiceConnector` object, start the listening process for a single utterance.
+> * Inspect the `ActivityReceivedEventArgs` returned.