Skip to content

Commit b1d024f

Browse files
authored
Merge pull request #98041 from itechedit/tutorial-tenant-model
edit pass: tutorial-tenant-model
2 parents 7515ec8 + 9f27fab commit b1d024f

File tree

1 file changed

+58
-49
lines changed

1 file changed

+58
-49
lines changed

articles/cognitive-services/Speech-Service/tutorial-tenant-model.md

Lines changed: 58 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Create a Tenant Model (Preview) - Speech service
2+
title: Create a tenant model (preview) - Speech Service
33
titleSuffix: Azure Cognitive Services
4-
description: Automatically generate a Tenant Model (Custom Speech with Office 365 data) that leverages your Office 365 data to deliver optimal speech recognition for organization-specific terms that is both secure and compliant.
4+
description: Automatically generate a secure, compliant tenant model (Custom Speech with Office 365 data) that uses your Office 365 data to deliver optimal speech recognition for organization-specific terms.
55
services: cognitive-services
66
author: erhopf
77
manager: nitinme
@@ -12,88 +12,94 @@ ms.date: 10/26/2019
1212
ms.author: erhopf
1313
---
1414

15-
# Create a Tenant Model (Preview)
15+
# Tutorial: Create a tenant model (preview)
1616

17-
Tenant Model (Custom Speech with Office 365 data) is an opt-in service for Office 365 enterprise customers that automatically generates a custom speech recognition model from your organization's Office365 data. The model that's created is optimized for technical terms, jargon and people's names, all in a secure and compliant way.
17+
Tenant Model (Custom Speech with Office 365 data) is an opt-in service for Office 365 enterprise customers that automatically generates a custom speech recognition model from your organization's Office 365 data. The model is optimized for technical terms, jargon, and people's names, all in a secure and compliant way.
1818

1919
> [!IMPORTANT]
20-
> If your organization enrolls with Tenant Model, the Speech service may access your organization’s language model, which is generated from Office 365 public group emails and documents that can be seen by anyone in your organization. Your organization's Office 365 administrator may turn on/off the usage of the organization-wide language model using the Office 365 Admin Portal.
20+
> If your organization enrolls by using the Tenant Model service, Speech Service may access your organization’s language model. The model is generated from Office 365 public group emails and documents, which can be seen by anyone in your organization. Your organization's Office 365 admin can turn on or turn off the use of the organization-wide language model from the Office 365 admin portal.
2121
2222
In this tutorial, you'll learn how to:
2323

2424
> [!div class="checklist"]
25-
> * Enroll to use a Tenant Model in the Microsoft 365 Admin Center
25+
> * Enroll in the Tenant Model by using the Microsoft 365 admin center
2626
> * Get a Speech subscription key
27-
> * Create a Tenant Model
28-
> * Deploy a Tenant Model
29-
> * Use a Tenant Model with the Speech SDK
27+
> * Create a tenant model
28+
> * Deploy a tenant model
29+
> * Use your tenant model with the Speech SDK
3030
31-
## Enroll using the Microsoft 365 Admin Center
31+
## Enroll in the Tenant Model service
3232

33-
Before you can deploy your Tenant Model, first need to enroll using the Microsoft 365 Admin Center. This task can only be completed by your Microsoft 365 Admin.
33+
Before you can deploy your tenant model, you need to be enrolled in the Tenant Model service. Enrollment is completed in the Microsoft 365 admin center and can be done only by your Microsoft 365 admin.
3434

