Skip to content

Commit 3c5b907

Browse files
paulth1paulth1
committed
edit pass: how-to-guides-for-clu
1 parent 148a277 commit 3c5b907

File tree

6 files changed

+66
-74
lines changed

6 files changed

+66
-74
lines changed

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

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: How to create projects in Conversational Language Understanding
2+
title: Create Projects in Conversational Language Understanding
33
titleSuffix: Azure AI services
4-
description: Use this article to learn how to create projects in Conversational Language Understanding.
4+
description: Use this article to learn how to create projects in conversational language understanding (CLU).
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-language
@@ -11,36 +11,33 @@ ms.author: lajanuar
1111
ms.custom: language-service-clu
1212
---
1313

14-
# How to create a CLU fine-tuning task
14+
# Create a CLU fine-tuning task
1515

16-
Use this article to learn how to set up these requirements and create a project.
16+
Use this article to learn how to set up these requirements and create a project.
1717

1818
## Prerequisites
1919

20-
Before you start using CLU, you will need a few items:
20+
* An Azure subscription. If you don't have one, you can [create one for free](https://azure.microsoft.com/free/cognitive-services).
21+
* An Azure AI Language resource.
2122

22-
* An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
23-
* An Azure AI Language resource
23+
### Create a Language resource
2424

25-
### Create a Language resource
26-
27-
Before you start using CLU, you will need an Azure AI Language resource.
25+
Before you start using CLU, you need an Azure AI Language resource.
2826

2927
> [!NOTE]
30-
> * You need to have an **owner** role assigned on the resource group to create a Language resource.
28+
> You need to have an Owner role assigned on the resource group to create a Language resource.
3129
3230
[!INCLUDE [create a new resource from the Azure portal](../includes/resource-creation-azure-portal.md)]
3331

3432
[!INCLUDE [create a new resource from Language Studio](../includes/resource-creation-language-studio.md)]
3533

36-
3734
## Sign in to Language Studio
3835

3936
[!INCLUDE [Sign in to Language studio](../includes/language-studio/sign-in-studio.md)]
4037

4138
## Create a conversation project
4239

43-
Once you have a Language resource created, create a Conversational Language Understanding project.
40+
After you create a Language resource, create a CLU project.
4441

4542
### [Azure AI Foundry](#tab/azure-ai-foundry)
4643

@@ -56,21 +53,21 @@ Once you have a Language resource created, create a Conversational Language Unde
5653

5754
### [Azure AI Foundry](#tab/azure-ai-foundry)
5855

59-
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 from the top menu, clicking on **Export**.
56+
You can export a CLU project as a JSON file at any time. On the conversation projects page, select a project, and on the top menu, select **Export**.
6057

61-
:::image type="content" source="../media/export.png" alt-text="A screenshot showing the Conversational Language Understanding export button." lightbox="../media/export.png":::
58+
:::image type="content" source="../media/export.png" alt-text="A screenshot that shows the CLU Export button." lightbox="../media/export.png":::
6259

63-
That project can be reimported as a new project. If you import a project with the exact same name, it replaces the project's data with the newly imported project's data.
60+
You can reimport that project as a new project. If you import a project with the exact same name, it replaces the project's data with the newly imported project's data.
6461

65-
If you have an existing LUIS application, you can _import_ the LUIS application JSON to Conversational Language Understanding directly, and it will create a Conversation project with all the pieces that are currently available: Intents, ML entities, and utterances. See [the LUIS migration article](../how-to/migrate-from-luis.md) for more information.
62+
If you have an existing Language Understanding (LUIS) application, you can _import_ the LUIS application JSON to CLU directly. It creates a Conversation project with all the pieces that are currently available: intents, machine learning entities, and utterances. For more information, see [Migrate from Language Understanding (LUIS) to conversational language understanding (CLU)](../how-to/migrate-from-luis.md).
6663

67-
To import a project, select the arrow button next to **Create a new project** and select **Import**, then select the LUIS or Conversational Language Understanding JSON file.
64+
To import a project, select the arrow button next to **Create a new project** and select **Import**. Then select the LUIS or CLU JSON file.
6865

69-
:::image type="content" source="../media/import.png" alt-text="A screenshot showing the Conversational Language Understanding import button." lightbox="../media/import.png":::
66+
:::image type="content" source="../media/import.png" alt-text="A screenshot that shows the CLU Import button." lightbox="../media/import.png":::
7067

7168
### [REST APIs](#tab/rest-api)
7269

73-
You can import a CLU JSON into the service
70+
You can import a CLU JSON into the service.
7471

7572
[!INCLUDE [Import project](../includes/rest-api/import-project.md)]
7673

@@ -80,11 +77,11 @@ You can import a CLU JSON into the service
8077

8178
### [Azure AI Foundry](#tab/azure-ai-foundry)
8279

