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/speech-devices-sdk-create-kws.md
+9-30Lines changed: 9 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,44 +1,23 @@
1
1
---
2
-
title: Create a custom keyword - Speech service
2
+
title: Create custom keywords - Speech service
3
3
titleSuffix: Azure Cognitive Services
4
4
description: Your device is always listening for a keyword (or phrase). When the user says the keyword, the device sends all subsequent audio to the cloud, until the user stops speaking. Customizing your keyword is an effective way to differentiate your device and strengthen your branding.
5
5
services: cognitive-services
6
-
author: erhopf
6
+
author: IEvangelist
7
7
manager: nitinme
8
8
ms.service: cognitive-services
9
9
ms.subservice: speech-service
10
10
ms.topic: conceptual
11
-
ms.date: 11/18/2019
12
-
ms.author: erhopf
11
+
ms.date: 12/11/2019
12
+
ms.author: dapine
13
13
---
14
14
15
-
# Create a custom keyword by using the Speech service
15
+
# Create a custom keyword using Speech Studio
16
16
17
17
Your device is always listening for a keyword (or phrase). For example, "Hey Cortana" is a keyword for the Cortana assistant. When the user says the keyword, the device sends all subsequent audio to the cloud, until the user stops speaking. Customizing your keyword is an effective way to differentiate your device and strengthen your branding.
18
18
19
19
In this article, you learn how to create a custom keyword for your device.
20
20
21
-
## Choose an effective keyword
22
-
23
-
Consider the following guidelines when you choose a keyword:
24
-
25
-
* Your keyword should be an English word or a phrase. It should take no longer than two seconds to say.
26
-
27
-
* Words of 4 to 7 syllables work best. For example, "Hey, Computer" is a good keyword. Just "Hey" is a poor one.
28
-
29
-
* Keywords should follow common English pronunciation rules.
30
-
31
-
* A unique or even a made-up word that follows common English pronunciation rules might reduce false positives. For example, "computerama" might be a good keyword.
32
-
33
-
* Do not choose a common word. For example, "eat" and "go" are words that people say frequently in ordinary conversation. They might be false triggers for your device.
34
-
35
-
* Avoid using a keyword that might have alternative pronunciations. Users would have to know the "right" pronunciation to get their device to respond. For example, "509" can be pronounced "five zero nine," "five oh nine," or "five hundred and nine." "R.E.I." can be pronounced "r-e-i" or "ray." "Live" can be pronounced "/līv/" or "/liv/".
36
-
37
-
* Do not use special characters, symbols, or digits. For example, "Go#" and "20 + cats" would not be good keywords. However, "go sharp" or "twenty plus cats" might work. You can still use the symbols in your branding and use marketing and documentation to reinforce the proper pronunciation.
38
-
39
-
> [!NOTE]
40
-
> If you choose a trademarked word as your keyword, be sure that you own that trademark or that you have permission from the trademark owner to use the word. Microsoft is not liable for any legal issues that might arise from your choice of keyword.
41
-
42
21
## Create your keyword
43
22
44
23
Before you can use a custom keyword, you'll need to create a keyword using the [Custom Keyword](https://aka.ms/sdsdk-wakewordportal) page on [Speech Studio](https://aka.ms/sdsdk-speechportal). After you provide a keyword, it produces a file that you deploy to your device.
@@ -57,17 +36,17 @@ Before you can use a custom keyword, you'll need to create a keyword using the [
57
36
58
37
1. To start a new keyword model click **Train model**.
59
38
60
-
1. Enter a **Name** for the keyword model, and optional **Description** and type in the **Keyword** of your choice, and click **Next**. We have some [guidelines](#choose-an-effective-keyword) to help choose an effective keyword.
39
+
1. Enter a **Name** for the keyword model, and optional **Description** and type in the **Keyword** of your choice, and click **Next**. We have some [guidelines](speech-devices-sdk-kws-guidelines.md#choose-an-effective-keyword) to help choose an effective keyword.
61
40
62
-
41
+
63
42
64
43
1. The portal will now create candidate pronunciations for your keyword. Listen to each candidate by clicking the play buttons and remove the checks next to any pronunciations that are incorrect. Once only good pronunciations are checked, click **Train** to begin generating the keyword.
65
44
66
-
45
+
67
46
68
47
1. It may take up to ten minutes for the model to be generated. The keyword list will change from **Processing** to **Succeeded** when the model is complete. You can then download the file.
69
48
70
-
49
+
71
50
72
51
1. Save the .zip file to your computer. You will need this file to deploy your custom keyword to your device.
description: Creating an effective keyword is vital to ensuring your device will consistently and accurately respond.
5
+
services: cognitive-services
6
+
author: IEvangelist
7
+
manager: nitinme
8
+
ms.service: cognitive-services
9
+
ms.subservice: speech-service
10
+
ms.topic: conceptual
11
+
ms.date: 12/11/2019
12
+
ms.author: dapine
13
+
---
14
+
15
+
# Guidelines for creating an effective keyword
16
+
17
+
Creating an effective keyword is vital to ensuring your device will consistently and accurately respond. Customizing your keyword is an effective way to differentiate your device and strengthen your branding. In this article, you learn some guiding principles for creating an effective keyword.
18
+
19
+
## Choose an effective keyword
20
+
21
+
Consider the following guidelines when you choose a keyword:
22
+
23
+
* Your keyword should be an English word or phrase.
24
+
25
+
* It should take no longer than two seconds to say.
26
+
27
+
* Words of 4 to 7 syllables work best. For example, "Hey, Computer" is a good keyword. Just "Hey" is a poor one.
28
+
29
+
* Keywords should follow common English pronunciation rules.
30
+
31
+
* A unique or even a made-up word that follows common English pronunciation rules might reduce false positives. For example, "computerama" might be a good keyword.
32
+
33
+
* Do not choose a common word. For example, "eat" and "go" are words that people say frequently in ordinary conversation. They might be false triggers for your device.
34
+
35
+
* Avoid using a keyword that might have alternative pronunciations. Users would have to know the "right" pronunciation to get their device to respond. For example, "509" can be pronounced "five zero nine," "five oh nine," or "five hundred and nine." "R.E.I." can be pronounced "r-e-i" or "ray." "Live" can be pronounced "/līv/" or "/liv/".
36
+
37
+
* Do not use special characters, symbols, or digits. For example, "Go#" and "20 + cats" could be problematic keywords. However, "go sharp" or "twenty plus cats" might work. You can still use the symbols in your branding and use marketing and documentation to reinforce the proper pronunciation.
38
+
39
+
> [!NOTE]
40
+
> If you choose a trademarked word as your keyword, be sure that you own that trademark or that you have permission from the trademark owner to use the word. Microsoft is not liable for any legal issues that might arise from your choice of keyword.
41
+
42
+
## Next steps
43
+
44
+
Learn how to [create a custom keyword using Speech Studio](speech-devices-sdk-create-kws.md).
0 commit comments