Merge pull request #229917 from eric-urban/eur/custom-commands-notice

v-regandowner · web-flow · commit 381bcb35a15c · 2023-03-30T11:42:34.000-04:00
retire custom commands
diff --git a/articles/cognitive-services/.openpublishing.redirection.cognitive-services.json b/articles/cognitive-services/.openpublishing.redirection.cognitive-services.json
@@ -5315,6 +5315,11 @@
             "redirect_url": "/azure/cognitive-services/Speech-Service/overview",
             "redirect_document_id": false
         },
+        {
+            "source_path_from_root": "/articles/cognitive-services/Speech-Service/index-voice-assistants.yml",
+            "redirect_url": "/azure/cognitive-services/Speech-Service/voice-assistants",
+            "redirect_document_id": false
+        },
         {
             "source_path_from_root": "/articles/cognitive-services/Translator/collaborative-translation-framework-reporting-api.md",
             "redirect_url": "/azure/cognitive-services/translator/ctf-reporting",
diff --git a/articles/cognitive-services/Speech-Service/custom-commands-encryption-of-data-at-rest.md b/articles/cognitive-services/Speech-Service/custom-commands-encryption-of-data-at-rest.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Custom Commands encryption of data at rest
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 Custom Commands automatically encrypts your data when it is persisted to the cloud. The Custom Commands service encryption protects your data and to help you to meet your organizational security and compliance commitments.
 
 > [!NOTE]
diff --git a/articles/cognitive-services/Speech-Service/custom-commands-references.md b/articles/cognitive-services/Speech-Service/custom-commands-references.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Custom Commands concepts and definitions
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 This article serves as a reference for concepts and definitions for Custom Commands applications.
 
 ## Commands configuration
diff --git a/articles/cognitive-services/Speech-Service/custom-commands.md b/articles/cognitive-services/Speech-Service/custom-commands.md
@@ -15,11 +15,13 @@ ms.custom: cogserv-non-critical-speech
 
 # What is Custom Commands?
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 Applications such as [Voice assistants](voice-assistants.md) listen to users and take an action in response, often speaking back. They use [speech-to-text](speech-to-text.md) to transcribe the user's speech, then take action on the natural language understanding of the text. This action frequently includes spoken output from the assistant generated with [text-to-speech](text-to-speech.md). Devices connect to assistants with the Speech SDK's `DialogServiceConnector` object.
 
-**Custom Commands** makes it easy to build rich voice commanding apps optimized for voice-first interaction experiences. It provides a unified authoring experience, an automatic hosting model, and relatively lower complexity, helping you focus on building the best solution for your voice commanding scenarios.
+Custom Commands makes it easy to build rich voice commanding apps optimized for voice-first interaction experiences. It provides a unified authoring experience, an automatic hosting model, and relatively lower complexity, helping you focus on building the best solution for your voice commanding scenarios.
 
-Custom Commands is best suited for task completion or command-and-control scenarios, and well matched for Internet of Things (IoT) devices, ambient and headless devices. Examples include solutions for Hospitality, Retail and Automotive industries, where you want voice-controlled experiences for your guests, in-store inventory management or in-car functionality.
+Custom Commands is best suited for task completion or command-and-control scenarios such as "Turn on the overhead light" or "Make it 5 degrees warmer". Custom Commands is well suited for Internet of Things (IoT) devices, ambient and headless devices. Examples include solutions for Hospitality, Retail and Automotive industries, where you want voice-controlled experiences for your guests, in-store inventory management or in-car functionality.
 
 If you're interested in building complex conversational apps, you're encouraged to try the Bot Framework using the [Virtual Assistant Solution](/azure/bot-service/bot-builder-enterprise-template-overview). You can add voice to any bot framework bot using Direct Line Speech.
 
@@ -46,5 +48,5 @@ Once you're done with the quickstart, explore our how-to guides for detailed ste
 ## Next steps
 
 * [View our Voice Assistants repo on GitHub for samples](https://aka.ms/speech/cc-samples)
-* [Go to the Speech Studio to try out Custom Commands](https://speech.microsoft.com/customcommands)
+* [Go to the Speech Studio to try out Custom Commands](https://aka.ms/speechstudio/customcommands)
 * [Get the Speech SDK](speech-sdk.md)
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-debug-build-time.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-debug-build-time.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Debug errors when authoring a Custom Commands application
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 This article describes how to debug when you see errors while building Custom Commands application. 
 
 ## Errors when creating an application
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-debug-runtime.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-debug-runtime.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Troubleshoot a Custom Commands application at runtime
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 This article describes how to debug when you see errors while running Custom Commands application. 
 
 ## Connection failed
@@ -27,18 +29,18 @@ If your run Custom Commands application from [client application (with Speech SD
 | [1002](#error-1002) | The server returned status code '404' when status code '101' was expected. |
 
 ### Error 401
-- The region specified in client application does not match with the region of the custom command application
+- The region specified in client application doesn't match with the region of the custom command application
 
 - Speech resource Key is invalid
     
     Make sure your speech resource key is correct.
 
 ### Error 1002 
-- Your custom command application is not published
+- Your custom command application isn't published
     
     Publish your application in the portal.
 
-- Your custom command applicationId is not valid
+- Your custom command applicationId isn't valid
 
     Make sure your custom command application ID is correct.
  custom command application outside your speech resource
@@ -50,15 +52,15 @@ For more information on troubleshooting the connection issues, reference [Window
 
 ## Dialog is canceled
 
-When running your Custom Commands application, the dialog would be canceled when some errors occur.
+When your Custom Commands application is running, the dialog would be canceled when some errors occur.
 
-- If you are testing the application in the portal, it would directly display the cancellation description and play out an error earcon. 
+- If you're testing the application in the portal, it would directly display the cancellation description and play out an error earcon. 
 
-- If you are running the application with [Windows Voice Assistant Client](./how-to-custom-commands-developer-flow-test.md), it would play out an error earcon. You can find the **Event: CancelledDialog** under the **Activity Logs**.
+- If you're running the application with [Windows Voice Assistant Client](./how-to-custom-commands-developer-flow-test.md), it would play out an error earcon. You can find the **Event: CancelledDialog** under the **Activity Logs**.
 
-- If you are following our client application example [client application (with Speech SDK)](./how-to-custom-commands-setup-speech-sdk.md), it would play out an error earcon. You can find the **Event: CancelledDialog** under the **Status**.
+- If you're following our client application example [client application (with Speech SDK)](./how-to-custom-commands-setup-speech-sdk.md), it would play out an error earcon. You can find the **Event: CancelledDialog** under the **Status**.
 
-- If you are building your own client application, you can always design your desired logics to handle the CancelledDialog events.
+- If you're building your own client application, you can always design your desired logics to handle the CancelledDialog events.
 
 The CancelledDialog event consists of cancellation code and description, as listed below:
 
@@ -67,22 +69,22 @@ The CancelledDialog event consists of cancellation code and description, as list
 | [MaxTurnThresholdReached](#no-progress-was-made-after-the-max-number-of-turns-allowed) | No progress was made after the max number of turns allowed |
 | [RecognizerQuotaExceeded](#recognizer-usage-quota-exceeded) | Recognizer usage quota exceeded |
 | [RecognizerConnectionFailed](#connection-to-the-recognizer-failed) | Connection to the recognizer failed |
-| [RecognizerUnauthorized](#this-application-cannot-be-accessed-with-the-current-subscription) | This application cannot be accessed with the current subscription |
+| [RecognizerUnauthorized](#this-application-cant-be-accessed-with-the-current-subscription) | This application can't be accessed with the current subscription |
 | [RecognizerInputExceededAllowedLength](#input-exceeds-the-maximum-supported-length) | Input exceeds the maximum supported length for the recognizer |
 | [RecognizerNotFound](#recognizer-not-found) | Recognizer not found |
 | [RecognizerInvalidQuery](#invalid-query-for-the-recognizer) | Invalid query for the recognizer |
 | [RecognizerError](#recognizer-return-an-error) | Recognizer returns an error |
 
 ### No progress was made after the max number of turns allowed
-The dialog is canceled when a required slot is not successfully updated after certain number of turns. The build-in max number is 3.
+The dialog is canceled when a required slot isn't successfully updated after certain number of turns. The build-in max number is 3.
 
 ### Recognizer usage quota exceeded
 Language Understanding (LUIS) has limits on resource usage. Usually "Recognizer usage quota exceeded error" can be caused by: 
 - Your LUIS authoring exceeds the limit
 
     Add a prediction resource to your Custom Commands application: 
     1. go to **Settings**, LUIS resource
-    1. Choose a prediction resource from **Prediction resource**, or click **Create new resource** 
+    1. Choose a prediction resource from **Prediction resource**, or select **Create new resource** 
 
 - Your LUIS prediction resource exceeds the limit
 
@@ -93,8 +95,8 @@ For more details on LUIS resource limits, refer [Language Understanding resource
 ### Connection to the recognizer failed
 Usually it means transient connection failure to Language Understanding (LUIS) recognizer. Try it again and the issue should be resolved.
 
-### This application cannot be accessed with the current subscription
-Your subscription is not authorized to access the LUIS application. 
+### This application can't be accessed with the current subscription
+Your subscription isn't authorized to access the LUIS application. 
 
 ### Input exceeds the maximum supported length
 Your input has exceeded 500 characters. We only allow at most 500 characters for input utterance.
@@ -106,15 +108,15 @@ Your input has exceeded 500 characters. We only allow at most 500 characters for
 The LUIS recognizer returned an error when trying to recognize your input.
 
 ### Recognizer not found
-Cannot find the recognizer type specified in your custom commands dialog model. Currently, we only support [Language Understanding (LUIS) Recognizer](https://www.luis.ai/).
+Can't find the recognizer type specified in your custom commands dialog model. Currently, we only support [Language Understanding (LUIS) Recognizer](https://www.luis.ai/).
 
 ## Other common errors
 ### Unexpected response
 Unexpected responses may be caused multiple things. 
 A few checks to start with:
 - Yes/No Intents in example sentences
 
-    As we currently don't support Yes/No Intents except when using with confirmation feature. All the Yes/No Intents defined in example sentences would not be detected.
+    As we currently don't support Yes/No Intents except when using with confirmation feature. All the Yes/No Intents defined in example sentences wouldn't be detected.
 
 - Similar intents and examples sentences among commands
 
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-deploy-cicd.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-deploy-cicd.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Continuous Deployment with Azure DevOps
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this article, you learn how to set up continuous deployment for your Custom Commands applications. The scripts to support the CI/CD workflow are provided to you.
 
 ## Prerequisite
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-developer-flow-test.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-developer-flow-test.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Test your Custom Commands Application
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this article, you learn different approaches to testing a custom commands application.
 
 ## Test in the portal
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-send-activity-to-client.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-send-activity-to-client.md
@@ -16,6 +16,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Send Custom Commands activity to client application
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this article, you learn how to send activity from a Custom Commands application to a client application running the Speech SDK.
 
 You complete the following tasks:
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-setup-speech-sdk.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-setup-speech-sdk.md
@@ -16,6 +16,8 @@ ms.custom: cogserv-non-critical-speech, devx-track-csharp
 
 # Integrate with a client application using Speech SDK
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this article, you learn how to make requests to a published Custom Commands application from the Speech SDK running in an UWP application. In order to establish a connection to the Custom Commands application, you need:
 
 - Publish a Custom Commands application and get an application identifier (App ID)
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-setup-web-endpoints.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-setup-web-endpoints.md
@@ -16,7 +16,9 @@ ms.custom: cogserv-non-critical-speech
 
 # Set up web endpoints
 
-In this article, you will learn how to setup web endpoints in a Custom Commands application that allow you to make HTTP requests from a client application. You will complete the following tasks:
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
+In this article, you'll learn how to set up web endpoints in a Custom Commands application that allow you to make HTTP requests from a client application. You'll complete the following tasks:
 
 - Set up web endpoints in Custom Commands application
 - Call web endpoints in Custom Commands application
@@ -40,7 +42,7 @@ Alternatively, the next section provides details about a default hosted web endp
 
 ### Input format of Azure function
 
-Next, you will deploy an endpoint using [Azure Functions](../../azure-functions/index.yml).
+Next, you'll deploy an endpoint using [Azure Functions](../../azure-functions/index.yml).
 The following is the format of a Custom Commands event that is passed to your Azure function. Use this information when you're writing your Azure Function app.
 
 ```json
@@ -65,7 +67,7 @@ The following table describes the key attributes of this input:
         
 | Attribute | Explanation |
 | ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **conversationId** | The unique identifier of the conversation. Note that this ID can be generated by the client app. |
+| **conversationId** | The unique identifier of the conversation. Note this ID can be generated by the client app. |
 | **currentCommand** | The command that's currently active in the conversation. |
 | **name** | The name of the command. The `parameters` attribute is a map with the current values of the parameters. |
 | **currentGlobalParameters** | A map like `parameters`, but used for global parameters. |
@@ -126,7 +128,7 @@ This output should be written to an external storage, so that you can maintain t
 We provide a sample you can configure and deploy as an Azure Functions app. To create a storage account for our sample, follow these steps.
  
 1. Create table storage to save device state. In the Azure portal, create a new resource of type **Storage account** by name **devicestate**.
-1. Copy the **Connection string** value from **devicestate -> Access keys**. You will need to add this string secret to the downloaded sample Function App code.
+1. Copy the **Connection string** value from **devicestate -> Access keys**. You'll need to add this string secret to the downloaded sample Function App code.
 1. Download sample [Function App code](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/tree/main/custom-commands/quick-start).
 1. Open the downloaded solution in Visual Studio 2019. In **Connections.json**, replace **STORAGE_ACCOUNT_SECRET_CONNECTION_STRING** with the secret from Step 2.
 1.  Download the **DeviceStateAzureFunction** code.
@@ -141,10 +143,10 @@ To deploy the sample app to Azure Functions, follow these steps.
 ## Setup web endpoints in Custom Commands
 
 Let's hook up the Azure function with the existing Custom Commands application.
-In this section, you will use an existing default **DeviceState** endpoint. If you created your own web endpoint using Azure Function or otherwise, use that instead of the default	`https://webendpointexample.azurewebsites.net/api/DeviceState`.
+In this section, you'll use an existing default **DeviceState** endpoint. If you created your own web endpoint using Azure Function or otherwise, use that instead of the default	`https://webendpointexample.azurewebsites.net/api/DeviceState`.
 
 1. Open the Custom Commands application you previously created.
-1. Go to **Web endpoints**, click **New web endpoint**.
+1. Go to **Web endpoints**, select **New web endpoint**.
 
    > [!div class="mx-imgBorder"]
    > ![New web endpoint](media/custom-commands/setup-web-endpoint-new-endpoint.png)
@@ -255,7 +257,7 @@ Add the following XML to `MainPage.xaml` above the **EnableMicrophoneButton** bl
 
 ### Sync device state
 
-In `MainPage.xaml.cs`, add the reference `using Windows.Web.Http;`. Add the following code to the `MainPage` class. This method will send a GET request to the example endpoint, and extract the current device state for your app. Make sure to change `<your_app_name>` to what you used in the **header** in Custom Command web endpoint.
+In `MainPage.xaml.cs`, add the reference `using Windows.Web.Http;`. Add the following code to the `MainPage` class. This method sends a GET request to the example endpoint, and extract the current device state for your app. Make sure to change `<your_app_name>` to what you used in the **header** in Custom Command web endpoint.
 
 ```C#
 private async void SyncDeviceState_ButtonClicked(object sender, RoutedEventArgs e)
@@ -298,7 +300,7 @@ private async void SyncDeviceState_ButtonClicked(object sender, RoutedEventArgs
 ## Try it out
 
 1. Start the application.
-1. Click Sync Device State.\
+1. Select Sync Device State.\
 If you tested out the app with `turn on tv` in previous section, you would see the TV shows as **on**.
     > [!div class="mx-imgBorder"]
     > ![Sync device state](media/custom-commands/setup-web-endpoint-sync-device-state.png)
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-update-command-from-client.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-update-command-from-client.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Update a command from a client app
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this article, you'll learn how to update an ongoing command from a client application.
 
 ## Prerequisites
diff --git a/articles/cognitive-services/Speech-Service/how-to-custom-commands-update-command-from-web-endpoint.md b/articles/cognitive-services/Speech-Service/how-to-custom-commands-update-command-from-web-endpoint.md
@@ -15,6 +15,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Update a command from a web endpoint
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 If your client application requires an update to the state of an ongoing command without voice input, you can use a call to a web endpoint to update the command.
 
 In this article, you'll learn how to update an ongoing command from a web endpoint.
diff --git a/articles/cognitive-services/Speech-Service/how-to-develop-custom-commands-application.md b/articles/cognitive-services/Speech-Service/how-to-develop-custom-commands-application.md
@@ -16,6 +16,8 @@ ms.custom: cogserv-non-critical-speech
 
 # Develop Custom Commands applications
 
+[!INCLUDE [deprecation notice](./includes/custom-commands-retire.md)]
+
 In this how-to article, you learn how to develop and configure Custom Commands applications. The Custom Commands feature helps you build rich voice-command apps that are optimized for voice-first interaction experiences. The feature is best suited to task completion or command-and-control scenarios. It's particularly well suited for Internet of Things (IoT) devices and for ambient and headless devices.
 
 In this article, you create an application that can turn a TV on and off, set the temperature, and set an alarm. After you create these basic commands, you'll learn about the following options for customizing commands:
diff --git a/articles/cognitive-services/Speech-Service/includes/custom-commands-retire.md b/articles/cognitive-services/Speech-Service/includes/custom-commands-retire.md
diff --git a/articles/cognitive-services/Speech-Service/index-voice-assistants.yml b/articles/cognitive-services/Speech-Service/index-voice-assistants.yml
diff --git a/articles/cognitive-services/Speech-Service/media/voice-assistants/assistant-solution-comparison.png b/articles/cognitive-services/Speech-Service/media/voice-assistants/assistant-solution-comparison.png
diff --git a/articles/cognitive-services/Speech-Service/quickstart-custom-commands-application.md b/articles/cognitive-services/Speech-Service/quickstart-custom-commands-application.md
diff --git a/articles/cognitive-services/Speech-Service/toc.yml b/articles/cognitive-services/Speech-Service/toc.yml
diff --git a/articles/cognitive-services/Speech-Service/voice-assistants.md b/articles/cognitive-services/Speech-Service/voice-assistants.md
diff --git a/articles/cognitive-services/Speech-Service/windows-voice-assistants-faq.yml b/articles/cognitive-services/Speech-Service/windows-voice-assistants-faq.yml