83-
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**.
80+
You can export a CLU project as a JSON file at any time. On the conversation projects page, select a project, and select **Export**.
8481

8582
### [REST APIs](#tab/rest-api)
8683

87-
You can export a Conversational Language Understanding project as a JSON file at any time.
84+
You can export a CLU project as a JSON file at any time.
8885

8986
[!INCLUDE [Export project](../includes/rest-api/export-project.md)]
9087

@@ -102,20 +99,20 @@ You can export a Conversational Language Understanding project as a JSON file at
10299

103100
---
104101

105-
## Delete project
102+
## Delete project
106103

107104
### [Azure AI Foundry](#tab/azure-ai-foundry)
108105

109106
[!INCLUDE [Delete project](../includes/language-studio/delete-project.md)]
110107

111108
### [REST APIs](#tab/rest-api)
112109

113-
When you don't need your project anymore, you can delete your project using the APIs.
110+
When you don't need your project anymore, you can use the APIs to delete your project.
114111

115112
[!INCLUDE [Delete project](../includes/rest-api/delete-project.md)]
116113

117114
---
118115

119-
## Next Steps
116+
## Related content
120117

121-
[Build schema](./build-schema.md)
118+
- [Build schema](./build-schema.md)

‎articles/ai-services/language-service/conversational-language-understanding/includes/language-studio/create-project.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,21 @@ ms.date: 11/21/2024
77
ms.author: lajanuar
88
---
99

