Skip to content

Commit bfdc949

Browse files
author
Hasya Shah
committed
Added overview page for 'what is a keyword?'
1 parent bbb515c commit bfdc949

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Custom Keywords - Speech service
3+
titleSuffix: Azure Cognitive Services
4+
description: An overview of the features, capabilities, and restrictions for custom keywords using the Speech Software Development Kit (SDK).
5+
services: cognitive-services
6+
author: hasshah
7+
manager: ?
8+
ms.service: cognitive-services
9+
ms.subservice: speech-service
10+
ms.topic: conceptual
11+
ms.date: 04/06/2020
12+
ms.author: hasshah
13+
---
14+
15+
# What is a keyword?
16+
17+
A keyword is a word or short phrase which allows your product to be voice activated. For example, "Hey Cortana" is the keyword for the Cortana assistant. Voice activation allows your users to start interacting with your product completely hands-free by simply speaking the keyword. As your product continuously listens for the keyword, all audio is processed locally on the user's device until a detection occurs to ensure their data stays as private as possible.
18+
19+
## Core features of Custom Keyword
20+
21+
With Custom Keyword's customization, performance, and integration features, you can tailor voice activation to best suit your product's vision and users' needs.
22+
23+
| Feature | Description |
24+
|----------|----------|
25+
| Keyword customization | As an extension of your brand, a keyword reinforces the equity you've built with your customers. The Custom Keyword portal on Speech Studio allows you to specify any word or short phrase that best represents your brand. You can further personalize your keyword by choosing the right pronunciations, which will be honored by the keyword model generated.
26+
| Keyword verification | When there's high confidence in the keyword being detected locally, audio is sent to the cloud for further verification that a user said the keyword. Keyword verification provides an additional layer of security by reducing the impact of an incorrect local detection and protecting user privacy.
27+
| Voice assistant & Speech SDK integration | Keywords generated from the Custom Keyword on Speech Studio can be easily integrated within your device or application via the Speech SDK. Simply point the SDK to the keyword model provided by Speech Studio and your product will be voice activated, backed by keyword verification. You can complete your product's voice experiences by building your own [voice assistant](voice-assistant.md).
28+
29+
## Getting started with custom keywords
30+
31+
We offer quickstarts designed to have you running code in less than 10 minutes. This table includes a list of voice assistant quickstarts, organized by language.
32+
33+
| Quickstart | Platform | API reference |
34+
|------------|----------|---------------|
35+
| C#, UWP | Windows | [Browse](https://aka.ms/csspeech/csharpref) |
36+
| Java | Windows, macOS, Linux | [Browse](https://aka.ms/csspeech/javaref) |
37+
| Java | Android | [Browse](https://aka.ms/csspeech/javaref) |
38+
39+
## Sample code
40+
41+
Sample code for integrating a keyword model is available on GitHub. These samples cover the client application for integrating your keyword in several popular programming languages.
42+
43+
* [Tutorial: Voice-activate your product with the Speech SDK, C#](tutorial-voice-enable-your-bot-speech-sdk.md)
44+
* [Voice assistant samples (SDK)](https://aka.ms/csspeech/samples)
45+
46+
## Tutorial
47+
48+
* How to [create a custom keyword using Speech Studio](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-devices-sdk-create-kws).
49+
* How to [voice-activate your product using the Speech SDK](tutorial-voice-enable-your-bot-speech-sdk.md).
50+
51+
## Reference docs
52+
53+
* [Custom Keyword naming guidelines](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-devices-sdk-kws-guidelines)
54+
* [Speech SDK](speech-sdk-reference.md)
55+
56+
## Next steps
57+
58+
* [Get a Speech service subscription key for free](get-started.md)
59+
* [Create a custom keyword](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-devices-sdk-create-kws)
60+
* [Get the Speech SDK](speech-sdk.md)
61+
* [Learn more about Voice Assistants](voice-assistants.md)

0 commit comments

Comments
 (0)