Merge pull request #103958 from diberry/diberry/0211-luis-spelling

[Cogsvcs] LUIS - spell check

Author: v-albemi

articles/cognitive-services/LUIS/developer-reference-resource.md

@@ -2,12 +2,12 @@
 title: Developer resources - Language Understanding
 description: SDKs, REST APIs, CLI, help you develop Language Understanding (LUIS) apps in your programming language. Manage your Azure resources and LUIS predictions.
 ms.topic: reference
-ms.date: 02/09/2020
+ms.date: 02/11/2020
 ---
 
 # SDK, REST, and CLI developer resources for Language Understanding (LUIS)
 
-SDKs, REST APIs, CLI, help you develop Language Understanding (LUIS) apps in your programming language. Manage your Azure resources and LUIS predictions. 
+SDKs, REST APIs, CLI, help you develop Language Understanding (LUIS) apps in your programming language. Manage your Azure resources and LUIS predictions.
 
 ## Azure resource management
 
@@ -31,6 +31,10 @@ Learn about the [V3 prediction endpoint](luis-migration-api-v3.md).
 
 Use [Cognitive Services sample code](https://github.com/Azure-Samples/cognitive-services-quickstart-code) to learn and use the most common tasks.
 
+### REST specifications
+
+The [LUIS REST specifications](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/cognitiveservices/data-plane/LUIS), along with all [Azure REST specifications](https://github.com/Azure/azure-rest-api-specs), are publicly available on GitHub.
+
 ### REST APIs
 
 Both authoring and prediction endpoint APIS are available from REST APIs:
@@ -40,6 +44,29 @@ Both authoring and prediction endpoint APIS are available from REST APIs:
 |Authoring|[V2](https://go.microsoft.com/fwlink/?linkid=2092087)<br>[preview V3](https://westeurope.dev.cognitive.microsoft.com/docs/services/luis-programmatic-apis-v3-0-preview)|
 |Prediction|[V2](https://go.microsoft.com/fwlink/?linkid=2092356)<br>[V3](https://westcentralus.dev.cognitive.microsoft.com/docs/services/luis-endpoint-api-v3-0/)|
 
+### REST Endpoints
+
+LUIS currently has 2 types of endpoints:
+
+* authoring on the training endpoint
+* query prediction on the runtime endpoint.
+
+|Purpose|URL|
+|--|--|
+|Authoring on training endpoint|`https://{your-resource-name}.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appID}/`|
+|V2 Runtime - all predictions on runtime endpoint|`https://{your-resource-name}.api.cognitive.microsoft.com/luis/v2.0/apps/{appId}?q={q}[&timezoneOffset][&verbose][&spellCheck][&staging][&bing-spell-check-subscription-key][&log]`|
+|V3 Runtime - versions prediction on runtime endpoint|`https://{your-resource-name}.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?query={query}[&verbose][&log][&show-all-intents]`|
+|V3 Runtime - slot prediction on runtime endpoint|`https://{your-resource-name}.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict?query={query}[&verbose][&log][&show-all-intents]`|
+
+The following table explains the parameters, denoted with curly braces `{}`, in the previous table.
+
+|Parameter|Purpose|
+|--|--|
+|`your-resource-name`|Azure resource name|
+|`q` or `query`|utterance text sent from client application such as chat bot|
+|`version`|10 character version name|
+|`slot`| `production` or `staging`|
+
 ### Language-based SDKs
 
 |Language |Reference documentation|Package|Samples|Quickstarts|
@@ -72,7 +99,7 @@ Bot framework provides [several tools](https://github.com/microsoft/botbuilder-t
 * [Dispatch](https://github.com/microsoft/botbuilder-tools/blob/master/packages/Dispatch)- manage parent and child apps
 * [LUISGen](https://github.com/microsoft/botbuilder-tools/blob/master/packages/LUISGen) - Auto generate backing C#/Typescript classes for your LUIS intents and entities.
 * [Bot Framework emulator](https://github.com/Microsoft/BotFramework-Emulator/releases) - a desktop application that allows bot developers to test and debug bots built using the Bot Framework SDK
-
+* [Bot Framework Composer](https://github.com/microsoft/BotFramework-Composer/blob/stable/README.md) - an integrated development tool for developers and multi-disciplinary teams to build bots and conversational experiences with the Microsoft Bot Framework
 
 ## Next steps
 

articles/cognitive-services/LUIS/luis-concept-data-alteration.md

@@ -1,34 +1,25 @@
 ---
 title: Data alteration - LUIS
-titleSuffix: Azure Cognitive Services
 description: Learn how data can be changed before predictions in Language Understanding (LUIS)
-services: cognitive-services
-author: diberry
-manager: nitinme
-ms.custom: seodec18
-ms.service: cognitive-services
-ms.subservice: language-understanding
 ms.topic: conceptual
-ms.date: 11/19/2019
-ms.author: diberry
+ms.date: 02/11/2020
 ---
 
 # Alter utterance data before or during prediction
-LUIS provides ways to manipulate the utterance before or during the prediction. These include [fixing spelling](luis-tutorial-bing-spellcheck.md), and fixing timezone issues for prebuilt [datetimeV2](luis-reference-prebuilt-datetimev2.md). 
+LUIS provides ways to manipulate the utterance before or during the prediction. These include [fixing spelling](luis-tutorial-bing-spellcheck.md), and fixing timezone issues for prebuilt [datetimeV2](luis-reference-prebuilt-datetimev2.md).
 
 ## Correct spelling errors in utterance
 
-[!INCLUDE [Not supported in V3 API prediction endpoint](./includes/v2-support-only.md)]
 
+### V3 runtime
 
-LUIS uses [Bing Spell Check API V7](../Bing-Spell-Check/overview.md) to correct spelling errors in the utterance. LUIS needs the key associated with that service. Create the key, then add the key as a querystring parameter at the [endpoint](https://go.microsoft.com/fwlink/?linkid=2092356). 
+Preprocess text for spelling corrections before you send the utterance to LUIS. Use example utterances with the correct spelling to ensure you get the correct predictions.
 
-<!--
-You can also correct spelling errors in the **Test** panel by [entering the key](luis-interactive-test.md#view-bing-spell-check-corrections-in-test-panel). The key is kept as a session variable in the browser for the Test panel. Add the key to the Test panel in each browser session you want spelling corrected. 
+Use [Bing Spell Check](../bing-spell-check/overview.md) to correct text before sending it to LUIS.
 
-Usage of the key in the test panel and at the endpoint count toward the [key usage](https://azure.microsoft.com/pricing/details/cognitive-services/spellcheck-api/) quota. LUIS implements Bing Spell Check limits for text length. 
+### Prior to V3 runtime
 
--->
+LUIS uses [Bing Spell Check API V7](../Bing-Spell-Check/overview.md) to correct spelling errors in the utterance. LUIS needs the key associated with that service. Create the key, then add the key as a querystring parameter at the [endpoint](https://go.microsoft.com/fwlink/?linkid=2092356).
 
 The endpoint requires two params for spelling corrections to work:
 
@@ -54,7 +45,7 @@ When [Bing Spell Check API V7](https://azure.microsoft.com/services/cognitive-se
 ```
 
 #### [V3 prediction endpoint response](#tab/V3)
- 
+
 ```JSON
 {
     "query": "Book a flite to London?",
@@ -71,16 +62,16 @@ When [Bing Spell Check API V7](https://azure.microsoft.com/services/cognitive-se
 }
 ```
 
-* * * 
+* * *
 
 ### List of allowed words
 The Bing spell check API used in LUIS does not support a list of words to ignore during the spell check alterations. If you need to allow a list of words or acronyms, process the utterance in the client application before sending the utterance to LUIS for intent prediction.
 
 ## Change time zone of prebuilt datetimeV2 entity
-When a LUIS app uses the prebuilt [datetimeV2](luis-reference-prebuilt-datetimev2.md) entity, a datetime value can be returned in the prediction response. The timezone of the request is used to determine the correct datetime to return. If the request is coming from a bot or another centralized application before getting to LUIS, correct the timezone LUIS uses. 
+When a LUIS app uses the prebuilt [datetimeV2](luis-reference-prebuilt-datetimev2.md) entity, a datetime value can be returned in the prediction response. The timezone of the request is used to determine the correct datetime to return. If the request is coming from a bot or another centralized application before getting to LUIS, correct the timezone LUIS uses.
 
 ### Endpoint querystring parameter
-The timezone is corrected by adding the user's timezone to the [endpoint](https://go.microsoft.com/fwlink/?linkid=2092356) using the `timezoneOffset` param. The value of `timezoneOffset` should be the positive or negative number, in minutes, to alter the time.  
+The timezone is corrected by adding the user's timezone to the [endpoint](https://go.microsoft.com/fwlink/?linkid=2092356) using the `timezoneOffset` param. The value of `timezoneOffset` should be the positive or negative number, in minutes, to alter the time.
 
 |Param|Value|
 |--|--|
@@ -91,11 +82,11 @@ If you need the returned prebuilt datetimeV2 to adjust for daylight savings time
 
 #### [V2 prediction endpoint request](#tab/V2)
 
-Add 60 minutes: 
+Add 60 minutes:
 
 https://{region}.api.cognitive.microsoft.com/luis/v2.0/apps/{appId}?q=Turn the lights on?**timezoneOffset=60**&verbose={boolean}&spellCheck={boolean}&staging={boolean}&bing-spell-check-subscription-key={string}&log={boolean}
 
-Remove 60 minutes: 
+Remove 60 minutes:
 
 https://{region}.api.cognitive.microsoft.com/luis/v2.0/apps/{appId}?q=Turn the lights on?**timezoneOffset=-60**&verbose={boolean}&spellCheck={boolean}&staging={boolean}&bing-spell-check-subscription-key={string}&log={boolean}
 
@@ -105,13 +96,13 @@ Add 60 minutes:
 
 https://{region}.api.cognitive.microsoft.com/luis/v3.0-preview/apps/{appId}/slots/production/predict?query=Turn the lights on?**timezoneOffset=60**&spellCheck={boolean}&bing-spell-check-subscription-key={string}&log={boolean}
 
-Remove 60 minutes: 
+Remove 60 minutes:
 
 https://{region}.api.cognitive.microsoft.com/luis/v3.0-preview/apps/{appId}/slots/production/predict?query=Turn the lights on?**timezoneOffset=-60**&spellCheck={boolean}&bing-spell-check-subscription-key={string}&log={boolean}
 
 Learn more about the [V3 prediction endpoint](luis-migration-api-v3.md).
 
-* * * 
+* * *
 
 ## C# code determines correct value of timezoneOffset
 The following C# code uses the [TimeZoneInfo](https://docs.microsoft.com/dotnet/api/system.timezoneinfo) class's [FindSystemTimeZoneById](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid#examples) method to determine the correct `timezoneOffset` based on system time:

articles/cognitive-services/LUIS/luis-interactive-test.md

@@ -1,21 +1,13 @@
 ---
 title: Test app in LUIS portal
-titleSuffix: Azure Cognitive Services
 description: Use Language Understanding (LUIS) to continuously work on your application to refine it and improve its language understanding.
-services: cognitive-services
-author: diberry
-manager: nitinme
-ms.custom: seodec18
-ms.service: cognitive-services
-ms.subservice: language-understanding
 ms.topic: conceptual
 ms.date: 11/19/2019
-ms.author: diberry
 ---
 
 # Test your LUIS app in the LUIS portal
 
-[Testing](luis-concept-test.md) an app is an iterative process. After training your LUIS app, test it with sample utterances to see if the intents and entities are recognized correctly. If they're not, make updates to the LUIS app, train, and test again. 
+[Testing](luis-concept-test.md) an app is an iterative process. After training your LUIS app, test it with sample utterances to see if the intents and entities are recognized correctly. If they're not, make updates to the LUIS app, train, and test again.
 
 [!INCLUDE [Uses preview portal](includes/uses-portal-preview.md)]
 
@@ -27,13 +19,13 @@ ms.author: diberry
 
 ## Train before testing
 
-In order to test against the most recent version of the active app, select **Train** from the top menu, before testing. 
+In order to test against the most recent version of the active app, select **Train** from the top menu, before testing.
 
 ## Test an utterance
 
-The test utterance should not be exactly the same as any example utterances in the app. The test utterance should include word choice, phrase length, and entity usage you expect for a user. 
+The test utterance should not be exactly the same as any example utterances in the app. The test utterance should include word choice, phrase length, and entity usage you expect for a user.
 
-1. Access your app by selecting its name on the **My Apps** page. 
+1. Access your app by selecting its name on the **My Apps** page.
 
 1. To access the **Test** slide-out panel, select **Test** in your application's top panel.
 
@@ -48,9 +40,9 @@ The test utterance should not be exactly the same as any example utterances in t
 
 ## Inspect score
 
-You inspect details of the test result in the **Inspect** panel. 
- 
-1. With the **Test** slide-out panel open, select **Inspect** for an utterance you want to compare. 
+You inspect details of the test result in the **Inspect** panel.
+
+1. With the **Test** slide-out panel open, select **Inspect** for an utterance you want to compare.
 
     ![Select Inspect button to see more details about the test results](./media/luis-how-to-interactive-test/inspect.png)
 
@@ -68,7 +60,7 @@ You inspect details of the test result in the **Inspect** panel.
 
 ## View sentiment results
 
-If **Sentiment analysis** is configured on the **[Publish](luis-how-to-publish-app.md#enable-sentiment-analysis)** page, the test results include the sentiment found in the utterance. 
+If **Sentiment analysis** is configured on the **[Publish](luis-how-to-publish-app.md#enable-sentiment-analysis)** page, the test results include the sentiment found in the utterance.
 
 ![Image of Test pane with sentiment analysis](./media/luis-how-to-interactive-test/sentiment.png)
 
@@ -78,7 +70,7 @@ If you are using [Patterns](luis-concept-patterns.md) and the utterance matched
 
 ## Compare with published version
 
-You can test the active version of your app with the published [endpoint](luis-glossary.md#endpoint) version. In the **Inspect** panel, select **Compare with published**. Any testing against the published model is deducted from your Azure subscription quota balance. 
+You can test the active version of your app with the published [endpoint](luis-glossary.md#endpoint) version. In the **Inspect** panel, select **Compare with published**. Any testing against the published model is deducted from your Azure subscription quota balance.
 
 ![Compare with published](./media/luis-how-to-interactive-test/inspect-panel-compare.png)
 
@@ -87,55 +79,22 @@ You can view the endpoint JSON returned for the comparison by selecting the **Sh
 
 ![Published JSON response](./media/luis-how-to-interactive-test/inspect-panel-compare-json.png)
 
-<!--Service name is 'Bing Spell Check v7 API' in the portal-->
 ## Additional settings in test panel
 
 ### LUIS endpoint
 
-If you have several LUIS endpoints, use the **Additional Settings** link on the Test's Published pane to change the endpoint used for testing. If you are not sure which endpoint to use, select the default **Starter_Key**. 
+If you have several LUIS endpoints, use the **Additional Settings** link on the Test's Published pane to change the endpoint used for testing. If you are not sure which endpoint to use, select the default **Starter_Key**.
 
 > [!div class="mx-imgBorder"]
 > ![Test panel with Additional Settings link highlighted](media/luis-how-to-interactive-test/additional-settings-v3-settings.png)
 
-<!--
-###  View Bing Spell Check corrections in test panel
-
-Requirements to view the spelling corrections: 
-
-* Published app
-* Bing Spell Check [service key](https://azure.microsoft.com/try/cognitive-services/?api=spellcheck-api). The service key is not stored and needs to be reset for each browser session. 
-
-Use the following procedure to include the [Bing Spell Check v7](https://azure.microsoft.com/services/cognitive-services/spell-check/) service  in the Test pane results. 
-
-1. In the **Test** pane, enter an utterance. When the utterance is predicted, select **[Inspect](#inspect-score)** underneath the utterance you entered. 
-
-1. When the **Inspect** panel opens, select **[Compare with Published](#compare-with-published-version)**. 
-
-1. When the **Published** panel opens, select **[Additional Settings](#additional-settings-in-test-panel)**.
-
-1. In the pop-up dialog, check **Enable Bing Spell Check** and enter the key, then select **Done**. 
-    ![Enter Bing Spell Check service key](./media/luis-how-to-interactive-test/interactive-with-spell-check-service-key-text.png)
-
-1. Enter a query with an incorrect spelling such as `book flite to seattle` and select enter. The incorrect spelling of the word `flite` is replaced in the query sent to LUIS and the resulting JSON shows both the original query, as `query`, and the corrected spelling in the query, as `alteredQuery`.
-
-<a name="json-file-with-no-duplicates"></a>
-<a name="import-a-dataset-file-for-batch-testing"></a>
-<a name="export-rename-delete-or-download-dataset"></a>
-<a name="run-a-batch-test-on-your-trained-app"></a>
-<a name="access-batch-test-result-details-in-a-visualized-view"></a>
-<a name="filter-chart-results-by-intent-or-entity"></a>
-<a name="investigate-false-sections"></a>
-<a name="view single-point utterance data"></a>
-<a name="relabel-utterances-and-retrain"></a>
-<a name="false-test-results"></a>
--->
 
 ## Batch testing
 See batch testing [concepts](luis-concept-batch-test.md) and learn [how to](luis-how-to-batch-test.md) test a batch of utterances.
 
 ## Next steps
 
-If testing indicates that your LUIS app doesn't recognize the correct intents and entities, you can work to improve your LUIS app's accuracy by labeling more utterances or adding features. 
+If testing indicates that your LUIS app doesn't recognize the correct intents and entities, you can work to improve your LUIS app's accuracy by labeling more utterances or adding features.
 
-* [Label suggested utterances with LUIS](luis-how-to-review-endpoint-utterances.md) 
-* [Use features to improve your LUIS app's performance](luis-how-to-add-features.md) 
+* [Label suggested utterances with LUIS](luis-how-to-review-endpoint-utterances.md)
+* [Use features to improve your LUIS app's performance](luis-how-to-add-features.md)