10-
1. In [Language Studio](https://aka.ms/languageStudio), find the section named **Understand questions and conversational language** and select **Conversational language understanding**.
11-
:::image type="content" source="../../media/select-custom-clu.png" alt-text="A screenshot showing the location of Custom Language Understanding in the Language Studio landing page." lightbox="../../media/select-custom-clu.png":::
12-
10+
1. In [Language Studio](https://aka.ms/languageStudio), find the section named **Understand questions and conversational language** and select **Conversational Language Understanding**.
1311

14-
2. This will bring you to the **Conversational language understanding projects** page. Select **Create new project**.
12+
:::image type="content" source="../../media/select-custom-clu.png" alt-text="A screenshot that shows the location of Custom Language Understanding on the Language Studio landing page." lightbox="../../media/select-custom-clu.png":::
1513

16-
:::image type="content" source="../../media/projects-page.png" alt-text="A screenshot showing the conversation project page in Language Studio." lightbox="../../media/projects-page.png":::
14+
1. When the **Conversational Language Understanding projects** page opens, select **Create new project**.
1715

16+
:::image type="content" source="../../media/projects-page.png" alt-text="A screenshot that shows the conversation project page in Language Studio." lightbox="../../media/projects-page.png":::
1817

19-
To create a new project you need to provide the following details:
18+
To create a new project, provide the following details:
2019

2120
|Value | Description |
2221
|---------|---------|
23-
|Name | A name for your project. Once it's created, it can't be changed |
22+
|Name | A name for your project. After you create it, the name can't be changed. |
2423
|Description | Optional project description. |
2524
|Utterances primary language | The primary language of your project. Your training data should primarily be in this language. |
26-
|Enable multiple languages | Whether you would like to enable your project to support [multiple languages](../../language-support.md#multi-lingual-option) at once. |
25+
|Enable multiple languages | Whether you want to enable your project to support [multiple languages](../../language-support.md#multi-lingual-option) at once. |
2726

28-
Once you're done, select **Create**. You should now see the Getting started landing page in your project.
27+
After you're finished, select **Create**. You should now see the **Getting started** landing page for your project.

‎articles/ai-services/language-service/conversational-language-understanding/includes/language-studio/sign-in-studio.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ ms.author: lajanuar
99

1010
1. Go to the [Language Studio](https://aka.ms/languageStudio) and sign in with your Azure account.
1111

12-
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.
12+
1. 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.
1313

1414
|Instance detail |Required value |
1515
|---------|---------|
1616
|Azure subscription | Your Azure subscription. |
1717
|Azure resource group | Your Azure resource group name. |
1818
|Azure resource name | Your Azure resource name. |
19-
|Location | One of the [supported regions](../../service-limits.md#regional-availability) for your Language resource. For example "West US 2". |
19+
|Location | One of the [supported regions](../../service-limits.md#regional-availability) for your Language resource. An example is West US 2. |
2020
|Pricing tier | One of the valid [pricing tiers](../../service-limits.md#language-resource-limits) for your Language resource. You can use the Free (F0) tier to try the service. |
2121

22-
:::image type="content" source="../../media/quickstart-language-resource.png" alt-text="A screenshot showing the resource selection screen in Language Studio." lightbox="../../media/quickstart-language-resource.png":::
22+
:::image type="content" source="../../media/quickstart-language-resource.png" alt-text="A screenshot that shows the resource selection screen in Language Studio." lightbox="../../media/quickstart-language-resource.png":::

‎articles/ai-services/language-service/conversational-language-understanding/includes/resource-creation-language-studio.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,18 @@ ms.author: lajanuar
1111

1212
### Create a new Language resource from Language Studio
1313

14-
If it's your first time logging in, you'll see a window in [Language Studio](https://aka.ms/languageStudio) that will let you choose an existing Language resource or create a new one. You can also create a resource by clicking the settings icon in the top-right corner, selecting **Resources**, then clicking **Create a new resource**.
14+
If it's your first time to sign in, you see a window in [Language Studio](https://aka.ms/languageStudio) that you can use to choose an existing Language resource or create a new one. You can also create a resource by selecting the settings icon in the upper-right corner, selecting **Resources**, and then selecting **Create a new resource**.
1515

16-
Create a Language resource with following details.
16+
Create a Language resource with the following information.
1717

1818
|Instance detail |Required value |
1919
|---------|---------|
20-
|Azure subscription| Your Azure subscription|
21-
|Azure resource group| Your Azure resource group|
22-
|Azure resource name| Your Language resource name|
23-
|Location | A [supported regions](../service-limits.md#regional-availability) for your Language resource. |
24-
|Pricing tier | A [supported pricing tiers](../service-limits.md#language-resource-limits) for your Language resource. |
20+
|Azure subscription| Your Azure subscription.|
21+
|Azure resource group| Your Azure resource group.|
22+
|Azure resource name| Your Language resource name.|
23+
|Location | [Supported regions](../service-limits.md#regional-availability) for your Language resource. |
24+
|Pricing tier | [Supported pricing tiers](../service-limits.md#language-resource-limits) for your Language resource. |
2525

2626
> [!IMPORTANT]
27-
> * Make sure to enable **Managed Identity** when you create a Language resource.
28-
> * Read and confirm Responsible AI notice
29-
30-
31-
27+
> - Make sure to enable managed identity when you create a Language resource.
28+
> - Read and confirm the Responsible AI notice.

‎articles/ai-services/language-service/conversational-language-understanding/includes/rest-api/create-project.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@ ms.date: 11/21/2024
77
ms.author: lajanuar
88
---
99

10-
Submit a **PATCH** request using the following URL, headers, and JSON body to create a new project.
10+
Submit a `PATCH` request by using the following URL, headers, and JSON body to create a new project.
1111

1212
### Request URL
1313

14-
Use the following URL when creating your API request. Replace the placeholder values below with your own values.
14+
Use the following URL when you create your API request. Replace the placeholder values with your own values.
1515

1616
```rest
1717
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}
1818
```
1919

2020
|Placeholder |Value | Example |
2121
|---------|---------|---------|
22-
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
23-
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
24-
|`{API-VERSION}` | The [version](../../../concepts/model-lifecycle.md#api-versions) of the API you are calling. | `2023-04-01` |
22+
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
23+
|`{PROJECT-NAME}` | The name for your project. This value is case sensitive. | `myProject` |
24+
|`{API-VERSION}` | The [version](../../../concepts/model-lifecycle.md#api-versions) of the API you're calling. | `2023-04-01` |
2525

2626
### Headers
2727

28-
Use the following header to authenticate your request.
28+
Use the following header to authenticate your request.
2929

3030
|Key|Value|
3131
|--|--|
3232
|`Ocp-Apim-Subscription-Key`| The key to your resource. Used for authenticating your API requests.|
33-
|`Content-Type`| 'application/merge-patch+json' |
33+
|`Content-Type`| `application/merge-patch+json` |
3434

3535
### Body
3636

@@ -48,7 +48,6 @@ Use the following sample JSON as your body.
4848

4949
|Key |Placeholder |Value | Example |
5050
|---------|---------|----------|--|
51-
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `EmailApp` |
52-
| `language` | `{LANGUAGE-CODE}` | A string specifying the language code for the utterances used in your project. If your project is a multilingual project, choose the [language code](../../language-support.md) of the majority of the utterances. |`en-us`|
53-
| `multilingual` | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents). See [Language support](../../language-support.md#multi-lingual-option) to learn more about multilingual support. | `true`|
54-
51+
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case sensitive. | `EmailApp` |
52+
| `language` | `{LANGUAGE-CODE}` | A string that specifies the language code for the utterances used in your project. If your project is a multilingual project, choose the [language code](../../language-support.md) of most of the utterances. |`en-us`|
53+
| `multilingual` | `true`| A Boolean value that enables you to have documents in multiple languages in your dataset. When your model is deployed, you can query the model in any supported language (not necessarily included in your training documents). To learn more about multilingual support, see [Language support](../../language-support.md#multi-lingual-option). | `true`|

0 commit comments

Comments
 (0)