Skip to content

Commit 8161753

Browse files
authored
merge live 1-10-19 (#1250)
* Release 'live' 12-11-2018 (#1190) (#1193) * Updated values in #update-the-.bot-file (#1191) * bot deploy clarity (#1196) * Updated dispatch content (#1142) * Update docfx.json * Update docfx.json * Update Deployment steps (#1205) * Fix deployment (MicrosoftDocs#1206) * Update bot-builder-deploy-az-cli.md * Add deployment (#1209) * Add the MSA account instructions back in with some modifications. (#1208) * Update bot-service-resources-bot-framework-faq.md (#1212) * Updates to deploying samples article (MicrosoftDocs#1215) * Updates to deploying samples article * Update per feedback * Fix copy-paste error, some formatting. * enteprise bot updates to include chitchat in qna (MicrosoftDocs#1218) * Fixes for various bot-docs issues (#1217) * wip * Addresses bot-docs issue 628 * Fix for bot-docs issue [624](https://github.com/MicrosoftDocs/bot-docs/issues/624) * Fix for Microsoft/bot-docs#655. * copy edit * Fix for [bot-docs 630](https://github.com/MicrosoftDocs/bot-docs/issues/630) * Fix for (Microsoft/bot-docs#612). * Add Troubleshoot bot configuration issues * Add second troubleshooting article, fix warnings in the first. * fix moniker range. * fix metadata keywords in second topic. * Experimental fix. * Fix markup * Minor correction. * Fixes welcome user sample code pointers (#1221) * Fixed aka.ms sample code pointers Somehow these changed to point to the wrong sample, not the one documented step-by-step in our article. * added Ivor's aka.ms link * corrected my "author" name and date * fixed author name again! * Various issue fixes. (#1224) * Fix link to point to the new article. * Remove transparency, expand border. * Remove transparency from images. * Update screenshot per (Microsoft/bot-docs#603) * makes it clearer how you train and publish the LUIS dispatch app (#1225) * Issues fixes 12-20 (#1222) * update dotnet emulator screenshot * update screenshot for dotnet project * fix sentence from issue 607 * make manage toc alphabetic * Issues fixes - samples links, redirect fixes (MicrosoftDocs#1227) * Added reference to the BotFramework-Samples directory * attempted fix at redirect url * Update bot-builder-enterprise-template-deployment.md (MicrosoftDocs#1232) Update to remove "az extension" step. Latest msbot version no longer requires the botservice extension. * Update bot-service-quickstart.md (#1242) * Update bot-service-quickstart.md * Update bot-service-quickstart.md * Update bot-service-quickstart.md (#1244) * Updated ET PowerBI doc to point users to the Conversational AI Telemetry doc on Microsoft/AI repo & updated telemetry properties. (#1214) * Fix java (#1246) * Fix for bot-docs (#684)[Microsoft/bot-docs#684] (MicrosoftDocs#1235) * Fix for bot-docs (#684)[https://github.com/MicrosoftDocs/bot-docs/issues/684] * Attempt to fix markdown * Continue to try to fix markdown * yet one more fix * Add instruction to create resource group before using az bot create * Fix for bot-docs issue 685 * Fix for bot-docs 685 * Update the --proj-name description for JS * include a fix from loc folks. * Update Slack channel doc and bing speech (#1249) * Update Slack channel doc * Update text * tweak wording * remove bing speech from v3 docs
1 parent 2d84d5d commit 8161753

10 files changed

+74
-34
lines changed

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

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: kamrani
88
ms.topic: get-started-article
99
ms.service: bot-service
1010
ms.subservice: abs
11-
ms.date: 12/14/2018
11+
ms.date: 01/07/2019
1212
---
1313

1414
# Deploy your bot using Azure CLI
@@ -19,17 +19,21 @@ After you have created your bot and tested it locally, you can deploy it to Azur
1919

2020
In this article, we'll show you how to deploy C# and JavaScript bots to Azure using `az` and `msbot` cli. It would be useful to read this article before following the steps, so that you fully understand what is involved in deploying a bot.
2121

22-
2322
## Prerequisites
23+
2424
- If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
2525
- Install the latest version of the [Azure cli tool](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest).
26-
- Install the latest `botservice` extension for the `az` tool.
27-
- First, remove the old version using `az extension remove -n botservice` command. Next, use the `az extension add -n botservice` command to install the latest version.
2826
- Install latest version of the [MSBot](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/MSBot) tool.
2927
- Install latest released version of the [Bot Framework Emulator](https://aka.ms/Emulator-wiki-getting-started).
3028
- Install and configure [ngrok](https://github.com/Microsoft/BotFramework-Emulator/wiki/Tunneling-%28ngrok%29).
3129
- Knowledge of [.bot](v4sdk/bot-file-basics.md) file.
3230

31+
With msbot 4.3.2 and later, you need Azure CLI version 2.0.53 or later. If you installed the botservice extension, remove it with this command.
32+
33+
```cmd
34+
az extension remove --name botservice
35+
```
36+
3337
## Deploy JavaScript and C# bots using az cli
3438

3539
You've already created and tested a bot locally, and now you want to deploy it to Azure. These steps assume that you have created the required Azure resources.
@@ -60,7 +64,18 @@ cd <local-bot-folder>
6064

6165
### Create a Web App Bot
6266

63-
Create the bot resource into which you will publish your bot.
67+
If you don't already have a resource group to which to publish your bot, create one:
68+
69+
```cmd
70+
az group create --name <resource-group-name> --location <geographic-location> --verbose
71+
```
72+
73+
| Option | Description |
74+
|:---|:---|
75+
| --name | A unique name for the resource group. DO NOT include spaces or underscores in the name. |
76+
| --location | Geographic location used to create the resource group. For example, `eastus`, `westus`, `westus2`, and so on. Use `az account list-locations` for a list of locations. |
77+
78+
Then, create the bot resource into which you will publish your bot.
6479

6580
Before proceeding, read the instructions that apply to you based on the type of email account you use to log in to Azure.
6681

@@ -181,15 +196,13 @@ At this point, your bot should work the same way it did with the old .bot file.
181196
Publish your local bot to Azure. This step might take a while.
182197

183198
```cmd
184-
az bot publish --name <bot-resource-name> --proj-file "<project-file-name>" --resource-group <resource-group-name> --code-dir <directory-path> --verbose --version v4
199+
az bot publish --name <bot-resource-name> --proj-name "<project-file-name>" --resource-group <resource-group-name> --code-dir <directory-path> --verbose --version v4
185200
```
186201

187-
<!-- Question: What should --proj-file be for a Node project? -->
188-
189202
| Option | Description |
190203
|:---|:---|
191204
| --name | The resource name of the bot in Azure. |
192-
| --proj-file | The startup project file name (without the .csproj) that needs to be published. For example: EnterpriseBot. |
205+
| --proj-name | For C#, use the startup project file name (without the .csproj) that needs to be published. For example: `EnterpriseBot`. For Node.js, use the main entry point for the bot. For example, `index.js`. |
193206
| --resource-group | Name of resource group. |
194207
| --code-dir | The directory to upload bot code from. |
195208

articles/bot-builder-deploy-samples.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,19 @@ It would be useful to read this article once through before following the steps,
3131
- If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/) before you begin.
3232
- Install [.NET Core SDK](https://dotnet.microsoft.com/download) >= v2.2. Use `dotnet --version` to see what version you have.
3333
- Install the latest version of the [Azure cli tool](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest). Use `az --version` to see what version you have.
34-
- Install the latest `botservice` extension for the `az` tool.
35-
- First, remove the old version using `az extension remove -n botservice` command. Next, use the `az extension add -n botservice` command to install the latest version.
3634
- Install latest version of the [MSBot](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/MSBot) tool.
3735
- You'll need [LUIS CLI](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/LUIS#installation) if the the clone operation includes LUIS or Dispatch resources.
3836
- You'll need [QnA Maker CLI](https://github.com/Microsoft/botbuilder-tools/tree/master/packages/QnAMaker#as-a-cli) if the clone operation includes QnA Maker resources.
3937
- Install [Bot Framework Emulator](https://aka.ms/Emulator-wiki-getting-started).
4038
- Install and configure [ngrok](https://github.com/Microsoft/BotFramework-Emulator/wiki/Tunneling-%28ngrok%29).
4139
- Knowledge of [.bot](v4sdk/bot-file-basics.md) files.
4240

41+
With msbot 4.3.2 and later, you need Azure CLI version 2.0.53 or later. If you installed the botservice extension, remove it with this command.
42+
43+
```cmd
44+
az extension remove --name botservice
45+
```
46+
4347
### C\#
4448

4549
`msbot clone services` does not upload your code files to Azure, just the DLL and a few other files. You need to compile the sample before running this command.
@@ -148,13 +152,13 @@ In the emulator, use production endpoint to test your app. If you want to test i
148152
DO NOT use `msbot clone services` command to update the bot code in Azure. You must use the `az bot publish` command as shown below:
149153

150154
```cmd
151-
az bot publish --name "<your-azure-bot-name>" --proj-file "<your-proj-file>" --resource-group "<azure-resource-group>" --code-dir "<folder>" --verbose --version v4
155+
az bot publish --name "<your-azure-bot-name>" --proj-name "<your-proj-name>" --resource-group "<azure-resource-group>" --code-dir "<folder>" --verbose --version v4
152156
```
153157

154158
| Arguments | Description |
155159
|---------------- |-------------|
156160
| `name` | The name you used when the bot was first deployed to Azure.|
157-
| `proj-file` | For C# bot, it is the .csproj file. For JS/TS bot, it is the startup project file name (e.g. index.js or index.ts) of your local bot.|
161+
| `proj-name` | For C#, use the startup project file name (without the .csproj) that needs to be published. For example: `EnterpriseBot`. For Node.js, use the main entry point for the bot. For example, `index.js`. |
158162
| `resource-group` | The Azure resource group that `msbot clone services` command used.|
159163
| `code-dir` | Points to the local bot folder.|
160164

articles/bot-builder-tools.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ user: thanks
5555
bot:
5656
Here's a form for you
5757
[Attachment=card.json adaptivecard]
58-
5958
```
6059

6160
### Create a transcript file from .chat file
@@ -93,30 +92,33 @@ For example, you can create multiple LUIS intents in a single .lu file as follow
9392

9493
The .lu file format supports also QnA pairs using the following notation:
9594

96-
```LUDown
95+
~~~LUDown
9796
> comment
9897
### ? question ?
9998
```markdown
10099
answer
101100
```
101+
~~~
102102

103103
The LUDown tool will automatically separate question and answers into a qnamaker JSON file that you can then use to create your new [QnaMaker.ai](http://qnamaker.ai) knowledge base.
104104

105-
```LUDown
105+
~~~LUDown
106106
### ? How do I change the default message for QnA Maker?
107107
```markdown
108108
You can change the default message if you use the QnAMakerDialog.
109-
See [this link](https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle) for details.
109+
See [this link](https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle) for details.
110110
```
111+
~~~
111112

112113
You can also add multiple questions to the same answer by simply adding new lines of variations of questions for a single answer.
113114

114-
```LUDown
115+
~~~LUDown
115116
### ? What is your name?
116117
- What should I call you?
117118
```markdown
118119
I'm the echoBot! Nice to meet you.
119120
```
121+
~~~
120122

121123
### Generate .json models with LUDown
122124

@@ -227,21 +229,37 @@ The Bot Framework [Emulator](bot-service-debug-emulator.md) is a desktop applica
227229

228230
## Publish
229231

230-
You can use the Azure CLI to create, download, and publish your bot to Azure Bot Service. Install the bot extension via:
232+
You can use the Azure CLI to create, download, and publish your bot to Azure Bot Service.
233+
234+
With msbot 4.3.2 and later, you need Azure CLI version 2.0.53 or later. If you installed the botservice extension, remove it with this command.
235+
231236
```shell
232-
az extension add -n botservice
237+
az extension remove --name botservice
233238
```
234239

235240
### Create Azure Bot Service bot
236241

237-
Note: You must use the latest version of the `az cli`. Please upgrade it, so that az cli can work with MSBot tool.
242+
Note: You must use the latest version of the `az cli`. Please upgrade it, so that az cli can work with MSBot tool.
243+
244+
Login to your azure account via
238245

239-
Login to your azure account via
240246
```shell
241247
az login
242248
```
243249

244-
Once you are loged in, you can create a new Azure Bot Service bot using:
250+
If you don't already have a resource group to which to publish your bot, create one:
251+
252+
```shell
253+
az group create --name <resource-group-name> --location <geographic-location> --verbose
254+
```
255+
256+
| Option | Description |
257+
|:---|:---|
258+
| --name | A unique name for the resource group. DO NOT include spaces or underscores in the name. |
259+
| --location | Geographic location used to create the resource group. For example, `eastus`, `westus`, `westus2`, and so on. Use `az account list-locations` for a list of locations. |
260+
261+
Then, create the bot resource into which you will publish your bot.
262+
245263
```shell
246264
az bot create [options]
247265
```

articles/bot-service-channel-connect-slack.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: Connect a bot to Slack | Microsoft Docs
33
description: Learn how to configure a bot's connection to Slack.
44
keywords: connect a bot, bot channel, Slack bot, Slack messaging app
5-
author: RobStand
6-
ms.author: kamrani
5+
author: JonathanFingold
6+
ms.author: v-jofing
77
manager: kamrani
88
ms.topic: article
99
ms.service: bot-service
1010
ms.subservice: sdk
11-
ms.date: 12/13/2017
11+
ms.date: 01/09/2019
1212
---
1313

1414
# Connect a bot to Slack
@@ -65,9 +65,11 @@ Follow these steps to subscribe to six particular bot events. By subscribing to
6565
6666
1. Select the **Event Subscriptions** tab.
6767
2. Click **Enable Events** to **On**.
68-
3. In **Request URL**, enter this URL, but replace `{YourBotHandle}` with your bot handle. The bot handle used in this tutorial is testChannels.
69-
`https://slack.botframework.com/api/Events/{YourBotHandle}`
70-
4. In **Subscribe to Workspace Events**, click **Add Workspace Event**.
68+
3. In **Request URL**, enter `https://slack.botframework.com/api/Events/{YourBotHandle}`, where `{YourBotHandle}` is your bot handle, without the braces. The bot handle used in this example is **ContosoBot**.
69+
70+
![Subscribe Events: top](~/media/channels/slack-SubscribeEvents-a.png)
71+
72+
4. In **Subscribe to Bot Events**, click **Add Bot User Event**.
7173
5. In the list of events, select these six event types:
7274
* `member_joined_channel`
7375
* `member_left_channel`
@@ -76,9 +78,12 @@ Follow these steps to subscribe to six particular bot events. By subscribing to
7678
* `message.im`
7779
* `message.mpim`
7880

79-
![Subscribe Events](~/media/channels/slack-SubscribeEvents.png)
81+
![Subscribe Events: middle](~/media/channels/slack-SubscribeEvents-b.png)
82+
8083
6. Click **Save Changes**.
8184

85+
![Subscribe Events: bottom](~/media/channels/slack-SubscribeEvents-c.png)
86+
8287
## Add and Configure Interactive Messages (optional)
8388

8489
If your bot will use Slack-specific functionality such as buttons, follow these steps:

articles/bot-service-channel-connect-webchat-speech.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To enable the speech functionality in Web Chat, you need to customize the JavaSc
6161
The customization allows you to add speech functionality in any of the following ways:
6262
6363
* **Browser-provided speech** - Use speech functionality built into the web browser. At this time, this functionality is only available on the Chrome browser.
64-
* **Use Bing Speech service** - You can use the Bing Speech service to provide speech recognition and synthesis. This way of access speech functionality is supported by a variety of browsers. In this case, the processing is done on a server instead of on the browser.
64+
<!--* **Use Bing Speech service** - You can use the Bing Speech service to provide speech recognition and synthesis. This way of access speech functionality is supported by a variety of browsers. In this case, the processing is done on a server instead of on the browser.-->
6565
* **Create a custom speech service** - You can create your own custom speech recognition and voice synthesis components.
6666
6767
### Browser-provided speech
@@ -75,7 +75,7 @@ The following code instantiates speech recognizer and speech synthesis component
7575
7676
[!code-js[Specify speech options to use in-browser speech (JavaScript)](./includes/code/bot-service-channel-connect-webchat-speech.js#BrowserSpeech)]
7777
78-
### Bing Speech service
78+
<!--### Bing Speech service
7979
8080
The following code instantiates speech recognizer and speech synthesis components that use the Bing Speech service. The recognition and generation of speech is performed on the server. This mechanism is supported in multiple browsers.
8181
@@ -91,7 +91,7 @@ You also have the option to enable Cognitive Services speech recognition using a
9191
The following example code shows how the token fetch is done from a secure back end to avoid exposing the API key.
9292
9393
[!code-js[Fetch a token to use with the Bing Speech API (JavaScript)](./includes/code/bot-service-channel-connect-webchat-speech.js#FetchToken)]
94-
94+
-->
9595
### Custom Speech service
9696
9797
You can also provide your own custom speech recognition that implements ISpeechRecognizer or speech synthesis that implements ISpeechSynthesis.

articles/bot-service-troubleshoot-bot-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The first step in troubleshooting a bot is to test it in Web Chat. This will all
2323

2424
![Test In Web Chat](./media/test-in-webchat.png)
2525

26-
If the bot responds with the expected output, go to [Bot does not work in Web Chat](#bot-does-not-work-in-web-chat). Otherwise, go to [Bot works in Web Chat but not in other channels](#bot-works-in-web-chat-but-not-in-other-channels).
26+
If the bot does not respond with the expected output, go to [Bot does not work in Web Chat](#bot-does-not-work-in-web-chat). Otherwise, go to [Bot works in Web Chat but not in other channels](#bot-works-in-web-chat-but-not-in-other-channels).
2727

2828
## Bot does not work in Web Chat
2929

72.2 KB
Loading
39.7 KB
Loading
4.08 KB
Loading
-144 KB
Binary file not shown.

0 commit comments

Comments
 (0)