Index

A

ActionTypes class 249

activities 11

Activity class 67–68

adding speech to 345–347

code design 69–72

handling 67–77

listening for new 310–314

pinging 76

relationship changes 72–73

sending 72, 316–318

types 68

typing indicators 77, 78–80

user data deletion 75–76

Activity class 46, 59–62, 67–68

custom message Activity 61–62

ActivityExtensions class 60–62

ActivityType class 68–69

ActivityType members 46

ActivityType.Message 46

Activity types 24–25

ActivityTypes class 249

Adaptive cards 267–276

handling actions 274–275

layout with containers 271–273

using controls 273–274

AddRemainingFields method 175–176

AddTieAsync method 56

Analytics tab 280–283

AnalyzeImageAsync method 331

API Key 282

api/messages 36

Apple 6

Application ID 282

Application Insights 280–283

artificial intelligence (AI) 4–5, 183, 321

ASP.NET MVC applications 21

ASP.NET MVC Web API project 18

assembly references 19–20

attachments 112–113

accepting from users 254–255

sending 255–257

working with 250–257

Audio cards 265–266

augmented/virtual reality (AR/VR) applications 7

Authenticate module 315

Autofac 19, 254

AutoFac 229

Azure

deploying chatbot to 31–35

Azure Application Insights 280–283

Azure Table Storage 253

B

Bing

searching with 321–330

Bing channel

configuration 286–288

BotAuthentication attribute 23

Bot Builder 19

Language.GenerateTerms method 172

Bot Builder dialogs. See dialogs

Bot Connector 9, 19, 24, 25, 35

relationship changes and 72–73

services 10–12

state management service 47–59

Bot Emulator

activities handling 67–77

ConversationUpdate Activity 73–75

features 65–67

Typing Activity 80

Bot Framework

architecture 8–14

Bot Connector 10–12

channels 9–10

chatbots 12–14

components 8–9

Direct Line API and 303–320

InputHints class 353–354

introduction to 3–14

Natural Language Processing 183–202

voice services and 345–360

Bot Framework Emulator

communicating with chatbot 29–30

configuration 27–29

installing 26–27

testing chatbot with 26–30

Bot Framework project 15–38

default chatbot 22–25

default code 18–25

folder and file layout 21

initial testing with emulator 26–30

publishing 31–35

registering 35–38

starter template 15, 16–17

assembly references 19–20

starting new 17–18

steps in building 15–16

template installation 16–17

Bot Framwork State Service 47–59

bots. See chatbots

BotState 49–50

Bot State Service 102, 115, 253

browse dialog 243–244

BrowseDialog 326–329

BrowseDialog implementation 258–263

BuildForm method 127, 153, 163, 168

Build method 178

BuildWineDialog method 131–132

C

C# 11

Call method 209–210

camelCase 127

CancellationTokenSource 318, 319

cancelToken parameter 318

CardElement class 272–273

cards 237–278

Adaptive 267–276

attachments 250–257

Audio 265–266

BrowseDialog implementation 258–263

building blocks 246–257

creating 261–268

displaying 257–267

Hero 258, 261–262

layout 261

with containers 271–273

Suggested Actions 246–250

Thumbnail 258, 262

using controls 273–274

Case 222

Chain class 213–225

Chain.ContinueWith method 223–224

Chain.From method 219–220

Chain.Loop method 220–221

Chain.Switch method 220–222

LINQ statements 225–226

posting and waiting methods 223–224

WineBotChain 214–218

Chain.ContinueWith method 223–224

Chain.From method 219–220

Chain.Loop method 220–221

Chain.Switch method 220–222

ChannelId 46

Channel Inspector 289

channels 9

Bing 286–288

configuration 279–290

Console 303–308

Cortana 355–359

custom 303–320

Email 291–293

overview of 9–10, 279–283

Teams 284–286

Twilio 293–294

types of 279

Webchat 295–300

chatbots

activities handling 67–77

adding voice services to 345–360

advanced conversations 77–86

analytics 280–283

benefits of 5–7

caching with multiple 48

channels 279–290

characteristics of 12–13

communications 13–14

conversation and 4–5, 8, 12–13, 39–64, 73–75

creating

assembly references 19–20

default chatbot 22–25

folder and file layout 21

initial testing with emulator 26–30

starting new project 17–18

template installation 16–17

