Skip to content

Commit f2d3519

Browse files
authored
Merge pull request #115536 from v-albemi/2-speech-service-articles
edit pass: 2 speech service articles
2 parents de345b6 + 588e019 commit f2d3519

File tree

2 files changed

+127
-118
lines changed

2 files changed

+127
-118
lines changed
Lines changed: 64 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: 'Quickstart: Create a Custom Command (Preview) - Speech service'
2+
title: 'Quickstart: Create a Custom Commands Preview app - Speech service'
33
titleSuffix: Azure Cognitive Services
4-
description: In this article, you create and test a hosted Custom Commands application.
4+
description: In this article, you'll create and test a hosted Custom Commands Preview application. The application will process utterances.
55
services: cognitive-services
66
author: don-d-kim
77
manager: yetian
@@ -12,134 +12,136 @@ ms.date: 04/30/2020
1212
ms.author: donkim
1313
---
1414

15-
# Quickstart: Create a Custom Commands app (Preview)
15+
# Quickstart: Create a Custom Commands Preview app
1616

17-
In this quickstart, you will learn how to create and test a Custom Commands application.
18-
The created application will process utterances like "turn on the tv" and reply with a simple message "Ok, turning on the tv".
17+
In this quickstart, you'll learn how to create and test a Custom Commands application.
18+
The application will process utterances like "turn on the tv" and reply with a simple message like "Ok, turning on the tv."
1919

2020
## Prerequisites
2121

2222
> [!div class="checklist"]
2323
> * <a href="https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices" target="_blank">Create an Azure Speech resource <span class="docon docon-navigate-external x-hidden-focus"></span></a>
2424
2525
> [!NOTE]
26-
> At this time, Custom Commands only supports speech subscriptions in westus, westus2 and neur regions.
26+
> At this time, Custom Commands only supports Speech subscriptions in the westus, westus2, and neur regions.
2727
2828
## Go to the Speech Studio for Custom Commands
2929

