You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/quickstarts/rest-api.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ manager: nitinme
5
5
ms.service: cognitive-services
6
6
ms.subservice: language-service
7
7
ms.topic: include
8
-
ms.date: 06/07/2022
8
+
ms.date: 03/14/2023
9
9
ms.author: aahi
10
10
ms.custom: ignite-fall-2021
11
11
---
@@ -32,7 +32,7 @@ ms.custom: ignite-fall-2021
32
32
> [!div class="nextstepaction"]
33
33
> <ahref="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>
34
34
35
-
## Create a CLU project
35
+
## Import a new CLU sample project
36
36
37
37
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.
38
38
@@ -41,36 +41,32 @@ For this quickstart, you can download [this sample project](https://go.microsoft
41
41
> [!div class="nextstepaction"]
42
42
> <ahref="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>
43
43
44
-
### Trigger import project job
44
+
### Trigger the import project job
45
45
46
46
[!INCLUDE [create and import project](../rest-api/import-project.md)]
47
47
48
48
> [!div class="nextstepaction"]
49
49
> <ahref="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>
> <ahref="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>
57
57
58
-
## Train your model
58
+
## Start training your model
59
59
60
60
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.
61
61
62
-
### Start training your model
63
-
64
-
After your project has been imported, you can start training your model.
> <ahref="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>
70
66
71
-
### Get Training Status
67
+
### Get the training job status
72
68
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.
74
70
75
71
[!INCLUDE [get training model status](../rest-api/get-training-status.md)]
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-deployment-status.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,9 @@ ms.date: 05/16/2022
9
9
ms.author: aahi
10
10
---
11
11
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
+
12
15
Use the following **GET** request to get the status of your deployment job. Replace the placeholder values below with your own values.
13
16
14
17
### Request URL
@@ -22,7 +25,7 @@ Use the following **GET** request to get the status of your deployment job. Repl
22
25
|`{ENDPOINT}`| The endpoint for authenticating your API request. |`https://<your-custom-subdomain>.cognitiveservices.azure.com`|
23
26
|`{PROJECT-NAME}`| The name for your project. This value is case-sensitive. |`myProject`|
24
27
|`{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`|
26
29
|`{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`|
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-import-status.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,9 @@ ms.author: aahi
11
11
ms.custom: language-service-clu
12
12
---
13
13
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
+
14
17
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.
15
18
16
19
```rest
@@ -21,7 +24,7 @@ Use the following **GET** request to query the status of your import job. You ca
21
24
|---------|---------|---------|
22
25
|`{ENDPOINT}`| The endpoint for authenticating your API request. |`https://<your-custom-subdomain>.cognitiveservices.azure.com`|
23
26
|`{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`|
25
28
|`{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`|
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/get-training-status.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,9 @@ ms.date: 05/12/2022
9
9
ms.author: aahi
10
10
---
11
11
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
+
12
15
Use the following **GET** request to get the status of your model's training progress. Replace the placeholder values below with your own values.
13
16
14
17
### Request URL
@@ -21,7 +24,7 @@ Use the following **GET** request to get the status of your model's training pro
21
24
|---------|---------|---------|
22
25
|`{YOUR-ENDPOINT}`| The endpoint for authenticating your API request. |`https://<your-custom-subdomain>.cognitiveservices.azure.com`|
23
26
|`{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`|
25
28
|`{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`|
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/import-project.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Use the following header to authenticate your request.
36
36
37
37
### Body
38
38
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.
40
40
41
41
```json
42
42
{
@@ -101,3 +101,8 @@ Use the following sample JSON as your body.
101
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`|
102
102
|`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`|
103
103
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:
Copy file name to clipboardExpand all lines: articles/cognitive-services/language-service/conversational-language-understanding/includes/rest-api/train-model.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,4 +67,5 @@ Once you send your API request, you will receive a `202` response indicating suc
0 commit comments