Skip to content

Commit 46483bb

Browse files
authored
Merge pull request #201575 from BaherAbdullah/patch-157
Update quickstart.md
2 parents e97665c + 74f9f74 commit 46483bb

File tree

29 files changed

+64
-63
lines changed

29 files changed

+64
-63
lines changed

articles/cognitive-services/language-service/concepts/model-lifecycle.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ Use the table below to find which API versions are supported by each feature:
101101

102102
| Feature | Supported versions | Latest Generally Available version | Latest preview version |
103103
|-----------------------------------------------------|---------------------------------------------------------------------|------------------------------------|------------------------|
104-
| Custom text classification | `2022-05-01` ,`2022-05-15-preview` | `2022-05-01` | `2022-05-15-preview` |
105-
| Conversational language understanding | `2022-05-01` ,`2022-05-15-preview` | `2022-05-01` | `2022-05-15-preview` |
106-
| Custom named entity recognition | `2022-05-01` ,`2022-05-15-preview` | `2022-05-01` | `2022-05-15-preview` |
107-
| Orchestration workflow | `2022-05-01`,`2022-05-15-preview` | `2022-05-01` | `2022-05-15-preview` |
104+
| Custom text classification | `2022-05-01` | `2022-05-01` | |
105+
| Conversational language understanding | `2022-05-01` | `2022-05-01` | |
106+
| Custom named entity recognition | `2022-05-01` | `2022-05-01` | |
107+
| Orchestration workflow | `2022-05-01` | `2022-05-01` | |
108108

109109

110110
## Next steps

articles/cognitive-services/language-service/conversational-language-understanding/concepts/data-formats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ If you're [importing a project](../how-to/create-project.md#import-project) into
8888

