Skip to content

Commit 2cb664e

Browse files
authored
Merge pull request #95362 from diberry/diberry/1109-luis-how-to
[Cogsvcs] LUIS - start new app
2 parents 9d17916 + 74a9007 commit 2cb664e

File tree

6 files changed

+31
-46
lines changed

6 files changed

+31
-46
lines changed

articles/cognitive-services/LUIS/luis-container-howto.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: language-understanding
1111
ms.topic: conceptual
12-
ms.date: 11/04/2019
12+
ms.date: 11/08/2019
1313
ms.author: dapine
1414
---
1515

@@ -31,7 +31,7 @@ To run the LUIS container, note the following prerequisites:
3131
|--|--|
3232
|Docker Engine| You need the Docker Engine installed on a [host computer](#the-host-computer). Docker provides packages that configure the Docker environment on [macOS](https://docs.docker.com/docker-for-mac/), [Windows](https://docs.docker.com/docker-for-windows/), and [Linux](https://docs.docker.com/engine/installation/#supported-platforms). For a primer on Docker and container basics, see the [Docker overview](https://docs.docker.com/engine/docker-overview/).<br><br> Docker must be configured to allow the containers to connect with and send billing data to Azure. <br><br> **On Windows**, Docker must also be configured to support Linux containers.<br><br>|
3333
|Familiarity with Docker | You should have a basic understanding of Docker concepts, like registries, repositories, containers, and container images, as well as knowledge of basic `docker` commands.|
34-
|Azure `Cognitive Services` resource and LUIS [packaged app](luis-how-to-start-new-app.md#export-app-for-containers) file |In order to use the container, you must have:<br><br>* A _Cognitive Services_ Azure resource and the associated billing key the billing endpoint URI. Both values are available on the Overview and Keys pages for the resource and are required to start the container. <br>* A trained or published app packaged as a mounted input to the container with its associated App ID. You can get the packaged file from the LUIS portal or the Authoring APIs. If you are getting LUIS packaged app from the [authoring APIs](#authoring-apis-for-package-file), you will also need your _Authoring Key_.<br><br>These requirements are used to pass command-line arguments to the following variables:<br><br>**{AUTHORING_KEY}**: This key is used to get the packaged app from the LUIS service in the cloud and upload the query logs back to the cloud. The format is `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`.<br><br>**{APP_ID}**: This ID is used to select the App. The format is `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.<br><br>**{API_KEY}**: This key is used to start the container. You can find the endpoint key in two places. The first is the Azure portal within the _Cognitive Services_ resource's keys list. The endpoint key is also available in the LUIS portal on the Keys and Endpoint settings page. Do not use the starter key.<br><br>**{ENDPOINT_URI}**: The endpoint as provided on the Overview page.<br><br>The [authoring key and endpoint key](luis-boundaries.md#key-limits) have different purposes. Do not use them interchangeably. |
34+
|Azure `Cognitive Services` resource and LUIS [packaged app](luis-how-to-start-new-app.md) file |In order to use the container, you must have:<br><br>* A _Cognitive Services_ Azure resource and the associated billing key the billing endpoint URI. Both values are available on the Overview and Keys pages for the resource and are required to start the container. <br>* A trained or published app packaged as a mounted input to the container with its associated App ID. You can get the packaged file from the LUIS portal or the Authoring APIs. If you are getting LUIS packaged app from the [authoring APIs](#authoring-apis-for-package-file), you will also need your _Authoring Key_.<br><br>These requirements are used to pass command-line arguments to the following variables:<br><br>**{AUTHORING_KEY}**: This key is used to get the packaged app from the LUIS service in the cloud and upload the query logs back to the cloud. The format is `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`.<br><br>**{APP_ID}**: This ID is used to select the App. The format is `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.<br><br>**{API_KEY}**: This key is used to start the container. You can find the endpoint key in two places. The first is the Azure portal within the _Cognitive Services_ resource's keys list. The endpoint key is also available in the LUIS portal on the Keys and Endpoint settings page. Do not use the starter key.<br><br>**{ENDPOINT_URI}**: The endpoint as provided on the Overview page.<br><br>The [authoring key and endpoint key](luis-boundaries.md#key-limits) have different purposes. Do not use them interchangeably. |
3535

3636
[!INCLUDE [Gathering required container parameters](../containers/includes/container-gathering-required-parameters.md)]
3737

articles/cognitive-services/LUIS/luis-how-to-start-new-app.md

Lines changed: 25 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: language-understanding
1111
ms.topic: conceptual
12-
ms.date: 10/25/2019
12+
ms.date: 11/08/2019
1313
ms.author: diberry
1414
---
1515

1616
# Create a new LUIS app in the LUIS portal
17-
There are a couple of ways to create a LUIS app. You can create a LUIS app in the [LUIS](https://www.luis.ai) portal, or through the LUIS authoring [APIs](https://westus.dev.cognitive.microsoft.com/docs/services/5890b47c39e2bb17b84a55ff/operations/5890b47c39e2bb052c5b9c2f).
17+
There are a couple of ways to create a LUIS app. You can create a LUIS app in the LUIS portal, or through the LUIS authoring [APIs](developer-reference-resource.md).
1818

19-
[!INCLUDE [Waiting for LUIS portal refresh](./includes/wait-v3-upgrade.md)]
19+
[!INCLUDE [Uses preview portal](includes/uses-portal-preview.md)]
2020

2121
## Using the LUIS portal
2222

23-
You can create a new app in the LUIS portal in several ways:
23+
You can create a new app in the preview portal in several ways:
2424

2525
* Start with an empty app and create intents, utterances, and entities.
2626
* Start with an empty app and add a [prebuilt domain](luis-how-to-use-prebuilt-domains.md).
27-
* Import a LUIS app from a JSON file that already contains intents, utterances, and entities.
27+
* Import a LUIS app from a `.lu` or `.json` file that already contains intents, utterances, and entities.
2828

2929
## Using the authoring APIs
3030
You can create a new app with the authoring APIs in a couple of ways:
3131

32-
* [Start](https://westus.dev.cognitive.microsoft.com/docs/services/5890b47c39e2bb17b84a55ff/operations/5890b47c39e2bb052c5b9c2f) with an empty app and create intents, utterances, and entities.
33-
* [Start](https://westus.dev.cognitive.microsoft.com/docs/services/5890b47c39e2bb17b84a55ff/operations/59104e515aca2f0b48c76be5) with a prebuilt domain.
32+
* [Add application](https://westeurope.dev.cognitive.microsoft.com/docs/services/luis-programmatic-apis-v3-0-preview/operations/5890b47c39e2bb052c5b9c2f) - start with an empty app and create intents, utterances, and entities.
33+
* [Add prebuilt application](https://westeurope.dev.cognitive.microsoft.com/docs/services/luis-programmatic-apis-v3-0-preview/operations/59104e515aca2f0b48c76be5) - start with a prebuilt domain, including intents, utterances, and entities.
3434

3535

3636
<a name="export-app"></a>
@@ -42,51 +42,36 @@ You can create a new app with the authoring APIs in a couple of ways:
4242

4343
## Create new app in LUIS
4444

45-
1. On **My Apps** page, select **+ Create**.
45+
1. On **My Apps** page, select your subscription, and authoring resource then **+ Create**. If you are using free trial key, learn how to [create an authoring resource](luis-how-to-azure-subscription.md#create-resources-in-the-azure-portal).
4646

47-
![LUIS apps list](./media/luis-create-new-app/apps-list.png)
47+
![LUIS apps list](./media/create-app-in-portal.png)
4848

4949

50-
2. In the dialog box, name your application "TravelAgent".
50+
1. In the dialog box, enter the name of your application, such as `Pizza Tutorial`.
5151

52-
![Create new app dialog](./media/luis-create-new-app/create-app.png)
52+
![Create new app dialog](./media/create-pizza-tutorial-app-in-portal.png)
5353

54-
3. Choose your application culture (for TravelAgent app, choose English), and then select **Done**.
54+
1. Choose your application culture, and then select **Done**. The description and prediction resource are optional at this point. You can set then at any time in the **Manage** section of the portal.
5555

5656
> [!NOTE]
5757
> The culture cannot be changed once the application is created.
5858
59-
## Import an app from file
59+
After the app is created, the LUIS portal shows the **Intents** list with the `None` intent already created for you. You now have an empty app.
60+
61+
> [!div class="mx-imgBorder"]
62+
> ![Intents list with None intent created with no example utterances.](media/pizza-tutorial-new-app-empty-intent-list.png)
6063
61-
1. On **My Apps** page, select **Import new app**.
62-
1. In the pop-up dialog, select a valid app JSON file, and then select **Done**.
64+
## Other actions available
6365

64-
### Import errors
66+
The context toolbar provides other actions:
6567

66-
Possible errors are:
67-
68-
* An app with that name already exists. To fix this, reimport the app, and set the **Optional Name** to a new name.
69-
70-
## Export app for backup
71-
72-
1. On **My Apps** page, select **Export**.
73-
1. Select **Export as JSON**. Your browser downloads the active version of the app.
74-
1. Add this file to your backup system to archive the model.
75-
76-
## Export app for containers
77-
78-
1. On **My Apps** page, select **Export**.
79-
1. Select **Export as container** then select which published slot (production or stage) you want to export.
80-
1. Use this file with your [LUIS container](luis-container-howto.md).
81-
82-
If you are interested in exporting a trained but not yet published model to use with the LUIS container, go to the **Versions** page and export from there.
83-
84-
## Delete app
85-
86-
1. On **My Apps** page, select the three dots (...) at the end of the app row.
87-
1. Select **Delete** from the menu.
88-
1. Select **Ok** in the confirmation window.
68+
* Rename app
69+
* Import from file using `.lu` or `.json`
70+
* Export app as `.lu` (for [LUDown](https://github.com/microsoft/botbuilder-tools/tree/master/packages/Ludown)), `.json`, or `.zip` (for [LUIS container](luis-container-howto.md))
71+
* Import container endpoint logs, to review endpoint utterances
72+
* Export endpoint logs, as a `.csv`, for offline analysis
73+
* Delete app
8974

9075
## Next steps
9176

92-
Your first task in the app is to [add intents](luis-how-to-add-intents.md).
77+
If your app design includes intent detection, [create new intents](luis-how-to-add-intents.md), and add example utterances. If your app design is only data extraction, add example utterances to the None intent, then [create entities](luis-how-to-add-example-utterances.md), and label the example utterances with those entities.

articles/cognitive-services/LUIS/luis-language-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: language-understanding
1111
ms.topic: conceptual
12-
ms.date: 10/16/2019
12+
ms.date: 11/08/2019
1313
ms.author: diberry
1414
---
1515

@@ -201,4 +201,4 @@ Tokenizer JSON for version 1.0.1. Notice the property value for `tokenizerVersi
201201

202202
Tokenization happens at the app level. There is no support for version-level tokenization.
203203

204-
[Import the file as a new app](luis-how-to-start-new-app.md#import-an-app-from-file), instead of a version. This action means the new app has a different app ID but uses the tokenizer version specified in the file.
204+
[Import the file as a new app](luis-how-to-start-new-app.md), instead of a version. This action means the new app has a different app ID but uses the tokenizer version specified in the file.
20 KB
Loading
38 KB
Loading

articles/cognitive-services/LUIS/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ services: cognitive-services
99
ms.service: cognitive-services
1010
ms.subservice: language-understanding
1111
ms.topic: conceptual
12-
ms.date: 10/25/2019
12+
ms.date: 11/08/2019
1313
ms.author: diberry
1414
---
1515
# Language Understanding Frequently Asked Questions (FAQ)
@@ -68,7 +68,7 @@ In the LUIS portal, you can label text for the exact entity you are interested i
6868

6969
### I tried to import an app or version file but I got an error, what happened?
7070

71-
Read more about [version import errors](luis-how-to-manage-versions.md#import-errors) and [app import errors](luis-how-to-start-new-app.md#import-errors).
71+
Read more about [version import errors](luis-how-to-manage-versions.md#import-errors).
7272

7373
<a name="luis-collaborating"></a>
7474

0 commit comments

Comments
 (0)