Skip to content

Commit f5ab06f

Browse files
authored
Merge pull request #192044 from MicrosoftDocs/release-cogsvcs-orchestration
Release cogsvcs orchestration
2 parents 0ee95d1 + 4680779 commit f5ab06f

31 files changed

+976
-115
lines changed

articles/cognitive-services/LUIS/how-to/orchestration-projects.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: aahill
77
ms.manager: nitinme
88
ms.subservice: language-understanding
99
ms.topic: how-to
10-
ms.date: 01/06/2022
10+
ms.date: 03/08/2022
1111
---
1212

1313
# Combine LUIS and question answering capabilities
@@ -34,14 +34,14 @@ As an example, if your chat bot receives the text "How do I get to the Human Res
3434

3535
Orchestration helps you connect more than one project and service together. Each connection in the orchestration is represented by a type and relevant data. The intent needs to have a name, a project type (LUIS, question answering, or conversational language understanding, and a project you want to connect to by name.
3636

37-
You can use conversational language understanding to create a new orchestration project, See the [conversational language understanding documentation](../../language-service/conversational-language-understanding/how-to/create-project.md#create-an-orchestration-workflow-project).
37+
You can use conversational language understanding to create a new orchestration project, See the [conversational language understanding documentation](../../language-service/orchestration-workflow/how-to/create-project.md).
3838

3939
## Set up orchestration between Cognitive Services features
4040

4141
To use an orchestration project to connect LUIS, question answering, and conversational language understanding, you need:
4242

4343
* A language resource in [Language Studio](https://language.azure.com/) or the Azure portal.
44-
* To change your LUIS authoring resource to the Language resource. You can also optionally export your application from LUIS, and then [import it into conversational language understanding](../../language-service/conversational-language-understanding/how-to/create-project.md#import-a-project).
44+
* To change your LUIS authoring resource to the Language resource. You can also optionally export your application from LUIS, and then [import it into conversational language understanding](../../language-service/orchestration-workflow/how-to/create-project.md#export-and-import-a-project).
4545

4646
>[!Note]
4747
>LUIS can be used with Orchestration projects in West Europe only, and requires the authoring resource to be a Language resource. You can either import the application in the West Europe Language resource or change the authoring resource from the portal.
@@ -60,4 +60,4 @@ You need to follow the following steps to change LUIS authoring resource to a La
6060

6161
## Next steps
6262

63-
[Conversational language understanding documentation](../../language-service/conversational-language-understanding/how-to/create-project.md#create-an-orchestration-workflow-project).
63+
* [Conversational language understanding documentation](../../language-service/conversational-language-understanding/how-to/create-project.md)

articles/cognitive-services/language-service/conversational-language-understanding/concepts/backwards-compatibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: overview
11-
ms.date: 11/02/2021
11+
ms.date: 03/03/2022
1212
ms.author: aahi
1313
ms.custom: language-service-clu, ignite-fall-2021
1414
---
1515

1616
# Backwards compatibility with LUIS applications
1717

18-
You can reuse some of the content of your existing LUIS applications in Conversational Language Understanding. When working with Conversational Language Understanding projects, you can:
18+
You can reuse some of the content of your existing LUIS applications in [Conversational Language Understanding](../overview.md). When working with Conversational Language Understanding projects, you can:
1919
* Create CLU conversation projects from LUIS application JSON files.
20-
* Create LUIS applications that can be connected to orchestration workflow projects.
20+
* Create LUIS applications that can be connected to [orchestration workflow](../../orchestration-workflow/overview.md) projects.
2121

2222
> [!NOTE]
2323
> This guide assumes you have created a Language resource. If you're getting started with the service, see the [quickstart article](../quickstart.md).

articles/cognitive-services/language-service/conversational-language-understanding/faq.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,14 @@ Use this article to quickly get the answers to common questions about conversati
2121

2222
See the [quickstart](./quickstart.md) to quickly create your first project, or the [how-to article](./how-to/create-project.md) for more details.
2323

24-
## How do I connect other service applications in orchestration workflow projects?
24+
## How do I connect conversation language projects to other service applications?
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.
27-
28-
## Which LUIS applications can I connect to in orchestration workflow projects?
29-
30-
LUIS applications that use the Language resource as their authoring resource will be available for connection. You can only connect to LUIS applications that are owned by the same resource. This option will only be available for resources in West Europe, as it's the only common available region between LUIS and CLU. See [region limits](./service-limits.md#region-limits) for more information.
26+
See the [orchestration workflow documentation](../orchestration-workflow/overview.md) for more information.
3127

3228
## Training is taking a long time, is this expected?
3329

3430
For conversation projects, long training times are expected. Based on the number of examples you have your training times may vary from 5 minutes to 1 hour or more.
3531

36-
## Can I add entities to orchestration workflow projects?
37-
38-
No. Orchestration projects are only enabled for intents that can be connected to other projects for routing.
39-
4032
## How do I use entity components?
4133

4234
See the [entity components](./concepts/entity-components.md) article.

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

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: how-to
11-
ms.date: 11/02/2021
11+
ms.date: 03/03/2022
1212
ms.author: aahi
1313
ms.custom: language-service-clu, ignite-fall-2021
1414
---
@@ -39,13 +39,6 @@ They might create an intent to represent each of these actions. They might also
3939
* Date
4040
* Meeting durations
4141

42-
43-
For **orchestration workflow** projects, you can only create intents. The orchestration workflow project is intended to route to other target services that may be enabled with entity extraction to complete the conversation flow. You can add new intents that are connected to other services _or_ create intents that aren't connected to any service (a disconnected intent).
44-
45-
By adding a disconnected intent, you allow the orchestrator to route to that intent, and return without calling into an additional service. You must provide training examples for disconnected intents. You can only connect to projects that are owned by the same Azure resource.
46-
47-
Continuing the example from earlier, the developers for a bot might realize that for each skill of their bot (which includes: calendar actions, email actions, and a company FAQ), they need an intent that connects to each of those skills.
48-
4942
## Build project schema for conversation projects
5043

5144
To build a project schema for conversation projects:
@@ -60,20 +53,5 @@ To build a project schema for conversation projects:
6053

6154
:::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":::
6255

63-
## Build project schema for orchestration workflow projects
64-
65-
To build a project schema for orchestration workflow projects:
66-
67-
1. Select **Add** in the **Build Schema** page. You will be prompted for a name and to define a connection for the intent, if any. If you would like to connect an intent you must provide:
68-
1. **Service Type**: LUIS, Custom Question Answering (QnA), or Conversational Language Understanding.
69-
2. **Project Name**: The project you want the intent to connect to.
70-
3. **Version for utterances** (Only for LUIS): which LUIS version should be used to train the orchestrator classification model.
71-
72-
:::image type="content" source="../media/orchestration-intent.png" alt-text="A screenshot showing the intent creation modal for orchestration projects in Language Studio." lightbox="../media/orchestration-intent.png":::
73-
74-
> [!IMPORTANT]
75-
> * Connected intents cannot be selected because you cannot add training examples to a connected intent, as it already uses the target project's data to train its intent classification.
76-
> * You will only be able to connect to target services that are owned by the same resource.
77-
7856
## Next Steps
7957
* [Tag utterances](tag-utterances.md)

articles/cognitive-services/language-service/conversational-language-understanding/how-to/create-project.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: language-service
1010
ms.topic: how-to
11-
ms.date: 11/02/2021
11+
ms.date: 03/03/2022
1212
ms.author: aahi
1313
ms.custom: language-service-clu, ignite-fall-2021
1414
---
1515

1616
# How to create projects in Conversational Language Understanding
1717

18-
Conversational Language Understanding allows you to create two types of projects: **Conversation** and **Orchestration Workflow** projects.
18+
Conversational Language Understanding allows you to create conversation projects. To create orchestration projects, see the [orchestration workflow](../../orchestration-workflow/overview.md) documentation.
1919

2020
## Sign in to Language Studio
2121
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.
@@ -39,23 +39,6 @@ After selecting conversation, you need to provide the following details:
3939

4040
Once you're done, click next, review the details, and then click create project to complete the process.
4141

42-
## Create an orchestration workflow project
43-
44-
After selecting orchestration, you need to provide the following details:
45-
- Name: Project name
46-
- Description: Optional project description
47-
- Text primary language: The primary language of your project. Your training data should be mainly be in this language.
48-
- Enable multiple languages: Whether you would like to enable your project to support multiple languages at once.
49-
50-
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, custom question answering (QnA), or Conversational Language Understanding), and then selecting the project you want to connect to by name.
51-
52-
> [!NOTE]
53-
> 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.
54-
55-
This step is optional and you will still have the option to add intent connections after you create the project.
56-
57-
:::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":::
58-
5942
## Import a project
6043

6144
You can export a Conversational Language Understanding project as a JSON file at any time by going to the conversation projects page, selecting a project, and pressing **Export**.

articles/cognitive-services/language-service/conversational-language-understanding/how-to/deploy-query-model.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.devlang: csharp, python
1414
ms.custom: language-service-clu, ignite-fall-2021
1515
---
1616

17-
# Deploy and test model
17+
# Deploy and test a conversational language understanding model
1818

1919
After you have [trained a model](./train-model.md) on your dataset, you're ready to deploy it. After deploying your model, you'll be able to query it for predictions.
2020

@@ -54,22 +54,6 @@ To delete a deployment, select the deployment you want to delete and click on **
5454
> [!NOTE]
5555
> You can only have ten deployment names.
5656
57-
### Orchestration workflow projects deployments
58-
59-
1. Click on **Add deployment** to submit a new deployment job.
60-
61-
Like conversation projects, In the window that appears, you can create a new deployment name by giving the deployment a name or override an existing deployment name. Then, you can add a trained model to this deployment name and press next.
62-
63-
:::image type="content" source="../media/create-deployment-job-orch.png" alt-text="A screenshot showing deployment job creation in Language Studio." lightbox="../media/create-deployment-job-orch.png":::
64-
65-
2. If you're connecting one or more LUIS applications or conversational language understanding projects, specify the deployment name.
66-
67-
No configurations are required for custom question answering or unlinked intents.
68-
69-
LUIS projects **must be published** to the slot configured during the Orchestration deployment, and custom question answering KBs must also be published to their Production slots.
70-
71-
:::image type="content" source="../media/deploy-connected-services.png" alt-text="A screenshot showing the deployment screen for orchestration workflow projects." lightbox="../media/deploy-connected-services.png":::
72-
7357
## Send a Conversational Language Understanding request
7458

7559
Once your model is deployed, you can begin using the deployed model for predictions. Outside of the test model page, you can begin calling your deployed model via API requests to your provided custom endpoint. This endpoint request obtains the intent and entity predictions defined within the model.
@@ -126,16 +110,6 @@ In a conversations project, you'll get predictions for both your intents and ent
126110
- Its start location denoted by an offset value
127111
- The length of the entity text denoted by a length value.
128112

129-
## API response for an orchestration Workflow Project
130-
131-
Orchestration workflow projects return with the response of the top scoring intent, and the response of the service it is connected to.
132-
- Within the intent, the *targetKind* parameter lets you determine the type of response that was returned by the orchestrator's top intent (conversation, LUIS, or QnA Maker).
133-
- You will get the response of the connected service in the *result* parameter.
134-
135-
Within the request, you can specify additional parameters for each connected service, in the event that the orchestrator routes to that service.
136-
- Within the project parameters, you can optionally specify a different query to the connected service. If you don't specify a different query, the original query will be used.
137-
- The *direct target* parameter allows you to bypass the orchestrator's routing decision and directly target a specific connected intent to force a response for it.
138-
139113
## Next steps
140114

141115
* [Conversational Language Understanding overview](../overview.md)

articles/cognitive-services/language-service/conversational-language-understanding/how-to/tag-utterances.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@ For example, to improve a calender bot's performance with users, a developer mig
3030
* "_Reply as **tentative** to the **weekly update** meeting._" (English)
3131
* "_Cancelar mi **próxima** reunión_." (Spanish)
3232

33-
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.
34-
35-
For example, a developer might create an intent for each of their skills, and connect it to a respective calendar project, email project, and company FAQ knowledge base.
36-
3733
## Tag utterances
3834

3935
:::image type="content" source="../media/tag-utterances.png" alt-text="A screenshot of the page for tagging utterances in Language Studio." lightbox="../media/tag-utterances.png":::

articles/cognitive-services/language-service/conversational-language-understanding/how-to/train-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ After you have completed [tagging your utterances](./tag-utterances.md), you can
1919

2020
You can create and train multiple models within the same project. However, if you re-train a specific model it overwrites the last state.
2121

22-
The training times can be anywhere from a few seconds when dealing with orchestration workflow projects, up to a couple of hours when you reach the [maximum limit](../service-limits.md) of utterances. Before training, you will have the option to enable evaluation, which lets you view how your model performs.
22+
The training times can be anywhere from a few seconds up to a couple of hours when you reach the [maximum limit](../service-limits.md) of utterances. Before training, you will have the option to enable evaluation, which lets you view how your model performs.
2323

2424
## Train model
2525

articles/cognitive-services/language-service/conversational-language-understanding/language-support.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The supported languages for conversation projects are:
3939
| Czech | `cs` |
4040
| Welsh | `cy` |
4141
| Danish | `da` |
42-
| German | `de`
42+
| German | `de` |
4343
| Greek | `el` |
4444
| English (US) | `en-us` |
4545
| English (Uk) | `en-gb` |
@@ -125,20 +125,6 @@ The supported languages for conversation projects are:
125125

126126
When you enable multiple languages in a project, you can add data in multiple languages to your project. You can also train the project in one language and immediately predict it in other languages. The quality of predictions may vary between languages – and certain language groups work better than others with respect to multilingual predictions.
127127

128-
129-
## Supported languages for orchestration workflow projects
130-
131-
|Language| Language code |
132-
|---|---|
133-
| Brazilian Portuguese | `pt-br` |
134-
| English | `en-us` |
135-
| French | `fr-fr` |
136-
| German | `de-de` |
137-
| Italian | `it-it` |
138-
| Spanish | `es-es` |
139-
140-
Orchestration workflow projects are not available for use in multiple languages.
141-
142128
## Next steps
143129

144130
[Conversational language understanding overview](overview.md)

articles/cognitive-services/language-service/conversational-language-understanding/overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,3 @@ Conversational language understanding applies custom machine-learning intelligen
2727
* Robust and semantically aware classification and extraction models.
2828
* Simplified model building experience, using Language Studio.
2929
* Natively multilingual models that let you to train in one language, and test in others.
30-
* Orchestration project types that allow you to connect services including other Conversational Language Understanding projects, custom question answering knowledge bases, and LUIS applications.

0 commit comments

Comments
 (0)