custom information storage 11

defined 3

deploying to Cortana 355–359

deployment of 5–6

email 291–293

ending conversations with 318–320

FAQ 339–344

fine-tuning 65–88

FormFlow 124–132

identity 46–47

in Bot Framework 9

interruption handling 226–229

Music Chatbot 237–278

navigating between dialogs 204–207

pinging 76

platform independence of 6–7

publishing 31–35

registering 35–38

relationship changes 72–73

Rock, Paper, Scissors game bot 39–45, 51–56, 60–62

sending independent messages 80–86

sending user input to 316–318

steps to building 15–16

texting 293–294

typing indicators 77, 78–80

usage scenarios 7–8

use of LUIS by 183–202

using voice 6

Webchat control 295–300

WineBot 91–118

chatbotState variable 54

ChoiceStyleOptions enum 147–148

C# language 127

client-side coding

Webchat control 296–297

CognitiveService class 322

Cognitive Services. See Microsoft Cognitive Services

command-line applications 4

commands

configuration of FormFlow 160–161

communication 5

chatbot 13–14

multi-cultural 332–339

out-of-band 226–229

proactive 80–86

voice 6

Compare method 42

condition parameter 164–165

configuration

Application Insights 280–283

Bing channel 286–288

channels 279–290

email channel 292–293

FormFlow 154–161

commands 160–161

responses 156–157

templates 157–159

Teams channel 284–286

Visual Studio 281

Webchat channel 295–296

Configure class 315–316

ConfigureFormBuilder method 156–160

Confirm method 166–168

ConnectorClient class 25

console applications 4

Console channel

code 305–308

components 304–305

ending conversations 318–320

keeping conversation open 315–316

listening for new activities 310–314

overview of 303–308

sending activities 316–318

starting a conversation 308–309

ContactRelationUpdate Activity 72–73

containers

with Adaptive cards 271–273

ContinueWith method 223–224, 224

controls

using 273–274

conversation 39–64

Activity class 59–62

Activity state 46

advanced 203–234

advanced messages 77–86

continuing 85–86

criticality and 8

defined 45

designing 43

dialogs and 105–107

dialog stack 203–213

elements of 45–47

email 291–293

ending 318–320

FormFlow 132–137

handling interruptions 226–229

identifiers 45–46

identity 47

importance of 4–5

keeping open 315–316

management

with chaining 213–225

management of 12–13

MessagesController class 44–45

participating in 59–62

responding to 59

starting new 86

starting, on custom channel 308–309

state management 45–59

bot state service capabilities and organization 49–51

dialogs 106–108

saving and retrieving state 47–59

stray user input and 43

text output formatting 230–232

updates 73–75

user and chatbot identities 46–47

with Music Chatbot 237–246

conversational user interface (CUI) 3, 4, 13, 39, 183

Conversation property 47

ConversationReference.json file 83–84

ConversationUpdate Activity 73–75

Conversation.UpdateContainer method 229

Cortana 6, 345, 355–359

CreateReply method 25, 59, 232, 249

criticality 8

CUI. See conversational user interface

custom channels 303–320

ending conversations 318–320

keeping conversation open

315–316

listening for new activities

310–314

overview

303–308

sending activities 316–318

starting a conversation

308–309

customer support 339

D

DefaultCase 222

default.htm file 21

DeleteScoresAsync method 55

DeleteStateForUserAsync method 50

DeleteUserData Activity 75–76

dependencies parameter 164–165

deployment

chatbots 5–6

Describe attribute 133–134, 138

DetectAndTranslateAsync method 336

DetectLanguageAsync method 334

dialogs

browse 243–244

building 91–118

calling 115–116

conversation flow 105–107

dialog class creation 102–103

finishing 211–214

Done method 211–212

Fail method 212–213

Reset method 212–213

FormFlow. See FormFlow

IDialogContext parameter 103–105

implementation of 98–114

initialization and workflow 103

LINQ statements 225–226

playlist 244–245

profile 243, 250–253

PromptDialog class 108–114

root 242, 246–248

search 245–246

searches 114–115

serializable 102, 111

WineBot 91–118

WineForm 129–132

dialog stack 203–213

defined 203–204

navigating to other dialogs 204–207

navigating via call 209–210

navigating via forward 207–209

Direct Line API 11, 303–320

ending conversations 318–320

keeping conversation open 315–316