35-
1. Sign into the [Microsoft 365 Admin Center](https://admin.microsoft.com ).
36-
2. From the left panel, select **Settings** then **Apps**.
35+
1. Sign in to the [Microsoft 365 admin center](https://admin.microsoft.com).
3736

38-
![Tenant Model enrollment](media/tenant-language-model/tenant-language-model-enrollment.png)
37+
1. In the left pane, select **Settings**, select **Apps**, and then select **Azure Speech Services**.
3938

40-
3. Locate and select **Azure Speech Services**.
39+
![The "Services & add-ins" pane](media/tenant-language-model/tenant-language-model-enrollment.png)
4140

42-
![Tenant Model enrollment 2](media/tenant-language-model/tenant-language-model-enrollment-2.png)
41+
1. Select the **Allow the organization-wide language model** check box, and then select **Save changes**.
4342

44-
4. Click the checkbox and save.
43+
![The Azure Speech Services pane](media/tenant-language-model/tenant-language-model-enrollment-2.png)
4544

46-
If you need to turn off the Tenant Model, navigate back to this screen, deselect the checkbox, and save.
45+
To turn off the tenant model instance:
46+
1. Repeat the preceding steps 1 and 2.
47+
1. Clear the **Allow the organization-wide language model** check box, and then select **Save changes**.
4748

4849
## Get a Speech subscription key
4950

50-
In order to use a Tenant Model with the Speech SDK, you'll need a Speech resource and its associated subscription key.
51+
To use your tenant model with the Speech SDK, you need a Speech resource and its associated subscription key.
5152

52-
1. Sign into the [Azure portal](https://aka.ms/azureportal).
53-
2. Select **Create a resource**.
54-
3. In the search bar, type: **Speech**.
55-
4. Select **Speech**, then click **Create**.
56-
5. Follow the onscreen instructions to create your resource. Make sure:
53+
1. Sign in to the [Azure portal](https://aka.ms/azureportal).
54+
1. Select **Create a resource**.
55+
1. In the **Search** box, type **Speech**.
56+
1. In the results list, select **Speech**, and then select **Create**.
57+
1. Follow the onscreen instructions to create your resource. Make sure that:
5758
* **Location** is set to either **eastus** or **westus**.
5859
* **Pricing tier** is set to **S0**.
59-
6. Click **Create**.
60-
7. After a few minutes, your resource is created. The subscription key is available in the **Overview** section for your resource.
60+
1. Select **Create**.
6161

62-
## Create a model
62+
After a few minutes, your resource is created. The subscription key is available in the **Overview** section for your resource.
6363

64-
After your admin has enabled Tenant Model for your organization, you can create a language model based on your Office365 data.
64+
## Create a language model
6565

66-
1. Sign into the [Speech Studio](https://speech.microsoft.com/).
67-
2. In the upper right corner, locate and click the gear icon (settings), then select **Tenant Model settings**.
66+
After your admin has enabled Tenant Model for your organization, you can create a language model that's based on your Office 365 data.
6867

69-
![Settings menu](media/tenant-language-model/tenant-language-settings.png)
68+
1. Sign in to [Speech Studio](https://speech.microsoft.com/).
69+
1. At the top right, select **Settings** (gear icon), and then select **Tenant Model settings**.
70+
71+
![The "Tenant Model settings" link](media/tenant-language-model/tenant-language-settings.png)
72+
73+
Speech Studio displays a message that lets you know whether you're qualified to create a tenant model.
7074

71-
3. At this point you'll see a message letting you know if you are qualified to create a Tenant Model.
7275
> [!NOTE]
73-
> Office 365 enterprise customers in North America are eligible to create a Tenant Model (English). If you are a Customer Lockbox (CLB), Customer Key (CK), or Office 365 Government customer, this feature isn't available. To determine if you are a Customer Lockbox or Customer Key customer, follow these instructions:
76+
> Office 365 enterprise customers in North America are eligible to create a tenant model (English). If you're a Customer Lockbox, Customer Key, or Office 365 Government customer, this feature isn't available. To determine whether you're a Customer Lockbox or Customer Key customer, see:
7477
> * [Customer Lockbox](https://docs.microsoft.com/office365/securitycompliance/controlling-your-data-using-customer-key#FastTrack)
7578
> * [Customer Key](https://docs.microsoft.com/microsoft-365/compliance/customer-lockbox-requests)
7679
> * [Office 365 Government](https://www.microsoft.com/microsoft-365/government)
7780
78-
4. Next, select **Opt in**. You'll receive an email with instructions when your Tenant Model is ready.
81+
1. Select **Opt in**.
82+
83+
When your tenant model is ready, you'll receive a confirmation email message with further instructions.
7984

80-
## Deploy your model
85+
## Deploy your tenant model
8186

82-
When your Tenant Model is ready, follow these steps to deploy your model:
87+
When your tenant model instance is ready, deploy it by doing the following:
8388

84-
1. Click the **View model** button in confirmation email you received, or sign into the [Speech Studio](https://speech.microsoft.com/).
85-
2. In the upper right corner, locate and click the gear icon (settings), then select **Tenant Model settings**.
89+
1. In your confirmation email message, select the **View model** button. Or sign in to [Speech Studio](https://speech.microsoft.com/).
90+
1. At the top right, select **Settings** (gear icon), and then select **Tenant Model settings**.
8691

87-
![Settings menu](media/tenant-language-model/tenant-language-settings.png)
92+
![The "Tenant Model settings" link](media/tenant-language-model/tenant-language-settings.png)
8893

89-
3. Click **Deploy**.
90-
4. When your model is deployed, the status will change to **Deployed**.
94+
1. Select **Deploy**.
9195

92-
## Use your model with the Speech SDK
96+
When your model has been deployed, the status changes to *Deployed*.
9397

94-
Now that you've deployed your model, you can use it with the Speech SDK. In this section, you'll use the sample code provided to call the Speech service using Azure AD authentication.
98+
## Use your tenant model with the Speech SDK
9599

96-
Let's look at the code you'll use to call the Speech SDK in C#. In this example, you'll perform speech recognition using a Tenant Model. This guide presumes that your platform is already set up. If you need help with setting up, see [Quickstart: Recognize speech, C# (.NET Core)](quickstarts/speech-to-text-from-microphone.md?pivots=programming-language-csharp&tabs=dotnetcore).
100+
Now that you've deployed your model, you can use it with the Speech SDK. In this section, you use sample code to call Speech Service by using Azure Active Directory (Azure AD) authentication.
101+
102+
Let's look at the code you'll use to call the Speech SDK in C#. In this example, you perform speech recognition by using your tenant model. This guide presumes that your platform is already set up. If you need setup help, see [Quickstart: Recognize speech, C# (.NET Core)](quickstarts/speech-to-text-from-microphone.md?pivots=programming-language-csharp&tabs=dotnetcore).
97103

98104
Copy this code into your project:
99105

@@ -112,7 +118,7 @@ namespace PrincetonSROnly.FrontEnd.Samples
112118
using Microsoft.IdentityModel.Clients.ActiveDirectory;
113119
using Newtonsoft.Json.Linq;
114120

115-
// Note: ServiceApplicationId is a fixed value. No need to change.
121+
// ServiceApplicationId is a fixed value. No need to change it.
116122
117123
public class TenantLMSample
118124
{
@@ -276,19 +282,22 @@ namespace PrincetonSROnly.FrontEnd.Samples
276282
}
277283
```
278284

279-
Next, you'll need rebuild and run the project from the command line. There are a few parameters you'll need to update before you run the command.
285+
Next, you need to rebuild and run the project from the command line. Before you run the command, update a few parameters by doing the following:
280286

281287
1. Replace `<Username>` and `<Password>` with the values for a valid tenant user.
282-
2. Replace `<Subscription-Key>` with the subscription key for your Speech resource. This value is available in the **Overview** section for your Speech resource in the [Azure portal](https://aka.ms/azureportal).
283-
3. Replace `<Endpoint-Uri>` with the endpoint below. Make sure that you replace `{your-region}` with the region where your Speech resource was created. These regions are supported: `westus`, `westus2`, and `eastus`. Your region information is available in the **Overview** section for your Speech resource in the [Azure portal](https://aka.ms/azureportal).
288+
1. Replace `<Subscription-Key>` with the subscription key for your Speech resource. This value is available in the **Overview** section for your Speech resource in the [Azure portal](https://aka.ms/azureportal).
289+
1. Replace `<Endpoint-Uri>` with the following endpoint. Make sure that you replace `{your region}` with the region where your Speech resource was created. These regions are supported: `westus`, `westus2`, and `eastus`. Your region information is available in the **Overview** section of your Speech resource in the [Azure portal](https://aka.ms/azureportal).
284290
```
285291
"wss://{your region}.online.princeton.customspeech.ai/msgraphcustomspeech/conversation/v1".
286292
```
287-
4. Run the command:
293+
1. Run the following command:
294+
288295
```bash
289296
dotnet TenantLMSample.dll --Username=<Username> --Password=<Password> --SubscriptionKey=<Subscription-Key> --EndpointUri=<Endpoint-Uri>
290297
```
291298

299+
In this tutorial, you've learned how to use Office 365 data to create a custom speech recognition model, deploy it, and use it with the Speech SDK.
300+
292301
## Next steps
293302

294303
* [Speech Studio](https://speech.microsoft.com/)

0 commit comments

Comments
 (0)