Skip to content

Commit 6985c58

Browse files
authored
Merge pull request #109678 from diberry/diberry/0330-luis-fresh-2
[Cogsvs] LUIS - fresh 2 - roles tutorial
2 parents ed6f33e + 2e15163 commit 6985c58

File tree

5 files changed

+35
-99
lines changed

5 files changed

+35
-99
lines changed

articles/cognitive-services/LUIS/luis-tutorial-composite-entity.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
---
22
title: "Tutorial: Composite entity tutorial - LUIS"
3-
titleSuffix: Azure Cognitive Services
43
description: In this tutorial, add a composite entity to bundle extracted data of various types into a single containing entity. By bundling the data, the client application can easily extract related data in different data types.
5-
services: cognitive-services
6-
author: diberry
7-
manager: nitinme
8-
ms.custom: seodec18
9-
ms.service: cognitive-services
10-
ms.subservice: language-understanding
114
ms.topic: tutorial
12-
ms.date: 12/17/2019
13-
ms.author: diberry
5+
ms.date: 03/31/2020
146
---
157

168
# Tutorial: Group and extract related data
@@ -103,11 +95,11 @@ LUIS provides several prebuilt entities for common data extraction.
10395

10496
## Train the app so the changes to the intent can be tested
10597

106-
[!INCLUDE [LUIS How to Train steps](../../../includes/cognitive-services-luis-tutorial-how-to-train.md)]
98+
To train the app, select **Train**. Training applies the changes, such as the new entities and the labeled utterances, to the active model.
10799

108-
## Publish the app so the trained model is queryable from the endpoint
100+
## Publish the app to access it from the HTTP endpoint
109101

110-
[!INCLUDE [LUIS How to Publish steps](../../../includes/cognitive-services-luis-tutorial-how-to-publish.md)]
102+
[!INCLUDE [LUIS How to Publish steps](includes/howto-publish.md)]
111103

112104
## Get intent and entity prediction from endpoint
113105

@@ -181,9 +173,7 @@ LUIS provides several prebuilt entities for common data extraction.
181173

182174
This utterance returns a composite entities array. Each entity is given a type and value. To find more precision for each child entity, use the combination of type and value from the composite array item to find the corresponding item in the entities array.
183175

184-
## Clean up resources
185-
186-
[!INCLUDE [LUIS How to clean up resources](../../../includes/cognitive-services-luis-tutorial-how-to-clean-up-resources.md)]
176+
[!INCLUDE [LUIS How to clean up resources](includes/quickstart-tutorial-cleanup-resources.md)]
187177

188178
## Related information
189179

articles/cognitive-services/LUIS/tutorial-entity-roles.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
11
---
22
title: "Tutorial: Contextual data with roles - LUIS"
3-
titleSuffix: Azure Cognitive Services
43
description: Find related data based on context. For example, an origin and destination locations for a physical move from one building and office to another building and office are related.
5-
services: cognitive-services
6-
author: diberry
7-
manager: nitinme
8-
ms.custom: seodec18
9-
ms.service: cognitive-services
10-
ms.subservice: language-understanding
114
ms.topic: tutorial
12-
ms.date: 12/17/2019
13-
ms.author: diberry
5+
ms.date: 03/30/2020
146
#Customer intent: As a new user, I want to understand how and why to use roles on an entity.
157
---
168

179
# Tutorial: Extract contextually related data from an utterance
1810

19-
In this tutorial, find related pieces of data based on context. For example, an origin and destination locations for a transfer from one city to another. Both pieces of data may be required and they are related to each other.
11+
In this tutorial, find related pieces of data based on context. For example, origin and destination locations for a transfer from one city to another. Both pieces of data may be required and they are related to each other.
2012

2113
A role can be used with any prebuilt or custom entity type, and used in both example utterances and patterns.
2214

@@ -45,24 +37,26 @@ A role should be used when the entity data to extract:
4537

4638
## Create a new app
4739