listening for new activities 310–314

sending activities 316–318

starting a conversation 308–309

Watermark property 307–308, 313

DisplayAsync method 255–256

distributed applications 14

DoChainLoopAsync method 220–221

DoChainSwitchAsync method 220–222

DoManageCase method 222, 223

Do method 224

DoneAsync method 229

Done method 211–212

DoSearchAsync method 114–115

DoSearchCase method 222, 223

DoSearch method 128, 176

duplicate messages 314

E

email accounts

creating 291–292

Email channel 291–293

emulator

communicating with chatbot 29–30

configuration 27–29

installing 26–27

testing chatbot with 26–30

EndConversationAsync method 319

EndOfConversationCodes class 177–178

entities

handling 196–200

prebuilt 188–189

simple 187–188

specifying, in LUIS 187–189

ExtractEntities method 197

F

Fail method 212–213

FAQ chatbots 339–344

Field method 171–173

fields 168–175

AddRemainingFields method 175–176

dynamic field definition 171–172

HasField method 175

validation 173–175

FileService class 256

fluent interface

FormFlow 153–154

formatting text 230–232

FormBuilder class 127–128

FormCanceledException 131

FormConfiguration class 156–160

FormFlow 119–152

attributes 132–135

Describe 133–134

Numeric 134–135

Optional 135

Pattern 135

Prompt 135–136

Terms 136–137

basic chatbot 124–132

BuildForm method 127

choosing between IDialog<T> and 150

conversations 132–137

customization 153–182

Build method 178

commands 160–161

Configuration property 154–161

Confirm method 166–168

Message method 162–167

OnCompletion method 176–178

reponses 156–157

templates 157–159

working with fields 168–175

features 119–124

fluent interface 153–154

help options 123

initialization 178–181

input error correction 121

menu options 120

serializable 127

templates and patterns 137–150

basic templates 139

configuration 157–159

pattern language 137–139

template options 146–149

TemplateUsage enum 139–146

using as dialog 129–132

WineForm 124–132

working with fields

AddRemainingFields method 175–176

dynamic field definition 171–172

field validation 173–175

HasField method 175

Forward method 207–209

Frequently Asked Questions (FAQs) 339–344

From method 219–220

From property 46

G

Game class 40–43

GameState class 51–56

generateMessage parameter 166–167

GetAudioCardsForPreview method 265–266

GetConversationReference 84–85

GetGenres method 241

GetMessage method 59

GetPreview method 241

GET requests 98

GetScoresAsync method 53–54, 56, 79–80

GetToken method 241

GetTracks method 241

GetUserImageAsync 98

GetUserInputAsync method 318, 319

GitHub 12

Google 6

graphical user interfaces (GUI) 4–5, 12

graphical user interfaces (GUIs) 237

Groove API 238–242

GrooveService class 238–241

H

HandleCanceledForm method 132–133

Handle method 71–72

HandleSystemMessageAsync method 116

HandleSystemMessages 24

Happy Path 237

HasField method 175

Help command 160

HelpScorable 226–229

Hero cards 258, 261–262

HttpOperationException 50

HTTP POST endpoint 22

I

IBotContext 104

IBotData 105

IBotDataStore<BotData> 253

IBotState 49–50

IBotToUser 105–106

IContactRelationUpdateActivity interface 72–73

IDialogContext 103–105, 177, 195

Call method 209–210

Done method 211

Forward method 207–209

IDialog<object> 102–103

IDialogStack 104

IDialog<T> 130–131, 210

choosing between FormFlow and 150

Id property 47

IFormBuilder<T> 154, 156

IFormDialog<T> 131–132

images

interpreting 330–332

IMessageActivity 207

initialization

FormFlow 178–181

input controls 274–275

input hints 353–355

InputHints class 353–354

installation

Bot Framework Emulator 26–27

project template 16–17

Instrumentation Key 282

intents

adding 195–196

building, in LUIS 186–187

interruptions

handling 226–229

Inversion of Control (IoC) 229

IScorable 226–229

IsGroup property 47

IsRequired property 274

IStateClient 54

J

Json.NET 97

Json.NET package 49

K

keep-alive messages 313

L

Language.GenerateTerms method 172

language translation 332–339

Language Understanding Intelligence Service (LUIS) 14, 183–202, 321

continuous model improvement 200–201