8989
|Key |Placeholder |Value | Example |
9090
|---------|---------|----------|--|
91-
| `api-version` | `{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-03-01-preview` |
91+
| `api-version` | `{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` |
9292
|`confidenceThreshold`|`{CONFIDENCE-THRESHOLD}`|This is the threshold score below which the intent will be predicted as [none intent](none-intent.md)|`0.7`|
9393
| `projectName` | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `EmailApp` |
9494
| `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) for more information about supported language codes. | `true`|

articles/cognitive-services/language-service/conversational-language-understanding/how-to/call-api.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,6 @@ First you will need to get your resource key and endpoint:
4444

4545
# [Client libraries (Azure SDK)](#tab/azure-sdk)
4646

47-
First you will need to get your resource key and endpoint:
48-
49-
[!INCLUDE [Get keys and endpoint Azure Portal](../includes/get-keys-endpoint-azure.md)]
50-
5147
### Use the client libraries (Azure SDK)
5248

5349
You can also use the client libraries provided by the Azure SDK to send requests to your model.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ You can export a Conversational Language Understanding project as a JSON file at
105105

106106
---
107107

108-
## Delete resources
108+
## Delete project
109109

110110
### [Language Studio](#tab/language-studio)
111111

articles/cognitive-services/language-service/conversational-language-understanding/how-to/deploy-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ ms.custom: language-service-clu,
1515

1616
# Deploy a model
1717

18-
Once you are satisfied with how your model performs, it's ready to be deployed, and query it for predictions from utterances. Deploying a model makes it available for use through the [prediction API](https://aka.ms/ct-runtime-swagger).
18+
Once you are satisfied with how your model performs, it's ready to be deployed, and query it for predictions from utterances. Deploying a model makes it available for use through the [prediction API](https://aka.ms/clu-runtime-api).
1919

2020
## Prerequisites
2121

2222
* A successfully [created project](create-project.md)
2323
* [Labeled utterances](tag-utterances.md) and successfully [trained model](train-model.md)
24-
* Reviewed the [model evaluation details](view-model-evaluation.md) to determine how your model is performing.
24+
* Reviewed the [model performance](view-model-evaluation.md) to determine how your model is performing.
2525

2626
See [project development lifecycle](../overview.md#project-development-lifecycle) for more information.
2727

2828
## Deploy model
2929

30-
After you have reviewed the model's performance and decide it's fit to be used in your environment, you need to assign it to a deployment to be able to query it. Assigning the model to a deployment makes it available for use through the [prediction API](https://aka.ms/clu-apis). It is recommended to create a deployment named `production` to which you assign the best model you have built so far and use it in your system. You can create another deployment called `staging` to which you can assign the model you're currently working on to be able to test it. You can have a maximum on 10 deployments in your project.
30+
After you have reviewed the model's performance and decide it's fit to be used in your environment, you need to assign it to a deployment to be able to query it. Assigning the model to a deployment makes it available for use through the [prediction API](https://aka.ms/clu-runtime-api). It is recommended to create a deployment named `production` to which you assign the best model you have built so far and use it in your system. You can create another deployment called `staging` to which you can assign the model you're currently working on to be able to test it. You can have a maximum on 10 deployments in your project.
3131

3232
# [Language Studio](#tab/language-studio)
3333

articles/cognitive-services/language-service/conversational-language-understanding/includes/language-studio/deploy-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To deploy your model from within the [Language Studio](https://aka.ms/LanguageSt
2121
3. Select **Create new deployment** to create a new deployment and assign a trained model from the dropdown below. You can also **Overwrite an existing deployment** by selecting this option and select the trained model you want to assign to it from the dropdown below.
2222

2323
> [!NOTE]
24-
> Overwriting an existing deployment doesn't require changes to your [Prediction API](https://aka.ms/clu-apis) call but the results you get will be based on the newly assigned model.
24+
> Overwriting an existing deployment doesn't require changes to your [Prediction API](https://aka.ms/clu-runtime-api) call but the results you get will be based on the newly assigned model.
2525
2626
:::image type="content" source="../../media/create-deployment-job.png" alt-text="A screenshot showing the screen for adding a new deployment in Language Studio." lightbox="../../media/create-deployment-job.png":::
2727

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create a **POST** request using the following URL, headers, and JSON body to sta
1515
### Request URL
1616

1717
```rest
18-
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments:swap?api-version={API-VERSION}
18+
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}
1919
```
2020

2121
|Placeholder |Value | Example |

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This documentation contains the following article types:
2323

2424
* [Quickstarts](quickstart.md) are getting-started instructions to guide you through making requests to the service.
2525
* [Concepts](concepts/evaluation-metrics.md) provide explanations of the service functionality and features.
26-
* [How-to guides](how-to/tag-utterances.md) contain instructions for using the service in more specific or customized ways.
26+
* [How-to guides](how-to/create-project.md) contain instructions for using the service in more specific or customized ways.
2727

2828

2929
## Example usage scenarios
@@ -61,9 +61,9 @@ Follow these steps to get the most out of your model:
6161

6262
3. **Train model**: Your model starts learning from your labeled data.
6363

64-
4. **View model evaluation details**: View the evaluation details for your model to determine how well it performs when introduced to new data.
64+
4. **Viewmodel evaluation details**: View the evaluation details for your model to determine how well it performs when introduced to new data.
6565

66-
5. **Deploy model**: Deploying a model makes it available for use via the [Runtime API](https://aka.ms/clu-apis).
66+
5. **Deploy model**: Deploying a model makes it available for use via the [Runtime API](https://aka.ms/clu-runtime-api).
6767

6868
6. **Predict intents and entities**: Use your custom model to predict intents and entities from user's utterances.
6969

@@ -75,12 +75,12 @@ As you use CLU, see the following reference documentation and samples for Azure
7575
|---------|---------|---------|
7676
|REST APIs (Authoring) | [REST API documentation](https://aka.ms/clu-authoring-apis) | |
7777
|REST APIs (Runtime) | [REST API documentation](https://aka.ms/clu-apis) | |
78-
|C# | [C# documentation](/dotnet/api/azure.ai.textanalytics?view=azure-dotnet-preview&preserve-view=true) | [C# samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples) |
79-
|Python | [Python documentation](/python/api/overview/azure/ai-textanalytics-readme?view=azure-python-preview&preserve-view=true) | [Python samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations/samples) |
78+
|C# (Runtime) | [C# documentation](/dotnet/api/azure.ai.textanalytics?view=azure-dotnet-preview&preserve-view=true) | [C# samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples) |
79+
|Python (Runtime)| [Python documentation](/python/api/overview/azure/ai-textanalytics-readme?view=azure-python-preview&preserve-view=true) | [Python samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations/samples) |
8080

8181
## Responsible AI
8282

83-
An AI system includes not only the technology, but also the people who will use it, the people who will be affected by it, and the environment in which it's deployed. Read the [transparency note for CLU]() to learn about responsible AI use and deployment in your systems. You can also see the following articles for more information:
83+
An AI system includes not only the technology, but also the people who will use it, the people who will be affected by it, and the environment in which it's deployed. Read the transparency note for CLU to learn about responsible AI use and deployment in your systems. You can also see the following articles for more information:
8484

8585
[!INCLUDE [Responsible AI links](../includes/overview-responsible-ai-links.md)]
8686

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ The following limits are observed for the conversational language understanding.
8383

8484
| Item | Limits |
8585
|--|--|
86-
| Project name | You can only use letters `(a-z, A-Z)`, and numbers `(0-9)` with no spaces. Maximum allowed length is 50 characters. |
86+
| Project name | You can only use letters `(a-z, A-Z)`, and numbers `(0-9)` ,symbols `_ . -`,with no spaces. Maximum allowed length is 50 characters. |
8787
| Model name | You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and symbols `_ . -`. Maximum allowed length is 50 characters. |
8888
| Deployment name | You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and symbols `_ . -`. Maximum allowed length is 50 characters. |
89-
| Intent name | You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and symbols `_ . -`. Maximum allowed length is 50 characters. |
90-
| Entity name | You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and symbols `_ . -`. Maximum allowed length is 50 characters. |
89+
| Intent name| You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and all symbols except ":", `$ & % * ( ) + ~ # / ?`. Maximum allowed length is 50 characters.|
90+
| Entity name| You can only use letters `(a-z, A-Z)`, numbers `(0-9)` and all symbols except ":", `$ & % * ( ) + ~ # / ?`. Maximum allowed length is 50 characters.|
9191

