Skip to content

Commit c02a637

Browse files
committed
Merge branch 'patch-8' into peyton-5074-schema
2 parents f1f934a + 3c5e08a commit c02a637

File tree

1 file changed

+18
-16
lines changed
  • articles/ai-services/language-service/conversational-language-understanding/how-to

1 file changed

+18
-16
lines changed

articles/ai-services/language-service/conversational-language-understanding/how-to/build-schema.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: jboback
1111
ms.custom: language-service-clu
1212
---
1313

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

1616
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, you want think about which intents and entities should be included in your project.
1717

@@ -39,53 +39,55 @@ They might create an intent to represent each of these actions. They might also
3939

4040
## Add intents
4141

42-
To build a project schema within [Language Studio](https://aka.ms/languageStudio):
42+
To build a project schema within [AI Foundry](https://ai.azure.com):
4343

44-
1. Select **Schema definition** from the left side menu.
44+
1. Select **Define schema** from the left side menu.
4545

4646
2. From the top pivots, you can change the view to be **Intents** or **Entities**.
4747

48-
2. To create an intent, select **Add** from the top menu. You will be prompted to type in a name before completing creating the intent.
48+
3. To create an intent, select **+ Add intent**. You will be 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.
4949

50-
3. Repeat the above step to create all the intents to capture all the actions that you think the user will want to perform while using the project.
50+
4. Repeat the above step to create all the intents to capture all the actions that you think the user will want to perform while using the project.
5151

5252
:::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":::
5353

54-
4. When you select the intent, you will be directed to the [Data labeling](tag-utterances.md) page, with a filter set for the intent you selected. You can add examples for intents and label them with entities.
54+
5. 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.
5555

5656
## Add entities
5757

5858
1. Move to **Entities** pivot from the top of the page.
5959

60-
2. To add an entity, select **Add** from the top menu. You will be prompted to type in a name before completing creating the entity.
60+
2. To add an entity, select **+ Add entity** from the top. You will be prompted to type in a name to create the entity.
6161

62-
3. After creating an entity, you'll be routed to the entity details page where you can define the composition settings for this entity.
63-
64-
4. Every entity can be defined by multiple components: learned, list or prebuilt. A learned component is added to all your entities once you label them in your utterances.
62+
3. After creating an entity, you can select the entity name to change the **Entity components** type. Every entity can be defined by multiple components: learned, list, regex, or prebuilt. A learned component is added to all your entities once you label them in your utterances.
6563

6664
:::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":::
6765

68-
5.You can add a [list](../concepts/entity-components.md#list-component) or [prebuilt](../concepts/entity-components.md#prebuilt-component) component to each entity.
66+
5.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.
6967

7068
### Add prebuilt component
7169

72-
To add a **prebuilt** component, select **Add new prebuilt** and from the drop-down menu, select the prebuilt type to you want to add to this entity.
70+
To add a **prebuilt** component, select the prebuilt type from the drop-down menu in the Entity options section.
7371

7472
<!--:::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":::-->
7573

7674
### Add list component
7775

78-
To add a **list** component, select **Add new list**. You can add multiple lists to each entity.
76+
To add a **list** component, select **Add list**. You can add multiple lists to each entity.
7977

80-
1. To create a new list, in the *Enter value* text box enter this is the normalized value that will be returned when any of the synonyms values is extracted.
78+
1. To create a new list, in the *List key* text box, enter the normalized value that will be returned when any of the synonyms values is extracted.
8179

82-
2. From the *language* drop-down menu, select the language of the synonyms list and start typing in your synonyms and hit enter after each one. It is recommended to have synonyms lists in multiple languages.
80+
2. Start typing in your synonyms and hit enter after each one. It is recommended to have synonyms lists in multiple languages.
8381

8482
<!--:::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":::-->
83+
84+
### Add regex component
85+
86+
To add a regex component, select Add expression. Name the regex key and type a regular expression that matches the entity to be extracted.
8587

8688
### Define entity options
8789

88-
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 at the top.
90+
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.
8991

9092
<!--:::image type="content" source="../media/entity-options.png" alt-text="A screenshot showing an entity option in Language Studio." lightbox="../media/entity-options.png":::-->
9193

0 commit comments

Comments
 (0)