essential concepts of 183–192

publishing model 192

setting up 185–188

building intents 186–187

model creation 185–186

specifying entities 187–189

training and deploying 189–192

adding utterances 190–192

model testing 191–192

using in chatbots 193–200

adding intents 195–196

entity handling 196–200

Last-In First Out (LIFO) 203

LINQ statements 225

Linux operating systems 303

localization 66, 332

Loop method 220–221

LUIS. See Language Understanding Intelligence Service

LuisIntent attribute 195

LuisResult method 197

M

MainAsync method 306

Markdown 230–232

Material Design 6

Message class 307

Message method 127–128, 162–167

condition parameter 164–165

dependencies parameter 164–165

generateMessage parameter 166–167

prompt parameter 165

MessageReceivedAsync method 107–108, 115, 212, 271, 329–330

messages

duplicate 314

keep-alive 313

POST 75

receiving 310–314

sending independent 80–86

translating 334–339

MessagesController class 44–45, 57–59, 115–116, 129–132

MessagesController.cs file 21, 22

MessagesController.Post method 71–72

messaging apps 3–4, 5, 9–10

MicrosoftAppId 241

Microsoft App ID 36

Microsoft App password 36

MicrosoftAppPassword 241

Microsoft.Bot.Builder 19, 20

Microsoft.Bot.Connector 19

Microsoft Bot Framework. See Bot Framework

platform independence and 6–7

Microsoft Cognitive Services 4–5, 6, 14, 321–344

LUIS 183–202

QnA Maker 339–344

Search service 321–330

Text Translation API 332–339

Vision service 330–332

Microsoft Direct Line SDK 303, 308

multi-cultural communication 332–339

multi-threading 306–307, 308

Music Bot

using search with 321–330

Music Chatbot 237–246

attachments and 250–257

Audio cards 265–266

BrowseDialog 243–244, 258–261

channels 279–290

FileService class 256

Groove API 238–242

PlaylistDialog 244–245, 263–265

ProfileDialog 243, 250–253

PromptDialog 350–353

RootDialog 242, 246–248

RootMenuItem 248

SearchDialog 245–246, 267–271

N

naming conventions 127

natural language processing (NLP) 4, 14

Natural Language Processing (NLP) 183–202, 321

training models 185–192

navigation

dialog stack and 203–213

to other dialogs 204–207

via call 209–210

via forward 207–209

.NET Framework 310

NewsDialog 323–326, 330

ngrok 36, 37

NLP. See Natural Language Processing

None intent 195–196

NuGet 19, 20, 97, 303, 308

Numeric attribute 134–135

O

OnCompletion method 127–128, 176–178

Optional attribute 135

out-of-band communication 226–229

P

PascalCase 127

Pattern attribute 135

pattern language

FormFlow 137–139

Ping Activity 76

platform independence

chatbots and 6–7

Playlist Dialog 244–245

PlaylistDialog

implementation 263–265

PlayList enum 43

Play method 42–43

PlayScore class 53

PlayType enum 39–40, 45

polling 310

port numbers 45

PostAsync method 177

POST messages 75

Post method 22, 23, 24, 44, 51, 57, 61, 71–72, 76, 130, 179, 204, 213, 218, 335, 347

PostToChain method 221

PostToUser method 222

prebuilt entities 188–189

proactive communication 80–86

ProfileDialog 243, 250–253

Program class 304

programming languages 11

PromptAsync method 347

Prompt attribute 135–136, 138, 139, 165

PromptAttribute 159

Prompt class 316–318

PromptDialog 350–353, 354

PromptDialog class 108–114

Attachment method 112–113

Choice method 109–110

Confirm method 111–112

Number method 110

Text method 111–112

PromptDialog method 207

PromptOptions 353

promptOptions parameter 108

prompt parameter 165

Q

QnA maker 339

R

Rating property 164

RatingType enum 125–126

ReceiptCards 267

ReceiveAsync method 312

Recipient property 46

ReconnectToConversationAsync method 316

RefreshTokenAsync method 318

RefreshTokensAsync method 316

RegexCase 222–223

ReplyToId parameter 61

Representational State Transfer (REST) interface 22

Reset method 212–213

REST. See Representational State Transfer (REST)

REST API 11

REST endpoints 297

REST interface 303

ResumeAfterProfileAsync method 212

RetrieveMessagesAsync method 312, 319