9292
## Next steps
9393

articles/cognitive-services/language-service/custom-named-entity-recognition/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ When you're ready to start [using your model to make predictions](#how-do-i-use-
4444

4545
## What is the recommended CI/CD process?
4646

47-
You can train multiple models on the same dataset within the same project. After you have trained your model successfully, you can [view its evaluation](how-to/view-model-evaluation.md). You can [deploy and test](quickstart.md#deploy-your-model) your model within [Language studio](https://aka.ms/languageStudio). You can add or remove tags from your data and train a **new** model and test it as well. View [service limits](service-limits.md)to learn about maximum number of trained models with the same project. When you [train your data](how-to/train-model.md) you can determine how your dataset is split into training and testing sets. You can also have your data split randomly into training and testing set where there is no guarantee that the reflected model evaluation is about the same test set, and the results are not comparable. It's recommended that you develop your own test set and use it to evaluate both models so you can measure improvement.
47+
You can train multiple models on the same dataset within the same project. After you have trained your model successfully, you can [view its performance](how-to/view-model-evaluation.md). You can [deploy and test](quickstart.md#deploy-your-model) your model within [Language studio](https://aka.ms/languageStudio). You can add or remove labels from your data and train a **new** model and test it as well. View [service limits](service-limits.md)to learn about maximum number of trained models with the same project. When you [train a model](how-to/train-model.md), you can determine how your dataset is split into training and testing sets. You can also have your data split randomly into training and testing set where there is no guarantee that the reflected model evaluation is about the same test set, and the results are not comparable. It's recommended that you develop your own test set and use it to evaluate both models so you can measure improvement.
4848

4949
## Does a low or high model score guarantee bad or good performance in production?
5050

0 commit comments

Comments
 (0)