Skip to content

Commit b3b8d92

Browse files
committed
edit pass: how-to-guides-for-clu
1 parent 6c4a648 commit b3b8d92

File tree

11 files changed

+144
-153
lines changed

11 files changed

+144
-153
lines changed
Lines changed: 34 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: How to build a Conversational Language Understanding project schema
2+
title: Build a Conversational Language Understanding Project Schema
33
titleSuffix: Azure AI services
4-
description: Use this article to start building a Conversational Language Understanding project schema
4+
description: Use this article to start building a conversational language understanding project schema.
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-language
@@ -11,25 +11,24 @@ ms.author: lajanuar
1111
ms.custom: language-service-clu
1212
---
1313

14-
# How to build your fine-tuning schema
14+
# Build your fine-tuning schema
1515

16-
In conversational language understanding projects, the *schema* is defined as the combination of intents and entities within your project. Schema design is a crucial part of your project's success. When creating a schema, think about which intents and entities should be included in your project.
16+
In conversational language understanding projects, the *schema* is defined as the combination of intents and entities within your project. Schema design is a crucial part of your project's success. When you create a schema, think about which intents and entities should be included in your project.
1717

1818
## Guidelines and recommendations
1919

20-
Consider the following guidelines when picking intents for your project:
20+
Consider the following guidelines when you choose intents for your project:
2121

22-
1. Create distinct, separable intents. An intent is best described as action the user wants to perform. Think of the project you're building and identify all the different actions your users may take when interacting with your project. Sending, calling, and canceling are all actions that are best represented as different intents. "Canceling an order" and "canceling an appointment" are similar, with the distinction being *what* they're canceling. Those two actions should be represented under the same intent, *Cancel*.
22+
- Create distinct, separable intents. An intent is best described as action that the user wants to perform. Think of the project you're building and identify all the different actions that your users might take when they interact with your project. Sending, calling, and canceling are all actions that are best represented as different intents. "Canceling an order" and "canceling an appointment" are similar, with the distinction being *what* they're canceling. Those two actions should be represented under the same intent, *cancel*.
23+
- Create entities to extract relevant pieces of information within your text. The entities should be used to capture the relevant information that's needed to fulfill your user's action. For example, *order* or *appointment* could be different things that a user is trying to cancel, and you should create an entity to capture that piece of information.
2324

24-
1. Create entities to extract relevant pieces of information within your text. The entities should be used to capture the relevant information needed to fulfill your user's action. For example, *order* or *appointment* could be different things a user is trying to cancel, and you should create an entity to capture that piece of information.
25+
You can "send a message," "send an email," or "send a package." Creating an intent to capture each of those requirements won't scale over time, and you should use entities to identify *what* the user was sending. The combination of intents and entities should determine your conversation flow.
2526

26-
You can *"send"* a *message*, *"send"* an *email*, or *"send"* a package. Creating an intent to capture each of those requirements won't scale over time, and you should use entities to identify *what* the user was sending. The combination of intents and entities should determine your conversation flow.
27+
For example, consider a company where the bot developers identified the three most common actions that their users take when they use a calendar:
2728

28-
For example, consider a company where the bot developers identified the three most common actions their users take when using a calendar:
29-
30-
* Setup new meetings
31-
* Respond to meeting requests
32-
* Cancel meetings
29+
* Set up new meetings.
30+
* Respond to meeting requests.
31+
* Cancel meetings.
3332

3433
They might create an intent to represent each of these actions. They might also include entities to help complete these actions, such as:
3534

@@ -41,61 +40,58 @@ They might create an intent to represent each of these actions. They might also
4140

