Skip to content

Commit 83f4cbf

Browse files
committed
updating CLU rest api
1 parent 0705e91 commit 83f4cbf

File tree

7 files changed

+27
-16
lines changed

7 files changed

+27
-16
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: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ ms.date: 05/16/2022
99
ms.author: aahi
1010
---
1111

12+
> [!NOTE]
13+
> 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 `location-location` header.
14+
1215
Use the following **GET** request to get the status of your deployment job. Replace the placeholder values below with your own values.
1316

1417
### Request URL
@@ -22,7 +25,7 @@ Use the following **GET** request to get the status of your deployment job. Repl
2225
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2326
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
2427
|`{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` |
28+
|`{JOB-ID}` | The ID for locating your model's training status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
2629
|`{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` |
2730

2831
### Headers

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ ms.author: aahi
1111
ms.custom: language-service-clu
1212
---
1313

14+
> [!NOTE]
15+
> 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 `location-location` header.
16+
1417
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.
1518

1619
```rest
@@ -21,7 +24,7 @@ Use the following **GET** request to query the status of your import job. You ca
2124
|---------|---------|---------|
2225
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2326
|`{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` |
27+
|`{JOB-ID}` | The ID for locating your import job status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
2528
|`{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` |
2629

2730
#### Headers

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

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

12+
> [!NOTE]
13+
> 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 `location-location` header.
14+
1215
Use the following **GET** request to get the status of your model's training progress. Replace the placeholder values below with your own values.
1316

1417
### Request URL
@@ -21,7 +24,7 @@ Use the following **GET** request to get the status of your model's training pro
2124
|---------|---------|---------|
2225
|`{YOUR-ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2326
|`{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` |
27+
|`{JOB-ID}` | The ID for locating your model's training status. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
2528
|`{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` |
2629

2730
### Headers

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 will look similar to the below. 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
{
@@ -101,3 +101,8 @@ Use the following sample JSON as your body.
101101
| `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`|
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 will be 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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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)