30-
1. Open your web browser, and navigate to the [Speech Studio](https://speech.microsoft.com/)
30+
1. In a web browser, go to [Speech Studio](https://speech.microsoft.com/).
3131
1. Enter your credentials to sign in to the portal.
3232

33-
- The default view is your list of Speech subscriptions.
34-
> [!NOTE]
35-
> If you don't see the select subscription page, you can navigate there by choosing "Speech resources" from the settings menu on the top bar.
33+
The default view is your list of Speech subscriptions.
34+
> [!NOTE]
35+
> If you don't see the select subscription page, you can get there by selecting **Speech resources** in the settings menu at the top of the screen.
3636
37-
1. Select your Speech subscription, then select **Go to Studio**.
37+
1. Select your Speech subscription, and then select **Go to Studio**.
3838
1. Select **Custom Commands**.
3939

40-
- The default view is a list of the Custom Commands applications you have under your selected subscription.
40+
The default view is a list of the Custom Commands applications that you have in the selected subscription.
4141

4242
## Create a Custom Commands project
4343

44-
1. Select **New project** to create a new project.
44+
1. Select **New project** to create a project.
4545

4646
> [!div class="mx-imgBorder"]
4747
> ![Create a project](media/custom-speech-commands/create-new-project.png)
4848
49-
1. Enter the project name.
50-
1. Select language from the drop-down.
51-
1. Select an authoring resource from the drop-down. If there are no valid authoring resources, create one by clicking on **Create new LUIS authoring resource**.
49+
1. In the **Name** box, enter a project name.
50+
1. In the **Language** list, select a language.
51+
1. In the **LUIS authoring resource** list, select an authoring resource. If there are no valid authoring resources, create one by selecting **Create new LUIS authoring resource**.
5252

5353
> [!div class="mx-imgBorder"]
5454
> ![Create a resource](media/custom-speech-commands/create-new-resource.png)
5555
56-
- Enter the Resource Name, Resource Group.
57-
- Choose value for Location, and Pricing Tier from the drop-down.
56+
1. In the **Resource Name** box, enter the name of the resource.
57+
1. In the **Resource Group** list, select a resource group.
58+
1. In the **Location** list, select a location.
59+
1. In the **Pricing Tier** list, select a tier.
5860

5961
> [!NOTE]
60-
> You can create resource groups by entering the desired resource group name into the "Resource Group" field. The resource group will be created when **Create** is selected.
62+
> You can create a resource group by entering a resource group name in the **Resource Group** box. The resource group will be created when you select **Create**.
6163
62-
1. Next, select **Create** to create your project.
63-
1. Once created, select your project.
64+
1. Select **Create**.
65+
1. After the project is created, select it.
6466

65-
- Your view should now be an overview of your newly created Custom Commands application.
67+
You should now see an overview of your new Custom Commands application.
6668

67-
## Update LUIS Resources (Optional)
69+
## Update LUIS resources (optional)
6870

69-
You can update the authoring resource that was set in the new project window, and set a prediction resource. Prediction resource is used for recognition once your Custom Commands application is published. You don't need a prediction resource for the development and testing phases.
71+
You can update the authoring resource that you selected in the **New project** window and set a prediction resource. The prediction resource is used for recognition when your Custom Commands application is published. You don't need a prediction resource during the development and testing phases.
7072

71-
1. Select **Settings** from the left pane and then navigate to the **LUIS resources** section in the middle pane.
73+
1. Select **Settings** in the left pane and then select **LUIS resources** in the middle pane.
7274
1. Select a prediction resource, or create one by selecting **Create new resource**.
7375
1. Select **Save**.
7476

7577
> [!div class="mx-imgBorder"]
76-
> ![Set LUIS Resources](media/custom-speech-commands/set-luis-resources.png)
78+
> ![Set LUIS resources](media/custom-speech-commands/set-luis-resources.png)
7779
7880

7981
> [!NOTE]
80-
> Since the authoring resource supports only 1,000 prediction endpoint requests per month, you will mandatorily need to set a LUIS prediction resource before publishing your Custom Commands application.
82+
> Because the authoring resource supports only 1,000 prediction endpoint requests per month, you'll need to set a LUIS prediction resource before you publish your Custom Commands application.
8183
8284

83-
## Create a new Command
85+
## Create a command
8486

8587
Let's create a simple command that will take a single utterance, `turn on the tv`, and respond with the message `Ok, turning on the tv`.
8688

87-
1. Create a new Command by selecting the `+ New command` icon present on top of the left most pane. A new pop-up appears titled **New command**.
88-
1. Provide value for the **Name** field as `TurnOn`.
89+
1. Create a command by selecting **New command** at the top of the left pane. The **New command** window opens.
90+
1. In the **Name** box, enter **TurnOn**.
8991
1. Select **Create**.
9092

91-
The middle pane enlists the different properties of a command:
93+
The middle pane lists the properties of the command:
9294

9395

9496
| Configuration | Description |
9597
| ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
96-
| Example sentences | Example utterances the user can say to trigger this Command |
97-
| Parameters | Information required to complete the Command |
98-
| Completion rules | The actions to be taken to fulfill the Command. For example, to respond to the user or communicate with another web service. |
99-
| Interaction rules | Additional rules to handle more specific or complex situations |
98+
| **Example sentences** | Examples of utterances the user can say to trigger the command. |
99+
| **Parameters** | Information required to complete the command. |
100+
| **Completion rules** | Actions that will be taken to fulfill the command. For example, responding to the user or communicating with another web service. |
101+
| **Interaction rules** | Additional rules to handle more specific or complex situations. |
100102

101103

102104
> [!div class="mx-imgBorder"]
103105
> ![Create a command](media/custom-speech-commands/create-add-command.png)
104106
105107

106-
### Add Example sentences
108+
### Add example sentences
107109

108-
Let's start with Example sentences section, and provide an example of what the user can say.
110+
Let's start with **Example sentences** section. We'll provide an example of what the user can say.
109111

110-
1. Select **Example sentences** section from the middle pane and in the right most pane, add examples:
112+
1. Select **Example sentences** in the middle pane.
113+
1. In the right pane, add examples:
111114

112115
```
113116
turn on the tv
114117
```
115118
116-
1. Select `Save` icon present on top of this pane.
119+
1. Select **Save** at the top of the pane.
117120
118-
For now, we have no parameters so we can move on to **Completion rules** section.
121+
For now, we don't have parameters, so we can move to the **Completion rules** section.
119122
120-
### Add a Completion rule
123+
### Add a completion rule
121124
122-
Now add a Completion rule with the following configuration. This rule indicates user that a fulfillment action is being taken.
125+
Now add a completion rule that has the following configuration. This rule tells the user that a fulfillment action is being taken.
123126
124127
125128
| Setting | Suggested value | Description |
126129
| ---------- | ---------------------------------------- | -------------------------------------------------- |
127-
| Rule Name | ConfirmationResponse | A name describing the purpose of the rule |
128-
| Conditions | None | Conditions that determine when the rule can run |
129-
| Actions | SpeechResponse "- Ok, turning on the tv" | The action to take when the rule condition is true |
130-
131-
1. Create a new completion rule by selecting the `+Add` icon at the top of the middle pane.
132-
1. Provide value in **Name** section.
133-
1. Add an action
134-
1. Create a new action by selecting the **+ Add an action** in the **Actions** section.
135-
1. In the **New Action** pop-up, select `Send speech response` from the drop-down options for **Type**.
136-
1. Choose `Simple editor` for the **Response** field.
137-
- In the **First variation** field, provide value for response as `Ok, turning on the tv`
130+
| **Name** | **ConfirmationResponse** | A name describing the purpose of the rule. |
131+
| **Conditions** | None | Conditions that determine when the rule can run. |
132+
| **Actions** | **Send speech response -> Ok, turning on the tv** | The action to take when the rule condition is true. |
133+
134+
1. Create a new completion rule by selecting **Add** at the top of the middle pane.
135+
1. In the **Name** box, enter a name.
136+
1. Add an action.
137+
1. Create an action by selecting **Add an action** in the **Actions** section.
138+
1. In the **Edit Action** window, in the **Type** list, select **Send speech response**.
139+
1. Under **Response**, select **Simple editor**. In the **First variation** box, enter **Ok, turning on the tv**.
138140
139141
> [!div class="mx-imgBorder"]
140-
> ![Create a Speech response](media/custom-speech-commands/create-speech-response-action.png)
142+
> ![Create a response](media/custom-speech-commands/create-speech-response-action.png)
141143
142-
1. Click **Save** to save the rule.
144+
1. Select **Save** to save the rule.
143145
1. Back in the **Completion rules** section, select **Save** to save all changes.
144146
145147
> [!div class="mx-imgBorder"]
@@ -149,17 +151,17 @@ Now add a Completion rule with the following configuration. This rule indicates
149151
150152
## Try it out
151153
152-
Test the behavior using the Test chat panel
153-
1. Select `Train` icon present on top of the right pane.
154-
1. Once, training completes, select `Test`. A new **Test your application** window will appear.
155-
- You type: turn on the tv
156-
- Expected response: Ok, turning on the tv
154+
Test the behavior by using the test chat panel.
155+
1. Select **Train** at the top of the right pane.
156+
1. After training is done, select **Test**. A new **Test your application** window appears.
157+
- Enter **turn on the tv**
158+
- Expected response: **Ok, turning on the tv**
157159
158160
159161
> [!div class="mx-imgBorder"]
160-
> ![Test with web chat](media/custom-speech-commands/create-basic-test-chat.png)
162+
> ![Test the behavior](media/custom-speech-commands/create-basic-test-chat.png)
161163
162164
## Next steps
163165
164166
> [!div class="nextstepaction"]
165-
> [Quickstart: Create a Custom Command with Parameters (Preview)](./quickstart-custom-speech-commands-create-parameters.md)
167+
> [Quickstart: Create a Custom Commands Preview application with parameters](./quickstart-custom-speech-commands-create-parameters.md)

0 commit comments

Comments
 (0)