4241
To build a project schema within [AI Foundry](https://ai.azure.com/?cid=learnDocs):
4342

44-
1. Select **Define schema** from the left side menu.
45-
46-
1. From the top pivots, you can change the view to be **Intents** or **Entities**.
43+
1. On the left pane, select **Define schema**.
4744

48-
1. To create an intent, select **+ Add intent**. You're prompted to type in names and descriptions for as many intents as you'd like to create. Descriptions are only required for using Quick Deploy to help Azure OpenAI better understand the context of your intents.
45+
1. Select the **Intents** or **Entities** tabs.
4946

50-
1. Repeat the steps to develop intents that encompass all the actions the user is likely to perform while interacting with the project.
47+
1. To create an intent, select **+ Add intent**. You're prompted to enter names and descriptions for as many intents as you want to create. Descriptions are required only for using the **Quick Deploy** option to help Azure OpenAI better understand the context of your intents.
5148

49+
1. Repeat the steps to develop intents that encompass all the actions that the user is likely to perform while interacting with the project.
5250

51+
:::image type="content" source="../media/build-schema-page.png" alt-text="A screenshot that shows the schema creation page for conversation projects in Language Studio." lightbox="../media/build-schema-page.png":::
5352

54-
:::image type="content" source="../media/build-schema-page.png" alt-text="A screenshot showing the schema creation page for conversation projects in Language Studio." lightbox="../media/build-schema-page.png":::
55-
56-
1. If you'd like to continue with [data labeling](tag-utterances.md) and advanced training a custom `CLU` model, you can select **Manage data** from the left side menu to add examples for intents and label them with entities, if desired.
53+
1. If you want to continue with [data labeling](tag-utterances.md) and advanced training a custom `CLU` model, on the left pane, select **Manage data** to add examples for intents and label them with entities, if desired.
5754

5855
## Add entities
5956

60-
1. Move to **Entities** pivot from the top of the page.
57+
1. Select the **Entities** tab.
6158

62-
1. To add an entity, select **+ Add entity** from the top. You're prompted to type in a name to create the entity.
59+
1. To add an entity, select **+ Add entity**. You're prompted to enter a name to create the entity.
6360

64-
1. After creating an entity, you can select the entity name to change the **Entity components** type. Multiple componentslearned, list, regex, or prebuiltdefine every entity. A learned component is added to all your entities once you label them in your utterances.
61+
1. After you create an entity, you can select the entity name to change the **Entity components** type. Multiple components like learned, list, regex, or prebuilt are used to define every entity. A learned component is added to all your entities after you label them in your utterances.
6562

66-
:::image type="content" source="../media/entity-details.png" alt-text="A screenshot showing the entity details page for conversation projects in Language Studio." lightbox="../media/entity-details.png":::
63+
:::image type="content" source="../media/entity-details.png" alt-text="A screenshot that shows the Entity components page for conversation projects in Language Studio." lightbox="../media/entity-details.png":::
6764

6865
1. You can also add a [list](../concepts/entity-components.md#list-component), [regex](../concepts/entity-components.md#regex-component), or [prebuilt](../concepts/entity-components.md#prebuilt-component) component to each entity.
6966

70-
### Add prebuilt component
67+
### Add a prebuilt component
7168

72-
To add a **prebuilt** component, select the prebuilt type from the drop-down menu in the Entity options section.
69+
To add a prebuilt component, select the prebuilt type from the dropdown menu in the **Entity options** section.
7370

74-
<!--:::image type="content" source="../media/add-prebuilt-component.png" alt-text="A screenshot showing a prebuilt-component in Language Studio." lightbox="../media/add-prebuilt-component.png":::-->
71+
<!--:::image type="content" source="../media/add-prebuilt-component.png" alt-text="A screenshot that shows a prebuilt component in Language Studio." lightbox="../media/add-prebuilt-component.png":::-->
7572

7673
### Add list component
7774

78-
To add a **list** component, select **Add list**. You can add multiple lists to each entity:
75+
To add a list component, select **Add list**. You can add multiple lists to each entity:
7976

80-
1. Create a new list, in the *List key* text box, enter the normalized value that is returned when any of the synonyms values is extracted.
77+
1. Create a new list, and in the **List key** text box, enter the normalized value that was returned when any of the synonyms values were extracted.
8178

82-
1. Start typing in your synonyms and hit enter after each one. We recommend having a synonym list in multiple languages.
79+
1. Enter your synonyms and select Enter after each one. We recommend having a synonym list in multiple languages.
8380

84-
<!--:::image type="content" source="../media/add-list-component.png" alt-text="A screenshot showing a list component in Language Studio." lightbox="../media/add-list-component.png":::-->
81+
<!--:::image type="content" source="../media/add-list-component.png" alt-text="A screenshot that shows a list component in Language Studio." lightbox="../media/add-list-component.png":::-->
8582

8683
### Add regex component
8784

88-
To add a regex component, select Add expression. Name the regex key and type a regular expression that matches the entity to be extracted.
85+
To add a regex component, select **Add expression**. Name the regex key, and enter a regular expression that matches the entity to be extracted.
8986

9087
### Define entity options
9188

92-
Change to the **Entity options** pivot in the entity details page. When multiple components are defined for an entity, their predictions may overlap. When an overlap occurs, each entity's final prediction is determined based on the [entity option](../concepts/entity-components.md#entity-options) you select in this step. Select the one that you want to apply to this entity and select the **Save** button.
93-
94-
<!--:::image type="content" source="../media/entity-options.png" alt-text="A screenshot showing an entity option in Language Studio." lightbox="../media/entity-options.png":::-->
89+
Select the **Entity Options** tab on the entity details page. When multiple components are defined for an entity, their predictions might overlap. When an overlap occurs, each entity's final prediction is determined based on the [entity option](../concepts/entity-components.md#entity-options) that you select in this step. Select the option that you want to apply to this entity and select **Save**.
9590

91+
<!--:::image type="content" source="../media/entity-options.png" alt-text="A screenshot that shows an entity option in Language Studio." lightbox="../media/entity-options.png":::-->
9692

97-
After you create your entities, you can come back and edit them. You can **edit entity components** or **delete** them by selecting this option from the top menu.
93+
After you create your entities, you can come back and edit them. You can edit entity components or delete them by selecting **Edit** or **Delete**.
9894

99-
## Next Steps
95+
## Related content
10096

10197
* [Add utterances and label your data](tag-utterances.md)

0 commit comments

Comments
 (0)