48-
1. Sign in to the preview LUIS portal with the URL of [https://preview.luis.ai](https://preview.luis.ai).
40+
1. Sign in to the [LUIS **preview** portal](https://preview.luis.ai).
4941

50-
1. Select **Create new app**, enter the name `HumanResources` and keep the default culture, **English**. Leave the description empty.
51-
52-
1. Select **Done**.
42+
1. Select **+ New app for conversation**, enter the name `HumanResources` and keep the default culture, **English**. Leave the description and prediction resource empty. Select **Done**.
5343

5444
## Create an intent to move employees between cities
5545

46+
An intent is used to classify user utterances based on the user's intention, determined from the natural language text.
47+
48+
In order to classify an utterance, the intent needs examples of user utterances that should be classified with this intent.
49+
5650
1. [!INCLUDE [Start in Build section](../../../includes/cognitive-services-luis-tutorial-build-section.md)]
5751

58-
1. Select **Create new intent**.
52+
1. Select **+ Create**.
5953

6054
1. Enter `MoveEmployeeToCity` in the pop-up dialog box then select **Done**.
6155

6256
> [!div class="mx-imgBorder"]
6357
> ![Screenshot of create new intent dialog with](./media/tutorial-entity-roles/create-new-intent-move-employee-to-city.png)
6458
65-
1. Add example utterances to the intent.
59+
1. Add several example utterances to this intent that you expect a user to ask.
6660

6761
|Example utterances|
6862
|--|
@@ -81,24 +75,29 @@ A role should be used when the entity data to extract:
8175
8276
## Add prebuilt entity geographyV2
8377

84-
The prebuilt entity, geographyV2, extracts location information, including city names. Since the utterances have two city names, relating to each other in context, use roles to extract that context.
78+
The prebuilt entity, **geographyV2**, extracts location information, including city names. Since the utterances have two city names, relating to each other in context, use roles to extract that context.
8579

8680
1. Select **Entities** from the left-side navigation.
8781

88-
1. Select **Add prebuilt entity**, then select `geo` in the search bar to filter the prebuilt entities.
82+
1. Select **+ Add prebuilt entity**, then enter `geo` in the search bar to filter the prebuilt entities.
8983

9084
> [!div class="mx-imgBorder"]
9185
> ![Add geographyV2 prebuilt entity to app](media/tutorial-entity-roles/add-geographyV2-prebuilt-entity.png)
9286
9387
1. Select the checkbox and select **Done**.
88+
89+
## Add roles to prebuilt entity
90+
9491
1. In the **Entities** list, select the **geographyV2** to open the new entity.
95-
1. Add two roles, `Origin`, and `Destination`.
92+
1. To add a role, select **+** and add the following two roles: `Origin`, and `Destination`.
9693

9794
> [!div class="mx-imgBorder"]
9895
> ![Add roles to prebuilt entity](media/tutorial-entity-roles/add-roles-to-prebuilt-entity.png)
9996
97+
## Label entity roles in example utterances
98+
10099
1. Select **Intents** from the left-side navigation, then select the **MoveEmployeeToCity** intent. Notice the city names are labeled with the prebuilt entity **geographyV2**.
101-
1. In the context toolbar, select the **Entity palette**.
100+
1. In the context toolbar, select the **Entity palette** with the _pencil icon_.
102101

103102
> [!div class="mx-imgBorder"]
104103
> ![Select Entity Palette from content toolbar](media/tutorial-entity-roles/intent-detail-context-toolbar-select-entity-palette.png)
@@ -118,18 +117,21 @@ The prebuilt entity, geographyV2, extracts location information, including city
118117

119118
## Train the app so the changes to the intent can be tested
120119

121-
[!INCLUDE [LUIS How to Train steps](../../../includes/cognitive-services-luis-tutorial-how-to-train.md)]
120+
To train the app, select **Train**. Training applies the changes, such as the new entities and the labeled utterances, to the active model.
121+
122+
## Publish the app to access it from the HTTP endpoint
122123

123-
## Publish the app so the trained model is queryable from the endpoint
124+
[!INCLUDE [LUIS How to Publish steps](includes/howto-publish.md)]
124125

125-
[!INCLUDE [LUIS How to Publish steps](../../../includes/cognitive-services-luis-tutorial-how-to-publish.md)]
126126

127127
## Get intent and entity prediction from endpoint
128128

129-
1. [!INCLUDE [LUIS How to get endpoint first step](../../../includes/cognitive-services-luis-tutorial-how-to-get-endpoint.md)]
129+
1. [!INCLUDE [LUIS How to get endpoint first step](includes/howto-get-endpoint.md)]
130130

131131

132-
1. Go to the end of the URL in the address bar and enter `Please move Carl Chamerlin from Tampa to Portland`. The last querystring parameter is `q`, the utterance **query**. This utterance is not the same as any of the labeled utterances so it is a good test and should return the `MoveEmployee` intent with the entity extracted.
132+
1. Go to the end of the URL in the address bar and replace _YOUR_QUERY_HERE_ with `Please move Carl Chamerlin from Tampa to Portland`.
133+
134+
This utterance is not the same as any of the labeled utterances so it is a good test and should return the `MoveEmployee` intent with the entity extracted.
133135

134136
```json
135137
{
@@ -169,9 +171,7 @@ The prebuilt entity, geographyV2, extracts location information, including city
169171

170172
The correct intent is predicted and the entities array has both the origin and destination roles in the corresponding **entities** property.
171173

172-
## Clean up resources
173-
174-
[!INCLUDE [LUIS How to clean up resources](../../../includes/cognitive-services-luis-tutorial-how-to-clean-up-resources.md)]
174+
[!INCLUDE [LUIS How to clean up resources](includes/quickstart-tutorial-cleanup-resources.md)]
175175

176176
## Related information
177177

articles/cognitive-services/LUIS/tutorial-machine-learned-entity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Tutorial: extract structured data with machine-learned entity - LUIS"
33
description: Extract structured data from an utterance using the machine-learned entity. To increase the extraction accuracy, add subcomponents with descriptors and constraints.
44
ms.topic: tutorial
5-
ms.date: 03/30/2020
5+
ms.date: 03/31/2020
66
#Customer intent: As a new user, I want to understand how to extract complex data contained in a user utterance.
77
---
88

@@ -211,7 +211,7 @@ Test the app using the interactive **Test** panel. This process lets you enter a
211211

212212
1. [!INCLUDE [LUIS How to get endpoint first step](includes/howto-get-endpoint.md)]
213213

214-
1. Go to the end of the URL in the address and enter the same query as you entered in the interactive test panel.
214+
1. Go to the end of the URL in the address and replace _YOUR_QUERY_HERE_ with the same query as you entered in the interactive test panel.
215215

216216
`deliver a medium veggie pizza`
217217

includes/cognitive-services-luis-tutorial-how-to-publish.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

includes/cognitive-services-luis-tutorial-how-to-train.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)