Skip to content

Commit d5f3c4f

Browse files
authored
Merge pull request #6290 from laujan/476086-clu-quickstart
update clu quickstart from language studio to azure ai foundry
2 parents e6ca109 + 2b06d40 commit d5f3c4f

21 files changed

+185
-28
lines changed

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ A Conversational Language Understanding (CLU) fine-tuning task is a workspace pr
1717

1818
> [!NOTE]
1919
>
20-
> If you already have an Azure AI Language or multi-service resource—whether used on its own or through Language Studio—you can continue to use those existing Language resources within the Azure AI Foundry portal. For more information, see [How to use Azure AI services in the Azure AI Foundry portal](../../../../ai-services/connect-services-ai-foundry-portal.md).
21-
>
22-
> In Azure AI Foundry, you set up a fine-tuning task to serve as your workspace when customizing your CLU model. Previously, a **fine-tuning task** was referred to as a **CLU project**. You might encounter both terms used interchangeably in older CLU documentation.
20+
> * If you already have an Azure AI Language or multi-service resource—whether used on its own or through Language Studio—you can continue to use those existing Language resources within the Azure AI Foundry portal. For more information, see [How to use Azure AI services in the Azure AI Foundry portal](../../../../ai-services/connect-services-ai-foundry-portal.md).
21+
> * In Azure AI Foundry, a fine-tuning task serves as your workspace when customizing your CLU model. Previously, a **fine-tuning task** was referred to as a **CLU project**. You might encounter both terms used interchangeably in older CLU documentation.
22+
> * We highly recommend that you use an Azure AI Foundry resource in the AI Foundry; however, you can also follow these instructions using a Language resource.
2323
>
2424
2525
## Prerequisites
@@ -29,10 +29,6 @@ A Conversational Language Understanding (CLU) fine-tuning task is a workspace pr
2929
* An [Azure AI Foundry multi-service resource](../../../multi-service-resource.md). For more information, *see* [Configure an Azure AI Foundry resource](configure-azure-resources.md#option-1-configure-an-azure-ai-foundry-resource). Alternately, you can use an [Azure AI Language resource](https://portal.azure.com/?Microsoft_Azure_PIMCommon=true#create/Microsoft.CognitiveServicesTextAnalytics).
3030
* A Foundry project created in the Azure AI Foundry. For more information, *see* [Create an AI Foundry project](../../../../ai-foundry/how-to/create-projects.md).
3131

32-
> [!NOTE]
33-
>
34-
> We highly recommend that you use an Azure AI Foundry resource in the AI Foundry; however, you can also follow these instructions using a Language resource.
35-
3632
## Create a CLU fine-tuning task project
3733

3834
To create a CLU fine-tuning task project, you first configure your environment and then create a fine-tuning task, which serves as your workspace for customizing your CLU model.
@@ -71,7 +67,7 @@ A Conversational Language Understanding (CLU) fine-tuning task is a workspace pr
7167

7268
1. From **Create service fine-tuning** window, choose the **Conversational language understanding** tab then select **Next**.
7369

74-
:::image type="content" source="../media/select-project.png" alt-text="Screenshot of conversational language understanding tab in the Azure AI Foundry.":::
70+
:::image type="content" source="../media/select-project.png" alt-text="Screenshot of conversational language understanding selection card in the Azure AI Foundry.":::
7571

7672
1. In **Create CLU fine tuning task** window, select your **Connected service** from the drop-down menu, then complete the **Name** and **Language** fields. If you're using the free **Standard Training** mode, select **English** for the language field.
7773

@@ -84,7 +80,7 @@ A Conversational Language Understanding (CLU) fine-tuning task is a workspace pr
8480
> * **Advanced training** includes longer training durations and is supported for English, other languages, and multilingual projects.
8581
> * For more information, *see* [Training modes](train-model.md#training-modes).
8682
87-
1. Once the task creation is complete, select the task from the AI Service fine-tuning window to arrive at the Getting started with fine-tuning page.
83+
1. Once the task creation is complete, select the task from the AI Service fine-tuning window to arrive at the **Getting started with fine-tuning** page.
8884

8985
:::image type="content" source="../media/create-project/getting-started-fine-tuning.png" alt-text="Screenshot of the getting started with fine-tuning page in the Azure AI Foundry." lightbox="../media/create-project/getting-started-fine-tuning.png":::
9086

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,10 @@ We recommend that you introduce casing and punctuation diversity in the training
5454

5555
## Data splitting
5656

57-
Before you start the training process, labeled utterances in your project are divided into a training set and a testing set. Each one of them serves a different function.
58-
The **training set** is used in training the model, the set from which the model learns the labeled utterances.
59-
The **testing set** is a blind set that isn't introduced to the model during training but only during evaluation.
57+
Before you start the training process, labeled utterances in your project are divided into a training set and a testing set. Each one of them serves a different function:
58+
59+
* The **training set** is used in training the model, the set from which the model learns the labeled utterances.
60+
* The **testing set** is a blind set that isn't introduced to the model during training but only during evaluation.
6061

6162
After the model is trained successfully, the model can be used to make predictions from the utterances in the testing set. These predictions are used to calculate [evaluation metrics](../concepts/evaluation-metrics.md).
6263
We recommend that you make sure that all your intents and entities are adequately represented in both the training and testing set.
Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
author: laujan
3+
manager: nitinme
4+
ms.service: azure-ai-language
5+
ms.topic: include
6+
ms.date: 08/03/2025
7+
ms.author: lajanuar
8+
---
9+
10+
Azure AI Foundry offers a unified platform for building, managing, and deploying AI solutions with a wide array of models and tools. Azure AI Foundry playgrounds are interactive environments within the Azure AI Foundry portal designed for exploring, testing, and prototyping with various AI models and tools.
11+
12+
Use this article to get started with Conversational Language understanding using Azure AI Foundry or the REST API.
13+
14+
> [!NOTE]
15+
>
16+
> * If you already have an Azure AI Language or multi-service resource—whether used on its own or through Language Studio—you can continue to use those existing Language resources within the Azure AI Foundry portal.
17+
> * For more information, see [How to use Azure AI services in the Azure AI Foundry portal](/azure/ai-services/connect-services-ai-foundry-portal).
18+
> * We highly recommended that you use an Azure AI Foundry resource in the AI Foundry; however, you can also follow these instructions using a Language resource.
19+
20+
## Prerequisites
21+
22+
* **Azure subscription**. If you don't have one, you can [create one for free](https://azure.microsoft.com/free/cognitive-services).
23+
* **Requisite permissions**. Make sure the person establishing the account and project is assigned as the Azure AI Account Owner role at the subscription level. Alternatively, having either the **Contributor** or **Cognitive Services Contributor** role at the subscription scope also meets this requirement. For more information, *see* [Role based access control (RBAC)](/azure/ai-foundry/openai/how-to/role-based-access-control#cognitive-services-contributor).
24+
* [Azure AI Foundry multi-service resource](/azure/ai-services/multi-service-resource). For more information, *see* [Configure an Azure AI Foundry resource](../../how-to/configure-azure-resources.md#option-1-configure-an-azure-ai-foundry-resource). Alternately, you can use an [Azure AI Language resource](https://portal.azure.com/?Microsoft_Azure_PIMCommon=true#create/Microsoft.CognitiveServicesTextAnalytics).
25+
* Foundry project created in the Azure AI Foundry. For more information, *see* [Create an AI Foundry project](/azure/ai-foundry/how-to/create-projects).
26+
27+
## Get started with Azure AI Foundry
28+
29+
To complete this quickstart, you need a Conversational Language Understanding (CLU) fine-tuning task project that includes a [defined schema](../../how-to/build-schema.md) and [labeled utterances](../../how-to/tag-utterances.md).
30+
31+
You can download our [**sample project file**](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/language-service/CLU/EmailAppDemo.json), which comes preconfigured with both a schema and labeled utterances. This project enables the prediction of user intent for commands such as reading emails, deleting emails, and attaching documents to emails.
32+
33+
Let's begin:
34+
35+
1. Navigate to the [Azure AI Foundry](https://ai.azure.com/).
36+
1. If you aren't already signed in, the portal prompts you to do so with your Azure credentials.
37+
1. Once signed in, you can create or access your existing projects within Azure AI Foundry.
38+
1. If you're not already at your project for this task, select it.
39+
1. On the left side navigation pane, select **Playgrounds**, navigate to the **Language playground card**, and then choose the **Try the Language playground** button.
40+
41+
:::image type="content" source="../../media/quickstarts/try-playground.png" alt-text="Screenshot of the Try Language Playground selection in Azure AI Foundry.":::
42+
43+
## Try the Language playground
44+
45+
The top section of the Language playground is where you can view and select the available Language services.
46+
47+
1. Select the **Conversational language understanding** card.
48+
49+
:::image type="content" source="../../media/quickstarts/language-playground.png" alt-text="Screenshot of the language playground homepage in Azure AI Foundry.":::
50+
51+
1. Next, scroll to and select the **Fine-tune** button.
52+
53+
:::image type="content" source="../../media/quickstarts/fine-tune-button.png" alt-text="Screenshot of the fine-tune button on the language playground homepage in Azure AI Foundry.":::
54+
55+
1. From **Create service fine-tuning** window, choose the **Conversational language understanding** card. Then select **Next**.
56+
57+
:::image type="content" source="../../media/quickstarts/select-project.png" alt-text="Screenshot of conversational language understanding selection card in the Azure AI Foundry.":::
58+
59+
1. In **Create CLU fine tuning task** window, select **Import an existing project**, then choose your **Connected service** from the drop-down menu and complete the **Name** field.
60+
61+
:::image type="content" source="../../media/quickstarts/select-import-existing-project.png" alt-text="Screenshot of the import an existing project selection in Azure AI Foundry.":::
62+
63+
1. Next, add the [sample project file](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/language-service/CLU/EmailAppDemo.json) that you downloaded earlier to the upload area.
64+
65+
1. Select the **Create** button. It can take a few minutes for the *creating* operation to complete.
66+
67+
1. Once your fine-tuning task project is created, the **Getting started with fine-tuning** page opens.
68+
69+
:::image type="content" source="../../media/create-project/getting-started-fine-tuning.png" alt-text="Screenshot of the getting started with fine-tuning page in the Azure AI Foundry." lightbox="../../media/create-project/getting-started-fine-tuning.png":::
70+
71+
## Train your model
72+
73+
After project creation, the next steps are [schema construction](../../how-to/build-schema.md) and [utterance labeling](../../how-to/tag-utterances.md). For this quickstart, these steps are preconfigured in the sample project. Therefore, you can go ahead and initiate a training job by selecting **Train model** from the **Getting Started** menu to generate your model.
74+
75+
:::image type="content" source="../../media/quickstarts/getting-started-menu.png" alt-text="Screenshot of the getting started with fine-tuning menu in the Azure AI Foundry.":::
76+
77+
1. Select the **➕Train model button** from the **Train your model** window.
78+
79+
:::image type="content" source="../../media/quickstarts/train-your-model-button.png" alt-text="Screenshot of the train your model button in the Azure AI Foundry.":::
80+
81+
1. Complete the **Select a mode** form by completing the **Model name** field and selecting a **Training mode**. For this quickstart, select the free **Standard training** mode. For more information, *see* [Training modes](../../how-to/train-model.md#training-modes).
82+
83+
1. Choose a **Training version** from the drop-down menu, then select the **Next** button.
84+
85+
1. Check your selections in the **Review** window, then select the **Create** button
86+
87+
:::image type="content" source="../../media/quickstarts/review-selections.png" alt-text="Screenshot of the review selections window in the Azure AI Foundry.":::
88+
89+
## Deploy model
90+
91+
Typically, after training a model, you review its evaluation details. For this quickstart, you can just deploy your model and make it available to test in the Language playground, or by calling the [prediction API](https://aka.ms/clu-apis). However, if you wish, you can take a moment to select **Evaluate your model** from the left-side menu and explore the in-depth telemetry for your model. Complete the following steps to deploy your model within Azure AI Foundry:
92+
93+
1. Select **Deploy model** from the left-side menu.
94+
1. Next, select **➕Deploy a trained model** from the **Deploy your model** window.
95+
96+
:::image type="content" source="../../media/quickstarts/deploy-trained-model.png" alt-text="Screenshot of the deploy your model window in Azure AI Foundry.":::
97+
98+
1. Make sure the **Create a new deployment** button is selected.
99+
100+
1. Complete the **Deploy a trained model** window fields:
101+
102+
* Create a deployment name.
103+
* Select your trained model from the **Assign a model** drop-down menu.
104+
* Select a subscription from the **Subscription** drop-down menu.
105+
* Select a region from the **Region** drop-down menu.
106+
* Select a resource from the **Resource** drop-down menu. The resource must be in the same deployment region.
107+
108+
109+
:::image type="content" source="../../media/quickstarts/deploy-model-configuration.png" alt-text="Screenshot of the deploy your model configuration in Azure AI Foundry.":::
110+
111+
1. Finally, select the **Create** button. It may take a few minutes for your model to deploy.
112+
113+
1. After successful deployment, you can view your model's deployment status on the **Deploy your model** page. The expiration date that appears marks the date when your deployed model becomes unavailable for prediction tasks. This date is usually 18 months after a training configuration is deployed.
114+
115+
:::image type="content" source="../../media/quickstarts/deployed-model-succeeded.png" alt-text="Screenshot of your successfully deployed model status page in Azure AI Foundry.":::
116+
117+
1. From the far-left menu, navigate to the Language playground.<br>
118+
**Playgrounds****Language playground (Try the Language playground)**.
119+
1. Select the **Conversational language understanding** card.
120+
1. A **Configuration** window with your deployed model should appear in the main/center window.
121+
1. In the text box, enter an utterance to test. For example, if you used our [sample project](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/language-service/CLU/EmailAppDemo.json) application for email-related utterances you could enter ***Check email***.
122+
1. After you enter your test text, select the **Run** button.
123+
124+
:::image type="content" source="../../media/quickstarts/deployed-model-succeeded.png" alt-text="Screenshot of your successfully deployed model status page in Azure AI Foundry.":::
125+
1. After you run the test, you should see the response of the model in the result.
126+
127+
:::image type="content" source="../../media/quickstarts/language-playground-test.png" alt-text="Screenshot of deployed model testing in Azure AI Foundry language playground.":::
128+
129+
1. You can view the results in a text or JSON format view.
130+
131+
:::image type="content" source="../../media/quickstarts/language-playground-test-results.png" alt-text="Screenshot of deployed model test results in Azure AI Foundry language playground.":::
132+
133+
That's it, congratulations!
134+
135+
In this quickstart, you deployed a CLU model and tested it in the Azure AI Foundry Language playground. Next, learn how to [Create your own fine-tuning task project ](../../how-to/create-project.md) for your applications and workflows.
136+
137+
## Clean up resources
138+
139+
If you no longer need your project, you can delete it from the Azure AI Foundry.
140+
141+
1. Navigate to the [Azure AI Foundry](https://ai.azure.com/) home page. Initiate the authentication process by signing in, unless you already completed this step and your session is active.
142+
1. Select the project that you want to delete from the **Keep building with Azure AI Foundry**
143+
1. Select **Management center**.
144+
1. Select **Delete project**.
145+
146+
:::image type="content" source="../../media/create-project/delete-project.png" alt-text="Screenshot of the Delete project button in the Azure AI Foundry.":::
147+
148+
To delete the hub along with all its projects:
149+
150+
1. Navigate to the **Overview** tab inn the **Hub** section.
151+
152+
:::image type="content" source="../../media/create-project/hub-details.png" alt-text="Screenshot of the hub details list in the Azure AI Foundry.":::
153+
154+
1. On the right, select **Delete hub**.
155+
1. The link opens the Azure portal for you to delete the hub there.
156+
157+
:::image type="content" source="../../media/create-project/delete-hub.png" alt-text="Screenshot of the Delete hub button in the Azure AI Foundry.":::
158+

articles/ai-services/language-service/conversational-language-understanding/includes/quickstarts/language-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
<!-- ---
22
author: laujan
33
manager: nitinme
44
ms.service: azure-ai-language
@@ -46,4 +46,4 @@ Generally after training a model you would review its evaluation details. In thi
4646
4747
## Clean up resources
4848
49-
[!INCLUDE [Delete project using Language studio](../language-studio/delete-project.md)]
49+
[!INCLUDE [Delete project using Language studio](../language-studio/delete-project.md)] -->

0 commit comments

Comments
 (0)