Skip to content

Commit b2245df

Browse files
authored
release 'live' 3-7-19 (#1340)
1 parent cf3786c commit b2245df

19 files changed

+236
-442
lines changed

articles/bot-builder-deploy-az-cli.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ After creating the target Web App Bot, you need to download the bot code from th
5050
1. In the **Bot Management** section, click **Build**.
5151
1. Click on **Download Bot source code** link in the right-pane.
5252
1. Follow the prompts to download the code, and then unzip the folder.
53+
1. [!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
5354

5455
### Decrypt the .bot file
5556

@@ -197,6 +198,8 @@ If you are using an [MSA](https://en.wikipedia.org/wiki/Microsoft_account) email
197198
Next, download the bot you just created.
198199
[!INCLUDE [download bot snippet](~/includes/deploy/snippet-download-bot.md)]
199200
201+
[!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
202+
200203
### Decrypt the downloaded .bot file and use in your project
201204
202205
The sensitive information in the .bot file is encrypted.

articles/bot-service-change-hosting-plan.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Follow these steps to download the source code of your existing bot:
2828

2929
1. Within your Azure bot, click the **Settings** tab and expand the **Continuous deployment** section.
3030
2. Click the blue button to download the zip file that contains the source code for your bot.
31+
1. [!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
3132
![Download the bot zip file](~/media/continuous-deployment-consumption-download.png)
3233
3. Extract the contents of the downloaded zip file to a local folder.
3334

articles/bot-service-continuous-deployment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ If you have not configured continuous deployment, you can modify your source fil
2929
To set up publishing from Visual Studio using the `.PublishSettings` file, perform the following steps:
3030

3131
1. In the Azure Portal, click your Bot Service, click the **BUILD** tab, and click **Download zip file**.
32+
1. [!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
3233
3. Extract the contents of the downloaded zip file to a local folder.
3334
4. In Explorer, find the Visual Studio Solution (.sln) file for your bot, and double-click it.
3435
4. In Visual Studio, click **View**, and click **Solution Explorer**.
@@ -62,6 +63,7 @@ This section describes how to enable continuous deployment for a bot that you cr
6263
Follow these steps if you want to use a source control service *other than* Visual Studio Online or Github. Visual Studio Online and Github will pull the source code for your bot from Azure, so users of those two services can skip these steps.
6364

6465
3. For a bot on an App Service plan, find your bot page on Azure, click the **BUILD** tab, find the **Download source code** section, and click **Download zip file**.
66+
1. [!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
6567
1. Create an empty repository within one of the source control systems that Azure supports.
6668

6769
![Source control system](~/media/continuous-integration-sourcecontrolsystem.png)

articles/bot-service-quickstart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ You can download the code to work on it locally.
128128
1. In the **Bot Management** section, click **Build**.
129129
1. Click on **Download Bot source code** link in the right-pane.
130130
1. Follow the prompts to download the code, and then unzip the folder.
131+
1. [!INCLUDE [download keys snippet](~/includes/snippet-abs-key-download.md)]
131132

132133
The code you downloaded uses an encrypted [.bot file](./v4sdk/bot-file-basics.md). You'll need to update `botFilePath` and `botFileSecret` entires in the appsettings.json or .env file.
133134
To do that, go to the Azure portal. Select your bot in the portal, then under **App Service Settings** section, click **Application Settings**. In the **Application Settings** pane, you'll
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
When downloading your bot, you will be given the option to include the settings (containing the keys and secrets) for your bot in your download, which may be necessary for your bot to work. If you choose **Yes**, the `appsettings.json` or `.env` file will have the keys.
132 KB
Loading

articles/resources/TOC.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# Enterprise template
2-
## [Introduction](../v4sdk/bot-builder-enterprise-template-overview.md)
3-
## [Overview](../v4sdk/bot-builder-enterprise-template-overview-detail.md)
4-
## [Create a project](../v4sdk/bot-builder-enterprise-template-create-project.md)
2+
## [Overview](../v4sdk/bot-builder-enterprise-template-overview.md)
3+
## [Get Started](../v4sdk/bot-builder-enterprise-template-getting-started.md)
54
## [Customize template](../v4sdk/bot-builder-enterprise-template-customize.md)
6-
## [Deploy template](../v4sdk/bot-builder-enterprise-template-deployment.md)
7-
## [Analytics](../v4sdk/bot-builder-enterprise-template-powerbi.md)
85
# Virtual Assistant
96
## [Overview](../v4sdk/bot-builder-virtual-assistant-introduction.md)
107
# [FAQ](../bot-service-resources-bot-framework-faq.md)

articles/v4sdk/bot-builder-enterprise-template-create-project.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

articles/v4sdk/bot-builder-enterprise-template-customize.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ monikerRange: 'azure-bot-service-4.0'
1414
> [!NOTE]
1515
> This topic applies to v4 version of the SDK.
1616
17-
## .NET
18-
After you have deployed and tested that the Enterprise Bot Template works end-to-end as listed in the instructions [here](bot-builder-enterprise-template-deployment.md),
17+
After you have deployed and tested that the Enterprise Bot Template works end-to-end as listed in the instructions [here](bot-builder-enterprise-template-getting-started.md),
1918
you can easily customize your bot based on your scenario and needs. The goal of the template is to provide a solid foundation upon which to build your conversational experience.
2019

2120
## Project Structure
@@ -76,56 +75,56 @@ There are two Cognitive Models included with the Enterprise Template by default,
7675
To update an existing LUIS model for the Enterprise Template, perform these steps:
7776
1. Make your changes to the LUIS Model in the [LUIS Portal](http://luis.ai) or using the [LuDown](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/Ludown) and [Luis](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/LUIS) CLI tools.
7877
2. Run the following command to update your Dispatch model to reflect your changes (ensures proper message routing):
79-
```shell
78+
```shell
8079
dispatch refresh --bot "YOUR_BOT.bot" --secret YOUR_SECRET
81-
```
80+
```
8281
3. Run the following command from your project root for each updated model to update their associated LuisGen classes:
83-
```shell
82+
```shell
8483
luis export version --appId [LUIS_APP_ID] --versionId [LUIS_APP_VERSION] --authoringKey [YOUR_LUIS_AUTHORING_KEY] | luisgen --cs [CS_FILE_NAME] -o "\Dialogs\Shared\Resources"
85-
```
84+
```
8685

8786
### Updating an existing QnA Maker knowledge base
8887
To update an existing QnA Maker knowledge base, perform the following steps:
8988
1. Make changes to your QnA Maker knowledge base via the [LuDown](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/Ludown) and [QnA Maker](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/QnAMaker) CLI tools or the [QnA Maker Portal](https://qnamaker.ai).
9089
2. Run the following command to update your Dispatch model to reflect your changes (ensures proper message routing):
91-
```shell
90+
```shell
9291
dispatch refresh --bot "YOUR_BOT.bot" --secret YOUR_SECRET
93-
```
92+
```
9493

9594
### Adding a new LUIS model
9695

9796
In scenarios where you wish to add a new LUIS model to your project you need to update the Bot configuration and Dispatcher to ensure it is aware of the additional model.
9897
1. Create your LUIS model through LuDown/LUIS CLI tools or through the LUIS portal
9998
2. Run the following command to connect your new LUIS app to your .bot file:
100-
```shell
99+
```shell
101100
msbot connect luis --appId [LUIS_APP_ID] --authoringKey [LUIS_AUTHORING_KEY] --subscriptionKey [LUIS_SUBSCRIPTION_KEY]
102-
```
101+
```
103102
3. Add this new LUIS model to your Dispatcher through the following command
104-
```shell
103+
```shell
105104
dispatch add -t luis -id LUIS_APP_ID -bot "YOUR_BOT.bot" --secret YOURSECRET
106-
```
105+
```
107106
4. Refresh the dispatch model to reflect the LUIS model changes through the following command
108-
```shell
107+
```shell
109108
dispatch refresh -bot "YOUR_BOT.bot" --secret YOUR_SECRET
110-
```
109+
```
111110

112111
### Adding an additional QnA Maker knowledge base
113112

114113
In some scenarios you may wish to add an addditional QnA Maker knowledge base to your Bot, this can be performed through the following steps.
115114

116115
1. Create a new QnA Maker knowledge base from a JSON file using the following command executed in your assistant directory
117-
```shell
118-
qnamaker create kb --in <KB.json> --msbot | msbot connect qna --stdin --bot "YOUR_BOT.bot" --secret YOURSECRET
119-
```
116+
```shell
117+
qnamaker create kb --in <KB.json> --msbot | msbot connect qna --stdin --bot "YOUR_BOT.bot" --secret YOURSECRET
118+
```
120119
2. Run the following command to update your Dispatch model to reflect your changes
121-
```shell
122-
dispatch refresh --bot "YOUR_BOT.bot" --secret YOUR_SECRET
123-
```
120+
```shell
121+
dispatch refresh --bot "YOUR_BOT.bot" --secret YOUR_SECRET
122+
```
124123
3. Update the strongly typed Dispatch class to reflect the new QnA source
125-
```shell
126-
msbot get dispatch --bot "YOUR_BOT.bot" | luis export version --stdin > dispatch.json
127-
luisgen dispatch.json -cs Dispatch -o Dialogs\Shared
128-
```
124+
```shell
125+
msbot get dispatch --bot "YOUR_BOT.bot" | luis export version --stdin > dispatch.json
126+
luisgen dispatch.json -cs Dispatch -o Dialogs\Shared
127+
```
129128
4. Update the `Dialogs\Main\MainDialog.cs` file to include the corresponding Dispatch intent for your new QnA source following the example provided.
130129

131130
You should now be able to leverage multiple QnA sources as part of your Bot.
@@ -198,6 +197,3 @@ await _responder.ReplyWith(sc.Context, OnboardingResponses.ResponseIds.HaveNameM
198197
The final piece of Dialog infrastruture is the creation of a State class scoped to your Dialog only. Create a new class and ensure it derives from `DialogState`
199198
200199
Once your dialog is complete, your need to add the dialog to your `MainDialog` component using `AddDialog`. To use your new Dialog, call `dc.BeginDialogAsync()` from within your `RouteAsync` method, triggering with the appropriate LUIS intent if desired.
201-
202-
## Conversational insights using PowerBI dashboard and Application Insights
203-
- To get started with getting Conversational insights, continue with [Configure conversational analytics with PowerBI dashboard](bot-builder-enterprise-template-powerbi.md).

0 commit comments

Comments
 (0)