Skip to content

Commit c7cde9b

Browse files
Merge pull request #191957 from aahill/baher-orchestration
Baher orchestration updates
2 parents 80146e5 + 1511928 commit c7cde9b

File tree

9 files changed

+611
-78
lines changed

9 files changed

+611
-78
lines changed

articles/cognitive-services/language-service/orchestration-workflow/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ See the [quickstart](./quickstart.md) to quickly create your first project, or t
2323
-->
2424
## How do I connect other service applications in orchestration workflow projects?
2525

26-
See the [Build schema article](./how-to/build-schema.md#build-project-schema-for-orchestration-workflow-projects) for information on connecting another project as an intent.
26+
See [How to create projects and build schemas](./how-to/create-project.md) for information on connecting another project as an intent.
2727

2828
## Which LUIS applications can I connect to in orchestration workflow projects?
2929

@@ -44,7 +44,7 @@ See the [language support](./language-support.md) article.
4444
-->
4545
## How do I get more accurate results for my project?
4646

47-
Take a look at the [recommended guidelines](./how-to/build-schema.md#guidelines-and-recommendations) for information on improving accuracy.
47+
Take a look at the [recommended guidelines](./how-to/create-project.md) for information on improving accuracy.
4848
<!--
4949
## How many intents, and utterances can I add to a project?
5050

articles/cognitive-services/language-service/orchestration-workflow/how-to/build-schema.md

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

articles/cognitive-services/language-service/orchestration-workflow/how-to/create-project.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to create projects in orchestration workflow
2+
title: How to create projects and build schema in orchestration workflow
33
titleSuffix: Azure Cognitive Services
44
description: Use this article to learn how to create projects in orchestration workflow
55
services: cognitive-services
@@ -15,7 +15,7 @@ ms.custom: language-service-orchestration
1515

1616
# How to create projects in orchestration workflow
1717

18-
Orchestration workflow allows you to create projects that connect your applications in:
18+
Orchestration workflow allows you to create projects that connect your applications to:
1919
* Custom Language Understanding
2020
* Question Answering
2121
* LUIS
@@ -25,7 +25,7 @@ Orchestration workflow allows you to create projects that connect your applicati
2525

2626
To get started, you have to first sign in to [Language Studio](https://aka.ms/languageStudio) and create a Language resource. Select **Done** once selection is complete.
2727

28-
In language studio, find the **Understand conversational language** section, and select **Orchestration workflow**.
28+
In language studio, find the **Understand questions and conversational language** section, and select **Orchestration workflow**.
2929

3030
You will see the orchestration workflow projects page.
3131

@@ -36,20 +36,20 @@ You will see the orchestration workflow projects page.
3636
Select **Create new project**. When creating your workflow project, you need to provide the following details:
3737
- Name: Project name
3838
- Description: Optional project description
39-
- Text primary language: The primary language of your project. Your training data should be mainly be in this language.
40-
- Enable multiple languages: Whether you would like to enable your project to support multiple languages at once.
39+
- Utterances primary language: The primary language of your utterances.
4140

42-
Once you're done, you now have the option to connect to the other projects and services you wish to orchestrate to. Each connection is represented by its type and relevant data. The intent needs to have a **name**, a **project type** (LUIS, question answering (QnA), or Conversational Language Understanding), and then selecting the project you want to connect to by name.
41+
## Building schema and adding intents
42+
43+
Once you're done creating a project, you can connect it to the other projects and services you want to orchestrate to. Each connection is represented by its type and relevant data.
44+
45+
To create a new intent, click on *+Add* button and start by giving your intent a **name**. You will see two options, to connect to a project or not. You can connect to (LUIS, question answering (QnA), or Conversational Language Understanding) projects, or choose the **no** option.
4346

4447
> [!NOTE]
4548
> The list of projects you can connect to are only projects that are owned by the same Language resource you are using to create the orchestration project.
4649
47-
This step is optional and you will still have the option to add intent connections after you create the project.
4850

4951
:::image type="content" source="../media/orchestration-project-detail.png" alt-text="A screenshot showing the Conversational Language Understanding orchestration workflow project modal." lightbox="../media/orchestration-project-detail.png":::
5052

51-
## Add intents
52-
5353
In Orchestration Workflow projects, the data used to train connected intents isn't provided within the project. Instead, the project pulls the data from the connected service (such as connected LUIS applications, Conversational Language Understanding projects, or Custom Question Answering knowledge bases) during training. However, if you create intents that are not connected to any service, you still need to add utterances to those intents.
5454

5555
## Export and import a project
@@ -61,4 +61,4 @@ To import a project, select the arrow button on the projects page next to **Crea
6161

6262
## Next Steps
6363

64-
[Build schema](./build-schema.md)
64+
[Build schema](./train-model.md)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: How to tag utterances in an orchestration workflow project
3+
titleSuffix: Azure Cognitive Services
4+
description: Use this article to tag utterances
5+
services: cognitive-services
6+
author: aahill
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.subservice: language-service
10+
ms.topic: how-to
11+
ms.date: 03/03/2022
12+
ms.author: aahi
13+
ms.custom: language-service-orchestration
14+
---
15+
16+
# How to tag utterances in orchestration workflow projects
17+
18+
Once you have [built a schema](create-project.md) for your project, you should add training utterances to your project. The utterances should be similar to what your users will use when interacting with the project. When you add an utterance you have to assign which intent it belongs to. You can only add utterances to the created intents within the project and not the connected intents.
19+
20+
## Filter Utterances
21+
22+
Clicking on **Filter** lets you view only the utterances associated to the intents you select in the filter pane.
23+
When clicking on an intent in the [build schema](./create-project.md) page then you'll be moved to the **Tag Utterances** page, with that intent filtered automatically.
24+
25+
## Next Steps
26+
* [Train and Evaluate Model](./train-model.md)
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
services: cognitive-services
3+
author: aahill
4+
manager: nitinme
5+
ms.service: cognitive-services
6+
ms.subservice: language-service
7+
ms.topic: include
8+
ms.date: 03/16/2022
9+
ms.author: aahi
10+
---
11+
12+
## Prerequisites
13+
14+
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
15+
16+
## Sign in to Language Studio
17+
18+
1. Go to the [Language Studio](https://aka.ms/languageStudio) and sign in with your Azure account.
19+
20+
2. In the **Choose a language resource** window that appears, find your Azure subscription, and choose your Language resource. If you don't have a resource, you can create a new one.
21+
22+
> [!NOTE]
23+
> Currently only resources with the standard (**S**) pricing tier can be used with the Conversational Language Understanding service.
24+
25+
:::image type="content" source="../../../conversational-language-understanding/media/quickstart-language-resource.png" alt-text="A screenshot showing the resource selection screen in Language Studio." lightbox="../../../conversational-language-understanding/media/quickstart-language-resource.png":::
26+
27+
## Create an orchestration project
28+
29+
Once you have a Language resource associated with your account, create an orchestration workflow project. In this quickstart, you'll create a project that connects between different Conversation Language Understanding projects and Custom Question Answering projects.
30+
31+
1. In [Language Studio](https://aka.ms/languageStudio), find the section labeled **Understand questions and conversational language** and select **Orchestration Workflow**.
32+
33+
:::image type="content" source="../../../conversational-language-understanding/media/select-custom-clu.png" alt-text="A screenshot showing the location of Custom Language Understanding in the Language Studio landing page." lightbox="../../../conversational-language-understanding/media/select-custom-clu.png":::
34+
35+
36+
2. This will bring you to the **Orchestration workflow project** page. Select **Create new project**.
37+
38+
:::image type="content" source="../../../conversational-language-understanding/media/projects-page.png" alt-text="A screenshot showing the conversation project page in Language Studio." lightbox="../../../conversational-language-understanding/media/projects-page.png":::
39+
40+
41+
You then need to provide the following details:
42+
43+
|Value | Description |
44+
|---------|---------|
45+
|Name | A name for your project. |
46+
|Description | Optional project description. |
47+
|Utterances primary language | The primary language of your project. Your training data should primarily be in this language. For this quickstart, choose **English**. |
48+
49+
Once you're done, select **Next** and review the details. Select **create project** to complete the process. You should now see the **Build Schema** screen in your project.
50+
51+
## Build schema
52+
53+
1. Click on *+Add* button to add your intent.
54+
2. Give your intent a name and choose to connect the intent to an existing project.
55+
3. Click on *Add intent* button.
56+
4. Another option is to select *no* when creating an intent and don't connect it to an existing project.
57+
58+
When you select the intent, you will see the [tag utterances](../../how-to/tag-utterances.md) page, where you can add examples for intents.
59+
60+
61+
:::image type="content" source="../../../conversational-language-understanding/media/quickstart-intents.png" alt-text="A screenshot showing the schema page in Language studio." lightbox="../../../conversational-language-understanding/media/quickstart-intents.png":::
62+
63+
## Tag utterances
64+
65+
In the tag utterances page, let's add a few examples to the intents. Select the **Greeting** intent from the drop-down box that says **Select Intent**.
66+
67+
In the text box that says **Write your example utterance and press enter**, write the sentence "*Good evening*" and press enter to add it as an example utterance.
68+
69+
Add the rest of these utterances to the **Greeting** intent to the Training set.
70+
71+
|Utterance|
72+
|--|
73+
|*Good evening*|
74+
|*Good morning*|
75+
|*Hey*|
76+
|*What's up*|
77+
78+
When you're done, select **Save Changes** to save the utterances and labels to the project. The icon next to the button will turn green when the changes are saved. Next, go to the **Train Model** page.
79+
80+
:::image type="content" source="../../../conversational-language-understanding/media/quickstart-utterances.png" alt-text="A screenshot showing the intents tagging screen in Language Studio." lightbox="../../../conversational-language-understanding/media/quickstart-utterances.png":::
81+
82+
## Train your model and view its details
83+
84+
Select **train model** on the left of the screen. Select **Start a training job**. To train your model, you need to provide a name for the model. Write a name like "*v1*" and press the enter key.
85+
86+
You should see the **View model details** page. Wait until training completes, which may take about 5 minutes. When training succeeds, Select **Deploy Model** on the left of the screen.
87+
88+
## Deploy your model
89+
90+
From the **Deploy model** page on the left of te screen, Select **Add deployment**. To deploy your model, you need to create a new deployment name. Write a name like "*staging*" and press the next button.
91+
92+
Once you're done, select **Next** and review the details. For the connected projects, select which deployment name from the drop-down menu and press *Submit*.
93+
94+
## Test your model
95+
96+
Select **Test model** on the left of the screen, and select the deployment name from the drop-down menu. Add your test, for example *Good morning* in the text field and click on **Run the test**.
97+
98+
You now see the top intent as **Greeting**.

0 commit comments

Comments
 (0)