Rock, Paper, Scissors game bot 39–45

BuildMessageActivity method 60–62

BuildTypingActivity method 78

deploying to Cortana 355–359

Game class 40–43

GameState class 51–56

GetScoresAsync method 79–80

MessageController.Post method 71–72

MessagesController class 44–45, 57–59

PlayList enum 43

PlayType enum 39–40

SystemMessages class 69–71

RootDialog 205–207, 209, 218, 246

RootDialog.cs file 21

RootMenuItem 248

routing 10

S

SayAsync method 347–350, 354

ScorableBase class 227–228

SearchArguments class 275

SearchDialog 245–246, 267–271

SearchingIntent method 196–197

Search services 321–330

BrowseDialog 326–329

NewsDialog 323–326, 330

Select method 222

SendAsync method 116, 130, 204

Send System Activity menu 72

SendToConversationAsync method 257

SendToExistingConversation method 85–86

Serializable attribute 102

ServiceUrl 46

SetDefine 172

SetFieldDescription 172

SetType 172

SetValidation method 173–175

ShowMenuAsync method 249–251

SignInCards 267

Siri 6

SMS messages 293–294

Speak property 345, 347

speech capabilities

adding to activities 345–347

adding to PromptDialog 350–353

adding with SayAsync 347–350

Cortana 355–359

input hints 353–355

speech recognition 357

Speech Synthesis Markup Language (SSML) 347

SSML. See Speech Synthesis Markup Language

StartAsync method 103, 105, 115, 210

StartConversationAsync method 309, 318

StartNewConversation method 86

StateClient 54

state management

conversations 45–59, 106–108

StockingType enum 125–126

streaming 310–314

SubmitAction 274–275

Suggested Actions 246–250

Suggested Utterances tab 200–201

SuppressRepeatedActivities method 314–315

Switch method 220–222

SystemMessages class 69–71

T

Task Parallel Library (TPL) 312

Teams channel

configuration 284–286

using 286

Template attribute 139, 145

TemplateAttribute 157–159

TemplateBaseAttribute class 146–148

templates

configuration 157–159

FormFlow 137–150

project 16–25

TemplateUsage enum 139–146

Terms attribute 136–137

text chatbots 293–294

text messaging 5

text output

formatting 230–232

Text Translation API 332–339

Then method 224

Thumbnail cards 258, 262

Timestamp 46

TranslateResponseAsync method 338–339

TResult type parameter 103

Twilio channel 293–294

Typing Activity 77, 78–80

typing indicators 77, 78–80

U

Universal Windows Programs (UWP) 6

UnWrap method 222

UploadAsync method 254–255, 256

user data

deletion of 75–76

user exits 319–320

user identity 46–47

user input

interpretation of 199

sending to chatbots 316–318

utterances 190–192

V

VideoCards 267

Vision services 330–332

Visual Studio

configuration 281

template 16–25

voice communication 6

voice services 345–360

adding to PromptDialog 350–353

Cortana 355–359

input hints 353–355

SayAsync method 347–350

W

Wait method 104, 210

Watermark property 307–308, 313

Webchat control 295–300

client-side coding 296–297

handling server requests 297–299

web pages

adding chatbots to 295–300

Web Sockets 310, 312

Windows Subsystem for Linux (WSL) 303

WineApi class 96–97, 98, 124, 128

WineBot

attachments 112–113

calling dialog 115–116

FormFlow chatbot 124–132

implementation of 98–114

introduction to 91–92

MessagesController class 115–116, 129–132

PromptDialog class 108–114

WineApi class 96–97, 98, 124–132, 128

WineCategories class 93

Wine.com API 92–98

WineForm class 126–127

WineProducts class 93–96

WineSearchDialog class 98–114, 111, 114–115

WineBotChain 214–225

WineBotDialog class 193–195

WineBotLuis 193–200

WineCategories class 93

Wine.com API 92–98

WineForm 124–132

Confirm method 166–168

FormFlow fluent interface 153–154

Forward method 207–209

OnCompletion method 176–178

Rating property 164

using as dialog 129–132

working with fields 168–175

WineForm class 126–127

WineFormCompletedAsync method 231

WineProducts class 93–96

WineSearchDialog class 98–114, 111, 114–115

WineType enum 124–125, 198

WritePrompt 308

X

Xamarin 6