Skip to content

Commit 6a9355e

Browse files
authored
Merge pull request #230717 from aahill/clu-qs-update
CLU quickstart update
2 parents 8856251 + 7ec638b commit 6a9355e

File tree

7 files changed

+40
-32
lines changed

7 files changed

+40
-32
lines changed

articles/cognitive-services/language-service/conversational-language-understanding/includes/quickstarts/rest-api.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ manager: nitinme
55
ms.service: cognitive-services
66
ms.subservice: language-service
77
ms.topic: include
8-
ms.date: 06/07/2022
8+
ms.date: 03/14/2023
99
ms.author: aahi
1010
ms.custom: ignite-fall-2021
1111
---
@@ -32,7 +32,7 @@ ms.custom: ignite-fall-2021
3232
> [!div class="nextstepaction"]
3333
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Conversational-language-understanding&Page=quickstart&Section=Get-resource-keys-and-endpoint" target="_target">I ran into an issue</a>
3434
35-
## Create a CLU project
35+
## Import a new CLU sample project
3636

3737
Once you have a Language resource created, create a conversational language understanding project. A project is a work area for building your custom ML models based on your data. Your project can only be accessed by you and others who have access to the Language resource being used.
3838

@@ -41,36 +41,32 @@ For this quickstart, you can download [this sample project](https://go.microsoft
4141
> [!div class="nextstepaction"]
4242
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=RESTAPI&Pillar=Language&Product=Conversational-language-understanding&Page=quickstart&Section=Create-a-conversational-language-understanding-project" target="_target">I ran into an issue</a>
4343
44-
### Trigger import project job
44+
### Trigger the import project job
4545

4646
[!INCLUDE [create and import project](../rest-api/import-project.md)]
4747

4848
> [!div class="nextstepaction"]
4949
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Conversational-language-understanding&Page=quickstart&Section=Trigger-import-project-job" target="_target">I ran into an issue</a>
5050
51-
### Get import job Status
51+
### Get the import job status
5252

5353
[!INCLUDE [get import project status](../rest-api/get-import-status.md)]
5454

5555
> [!div class="nextstepaction"]
5656
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Conversational-language-understanding&Page=quickstart&Section=Get-import-job-status" target="_target">I ran into an issue</a>
5757
58-
## Train your model
58+
## Start training your model
5959

6060
Typically, after you create a project, you should [build schema](../../how-to/build-schema.md) and [tag utterances](../../how-to/tag-utterances.md). For this quickstart, we already imported a ready project with built schema and tagged utterances.
6161

62-
### Start training your model
63-
64-
After your project has been imported, you can start training your model.
65-
6662
[!INCLUDE [train model](../rest-api/train-model.md)]
6763

6864
> [!div class="nextstepaction"]
6965
> <a href="https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=REST API&Pillar=Language&Product=Conversational-language-understanding&Page=quickstart&Section=Train-model" target="_target">I ran into an issue</a>
7066
71-
### Get Training Status
67+
### Get the training job status
7268

73-
Training could take sometime between 10 and 30 minutes. You can use the following request to keep polling the status of the training job until it is successfully completed.
69+
Training may take time to complete - sometimes between 10 and 30 minutes. You can use the following request to keep polling the status of the training job until it is successfully completed.
7470

7571
[!INCLUDE [get training model status](../rest-api/get-training-status.md)]
7672

articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-deployment-status.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ ms.date: 05/16/2022
99
ms.author: aahi
1010
---
1111

12-
Use the following **GET** request to get the status of your deployment job. Replace the placeholder values below with your own values.
12+
When you send a successful deployment request, the full request URL for checking the job's status (including your endpoint, project name, and job ID) is contained in the response's `operation-location` header.
13+
14+
Use the following **GET** request to get the status of your deployment job. Replace the placeholder values with your own values.
1315

1416
### Request URL
1517

@@ -22,8 +24,8 @@ Use the following **GET** request to get the status of your deployment job. Repl
2224
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2325
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
2426
|`{DEPLOYMENT-NAME}` | The name for your deployment. This value is case-sensitive. | `staging` |
25-
|`{JOB-ID}` | The ID for locating your model's training status. This is in the `location` header value you received from the API in response to your model deployment request. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
26-
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data). | `2022-05-01` |
27+
|`{JOB-ID}` | The ID for locating your model's training status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
28+
|`{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data). | `2022-05-01` |
2729

2830
### Headers
2931

@@ -36,7 +38,7 @@ Use the following header to authenticate your request.
3638

3739
### Response Body
3840

39-
Once you send the request, you will get the following response. Keep polling this endpoint until the **status** parameter changes to "succeeded".
41+
Once you send the request, you'll get the following response. Keep polling this endpoint until the **status** parameter changes to "succeeded".
4042

4143
```json
4244
{

articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-import-status.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ manager: nitinme
66
ms.service: cognitive-services
77
ms.subservice: language-service
88
ms.topic: include
9-
ms.date: 05/13/2022
9+
ms.date: 03/17/2023
1010
ms.author: aahi
1111
ms.custom: language-service-clu
1212
---
1313

14-
Use the following **GET** request to query the status of your import job. You can use the URL you received from the previous step, or replace the placeholder values below with your own values.
14+
When you send a successful project import request, the full request URL for checking the import job's status (including your endpoint, project name, and job ID) is contained in the response's `operation-location` header.
15+
16+
Use the following **GET** request to query the status of your import job. You can use the URL you received from the previous step, or replace the placeholder values with your own values.
1517

1618
```rest
1719
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}
@@ -21,8 +23,8 @@ Use the following **GET** request to query the status of your import job. You ca
2123
|---------|---------|---------|
2224
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2325
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
24-
|`{JOB-ID}` | The ID for locating your export job status. This is in the `location` header value you received in the previous step. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
25-
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data). | `2022-05-01` |
26+
|`{JOB-ID}` | The ID for locating your import job status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
27+
|`{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data). | `2022-05-01` |
2628

2729
#### Headers
2830

@@ -34,7 +36,7 @@ Use the following header to authenticate your request.
3436

3537
#### Response body
3638

37-
Once you send the request, you will get the following response. Keep polling this endpoint until the status parameter changes to "succeeded".
39+
Once you send the request, you'll get the following response. Keep polling this endpoint until the status parameter changes to "succeeded".
3840

3941

4042
```json

articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-training-status.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ manager: nitinme
55
ms.service: cognitive-services
66
ms.subservice: language-service
77
ms.topic: include
8-
ms.date: 05/12/2022
8+
ms.date: 03/17/2023
99
ms.author: aahi
1010
---
1111

12+
When you send a successful training request, the full request URL for checking the job's status (including your endpoint, project name, and job ID) is contained in the response's `operation-location` header.
13+
1214
Use the following **GET** request to get the status of your model's training progress. Replace the placeholder values below with your own values.
1315

1416
### Request URL
@@ -21,7 +23,7 @@ Use the following **GET** request to get the status of your model's training pro
2123
|---------|---------|---------|
2224
|`{YOUR-ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2325
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `EmailApp` |
24-
|`{JOB-ID}` | The ID for locating your model's training status. This is in the `location` header value you received when submitted your training job. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
26+
|`{JOB-ID}` | The ID for locating your model's training status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
2527
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest version released. Learn more about other available [API versions](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) | `2022-05-01` |
2628

2729
### Headers

articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/import-project.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Submit a **POST** request using the following URL, headers, and JSON body to imp
1414

1515
### Request URL
1616

17-
Use the following URL when creating your API request. Replace the placeholder values below with your own values.
17+
Use the following URL when creating your API request. Replace the placeholder values with your own values.
1818

1919
```rest
2020
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}
@@ -23,7 +23,7 @@ Use the following URL when creating your API request. Replace the placeholder va
2323
|Placeholder |Value | Example |
2424
|---------|---------|---------|
2525
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
26-
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
26+
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive, and must match the project name in the JSON file you're importing. | `EmailAppDemo` |
2727
|`{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data). | `2022-05-01` |
2828

2929
### Headers
@@ -36,7 +36,7 @@ Use the following header to authenticate your request.
3636

3737
### Body
3838

39-
Use the following sample JSON as your body.
39+
The JSON body you send is similar to the following example. See the [reference documentation](/rest/api/language/2022-10-01-preview/conversational-analysis-authoring/import?tabs=HTTP#successful-import-project) for more details about the JSON object.
4040

4141
```json
4242
{
@@ -96,8 +96,13 @@ Use the following sample JSON as your body.
9696
|Key |Placeholder |Value | Example |
9797
|---------|---------|----------|--|
9898
| api-version | `{API-VERSION}` | The version of the API you're calling. The version used here must be the same API model version in the URL. See the [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) article to learn more. | `2022-05-01` |
99-
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `EmailApp` |
99+
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `EmailAppDemo` |
100100
| `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`|
101-
| `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](../../language-support.md#multi-lingual-option). This includes languages that aren't included in your training documents. | `true`|
101+
| `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](../../language-support.md#multi-lingual-option) including languages that aren't included in your training documents. | `true`|
102102
| `dataset` | `{DATASET}` | See [how to train a model](../../how-to/tag-utterances.md) for information on splitting your data between a testing and training set. Possible values for this field are `Train` and `Test`. |`Train`|
103103

104+
Upon a successful request, the API response will contain an `operation-location` header with a URL you can use to check the status of the import job. It is formatted like this:
105+
106+
```http
107+
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}
108+
```

articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/train-model.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ manager: nitinme
44
ms.service: cognitive-services
55
ms.subservice: language-service
66
ms.topic: include
7-
ms.date: 05/12/2022
7+
ms.date: 03/17/2023
88
ms.author: aahi
99
---
1010

@@ -13,7 +13,7 @@ Create a **POST** request using the following URL, headers, and JSON body to sub
1313

1414
### Request URL
1515

16-
Use the following URL when creating your API request. Replace the placeholder values below with your own values.
16+
Use the following URL when creating your API request. Replace the placeholder values with your own values.
1717

1818
```rest
1919
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:train?api-version={API-VERSION}
@@ -23,7 +23,7 @@ Use the following URL when creating your API request. Replace the placeholder va
2323
|---------|---------|---------|
2424
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2525
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `EmailApp` |
26-
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) released. | `2022-05-01` |
26+
|`{API-VERSION}` | The version of the API you're calling. The value referenced here is for the latest released [model version](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) released. | `2022-05-01` |
2727

2828
### Headers
2929

@@ -36,7 +36,7 @@ Use the following header to authenticate your request.
3636

3737
### Request body
3838

39-
Use the following object in your request. The model will be named `MyModel` once training is complete.
39+
Use the following object in your request. The model will be named after the value you use for the `modelLabel` parameter once training is complete.
4040

4141
```json
4242
{
@@ -67,4 +67,5 @@ Once you send your API request, you will receive a `202` response indicating suc
6767
```rest
6868
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}
6969
```
70+
7071
You can use this URL to get the training job status.

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

Lines changed: 1 addition & 1 deletion
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: quickstart
11-
ms.date: 02/28/2023
11+
ms.date: 03/14/2023
1212
ms.author: aahi
1313
ms.custom: language-service-clu, ignite-fall-2021, mode-other
1414
zone_pivot_groups: usage-custom-language-features

0 commit comments

Comments
 (0)