Chatbotから話しかける（プロアクティブメッセージの送信）

連載 [第10回] :

2018年5月18日(金)

連載10回目となる今回は、Chatbotから先に話しかけるための手順を紹介します。

「Microsoft Bot Frameworkで作るChatbot」も連載10回目となり、いよいよ最終回となります。これまで育ててきたChatbotは対話の流れの途中で分岐を可能にし、AIによるテキスト解析、画像によるコミュニケーションなど、実用に十分役立つ機能を数多く実装することができました。

最後に紹介するのは、Chatbotからユーザーに話しかけるための「プロアクティブメッセージ（Proactive Messages）」の送信方法です。これまでのChatbotは、ユーザー側から何か文字を送信しないかぎり画面上では何もアクションを取ることはありませんでした。ですが、企業の受付業務やカフェのオーダーを受けるような、サービスの最前線で活躍するChatbotには、積極的にユーザーに話しかけアプローチのチャンスをできるだけ多く持たせることが望ましいと考えます。さらに、Chatbotを仕事や生活の中に取り入れて利用する場合、スケージュールの通知や、システムのアラートなど、Chatbot側からメッセージを送信する機会は数多くあると考えられます。

最初にChatbotから話しかける

これまでは「こんにちは」などユーザー側から話しかけないとChatbotとの対話は始まりませんでした。

ユーザーからの話しかけで対話が始まる

もちろんこれはこれで問題はないのですが、はじめてメッセージングの画面を開いたときにChatbotから話しかけることができれば、一層活躍の場が広がるでしょう。例えば受付業務でChatbotを利用する場合、最初に「いらっしゃいませ」とメッセージを送信できることは、とても重要な要素となります。ここで紹介するのは、ユーザーが初めてChatbotのメッセージング画面を開いた時にメッセージを送信する方法となります。Facebookなど継続的にメッセージング画面が開き続けるような場合は、最初の一度だけ当てはまります。WebChatやSkypeなどのように、メッセージング画面を閉じることで対話がリセットされる場合は、毎回Chatbotからメッセージが送信されることになります。

Bot Frameworkでは、対話の中で起こる様々なイベントを「ActivityTypes」として判別しています。対話の開始時にChatbotからメッセージを送信するタイミングは、ActivityTypesがConversationUpdateとなったときに該当します。このタイミングでChatbotからメッセージを送信するようにプログラムしていきましょう。

今回の記事で使用するファイル一式は、以下の2つのリンクからダウンロード可能です。

Chatbot本体
 プロアクティブメッセージ送信用のアプリケーション

Chatbotが起動して最初に処理するのはMessagesController.csです。

リスト1：MessagesController.cs

01using System.Net;
02using System.Net.Http;
03using System.Threading.Tasks;
04using System.Web.Http;
05using Microsoft.Bot.Builder.Dialogs;
06using Microsoft.Bot.Connector;
07using Microsoft.Bot.Builder.FormFlow;
08using Microsoft.Bot.Builder.Dialogs.Internals;
09using Autofac;
10using System.Linq;
11 
12namespace Chatbot201707
13{
14    [BotAuthentication]
15    public class MessagesController : ApiController
16    {
17        /// <summary>
18        /// POST: api/Messages
19        /// Receive a message from a user and reply to it
20        /// </summary>
21        public async Task<HttpResponseMessage> Post([FromBody]Activity activity)
22        {
23            if (activity.Type == ActivityTypes.Message)
24            {
25                await Conversation.SendAsync(activity, () => new Dialogs.RootDialog());
26            }
27            else
28            {
29                await HandleSystemMessageAsync(activity);
30            }
31 
32            var response = Request.CreateResponse(HttpStatusCode.OK);
33            return response;
34        }
35 
36        private async Task<Activity> HandleSystemMessageAsync(Activity message)
37        {
38            if (message.Type == ActivityTypes.DeleteUserData)
39            {
40                // Implement user deletion here
41                // If we handle user deletion, return a real message
42            }
43            else if (message.Type == ActivityTypes.ConversationUpdate)
44            {
45                IConversationUpdateActivity update = message;
46                using (var scope = DialogModule.BeginLifetimeScope(Conversation.Container, message))
47                {
48                    var client = scope.Resolve<IConnectorClient>();
49                    if (update.MembersAdded.Any())
50                    {
51                        var reply = message.CreateReply();
52                        foreach (var newMember in update.MembersAdded)
53                        {
54                            if (newMember.Id == message.Recipient.Id)
55                            {
56                                reply.Text = $@"いらっしゃいませ！ご注文を伺います。
57 
58(メニューをご覧になる場合は「メニュー」と入力してください。)";
59                                await client.Conversations.ReplyToActivityAsync(reply);
60 
61                            }
62 
63                        }
64                    }
65                }
66            }
67            else if (message.Type == ActivityTypes.ContactRelationUpdate)
68            {
69                // Handle add/remove from contact lists
70                // Activity.From + Activity.Action represent what happened
71            }
72            else if (message.Type == ActivityTypes.Typing)
73            {
74                // Handle knowing tha the user is typing
75            }
76            else if (message.Type == ActivityTypes.Ping)
77            {
78            }
79 
80            return null;
81        }
82    }
83}

以下、着目すべき点を説明していきます。

else if (message.Type == ActivityTypes.ConversationUpdate)

ActivityTypesがConversationUpdateのときにメッセージを送信します。

IConversationUpdateActivity update = message～

最初にChatbotからメッセージを送信する場合はほぼ同じパターンとなるので、ここでは詳細の解説は省きますが、おおまかにはCreateReplyでメッセージオブジェクトを作成してテキストを指定し、ReplyToActivityAsyncメソッドで送信しています。送信するメッセージは、これまでと同様に「いらっしゃいませ！ご注文を伺います。(メニューをご覧になる場合は「メニュー」と入力してください。)」としています。

次に、Chatbotからメッセージを送信した後の処理を追加します。

リスト2：メッセージ送信後の処理を追加（RootDialog.cs）

1public Task StartAsync(IDialogContext context)
2{
3    //context.Wait(HelloMessage);
4    context.Wait(MessageReceivedAsync);
5    return Task.CompletedTask;
6}

Chatbotからメッセージを送信すると、これまでと同様にRootDialog.csが読み込まれます。最初に実行されるのはStartAsyncメソッドです。context.Waitメソッドでユーザーからの入力待ちとなります。ユーザーからのメッセージを受信するとメニューを表示するか、AIによるテキスト解析を行うための「MessageReceivedAsync」メソッドを呼び出します。

以上で最初にChatbotから話しかけるように修正されました。早速エミュレーターで確認してみましょう。

Chatbot側から対話が始まる

エミュレーターを起動して接続しただけで、Chatbotからメッセージが送信されてきました。

通常どおりの対話

続けて「メニュー」と入力すれば、これまでと同様にChatbotとの対話が始まります。

プッシュでメッセージを送信する

対話情報の取得

次に紹介するのは、Chatbotとの対話中に外部からプッシュでメッセージを送信する方法です。スケージュールの通知や、システムのアラート、対話の内容にマッチした広告の表示など様々な利用方法が考えられます。

Chatbotとユーザーの対話中にメッセージを送信するためには、該当する対話を特定するためのいくつかの情報が必要となります。これらはユーザーやChatbotが接続しているチャンネルごとに異なりますので、その都度情報を取得する必要があります。

Chatbotが接続しているチャンネル

必要な情報を、以下の表に示します。

対話を特定するために必要な情報

情報	内容
message.From.Id	メッセージ送信者ID
message.Recipient.Id	メッセージ受信者ID
message.ServiceUrl	Chatbotが接続しているチャンネルのURL
message.Conversation.Id	対話ID

これらの情報は、実際にChatbotとユーザーが対話しはじめると取得することができます。RootDialog.cs内でChatbotの「メニュー」を表示するためのMessageReceivedAsyncメソッドに、隠しコマンドとして情報取得のためのコマンドを追加しておきましょう（隠しコマンドは、ユーザーが使用することは想定していません）。

リスト3：RootDialog.csのMessageReceivedAsyncメソッド

01private async Task MessageReceivedAsync(IDialogContext context, IAwaitable<IMessageActivity> result)
02{
03    var activity = await result;
04    switch (activity.Type)
05    {
06        case ActivityTypes.Message:
07            var message = activity as IMessageActivity;
08            switch (activity.Text)
09            {
10                case "メニュー":
11                    MenuMessage(context);
12                    break;
13 
14                case "ID":
15                    await context.PostAsync($@"
16ChannelId : {message.ChannelId}
17 
18FromId : {message.From.Id}
19 
20RecipientId : {message.Recipient.Id}
21 
22ServiceUrl : {message.ServiceUrl}
23 
24ConversationId : {message.Conversation.Id}
25");
26                    context.Wait(MessageReceivedAsync);
27                    break;
28 
29                default:
30                    await context.Forward(new ChatDialog(), ChatResumeAfterDialog, message, CancellationToken.None);
31                    break;
32            }
33            break;
34    }
35}

着目すべき点をおさえておきましょう。

case "ID"

「ID」と入力された場合にメッセージ送信に必要な情報を表示します。

ChannelId～ConversationId

それぞれの情報を表示します。加えて、どのチャンネルの情報かを識別するためにmessage.ChannelIdも表示しています。Webchatの場合、改行は二度必要となります。

エミュレーターで確認してみましょう。

メッセージ送信に必要な情報を表示

実用段階で考えると、これらの情報は対話開始時に自動的にバックグランドでjsonファイルなどの形式で取得しておくことになるかと思います。

メッセージ送信アプリケーションの作成

今回はプッシュでメッセージを送信するために、Chatbotのアプリケーションとは別に外部から割り込み用のメッセージを送信するためのアプリケーションを作成しましょう。このようにMicrosoft Bot Frameworkは、Chatbotを開発するためだけではなく、Chatbotをより高機能で使いやすくするために機能拡張を行うためのFrameworkとしても利用することができます。

まずはVisual Studioでコンソールアプリケーションを一つ作成します。

コンソールアプリケーションの作成

「NuGetパッケージマネージャー」から「Microsoft.Bot.Builder」をインストールします。原稿執筆時点では、最新バージョンが3.15となっています。Chatbotアプリケーションで利用している「Microsoft.Bot.Builder」のバージョンがこれよりも古い場合は、併せて最新版にアップデートをしておきましょう。

Microsoft.Bot.Builderをインストール

リスト4：Program.cs

01using Microsoft.Bot.Connector;
02using System;
03using System.Collections.Generic;
04 
05namespace Chatbot201707_ProactiveMessager
06{
07    class Program
08    {
09        static void Main(string[] args)
10        {
11            var appId = "<Microsoft App ID>";
12            var appPassword = "<Password>";
13 
14            //Emulator
15            var fromId = "default - user";
16            var recipientId = "95i2nkda1dd4";
17            var serviceUrl = "http://localhost:64607";
18            var conversationId = "g011b863i3j";
19 
20            //Facebook
21            //var fromId = "1628934843893271";
22            //var recipientId = "145452079480720";
23            //var serviceUrl = "https://facebook.botframework.com";
24            //var conversationId = "1628934843893271-145452079480720";
25 
26            //Skype
27            //var fromId = "18Afm0cxtapI0G7r6uyqCtK3MDtt38YDR5O6_EHo6NVk";
28            //var recipientId = "28:2595fdc3-27b1-4810-a040-efc3da267409";
29            //var serviceUrl = "https://smba.trafficmanager.net/apis/";
30            //var conversationId = "29:18Afm0cxtapI0G7r6uyqCtK3MDtt38YDR5O6_EHo6NVk";
31 
32            //WebChat
33            //var fromId = "KEBORI0rmk6";
34            //var recipientId = "Chatbot201707@dTuM__gWAS0";
35            //var serviceUrl = "https://webchat.botframework.com/";
36            //var conversationId = "fd8a04848c4744ddbbcce046f6086967";
37 
38            MicrosoftAppCredentials.TrustServiceUrl(serviceUrl);
39            var connector = new ConnectorClient(new Uri(serviceUrl), appId, appPassword);
40            var botAccount = new ChannelAccount(id: recipientId);
41            var userAccount = new ChannelAccount(id: fromId);
42 
43            IMessageActivity message = Activity.CreateMessageActivity();
44            message.Conversation = new ConversationAccount(id: conversationId);
45            message.From = botAccount;
46            message.Recipient = userAccount;
47            message.Locale = "ja-jp";
48            message.Text = $@"Chatbotからのお知らせです。
49 
50本日のおすすめは、季節のフルーツとれたてのあまーいいちごです。";
51            var cardImage = new CardImage { Url = "https://chatbot201707.azurewebsites.net/img/strawberry.jpg" };
52            var heroCard = new HeroCard { Title = "季節のフルーツ", Images = new List<CardImage> { cardImage }};
53            message.Attachments.Add(heroCard.ToAttachment());
54            connector.Conversations.SendToConversation((Activity)message);
55        }
56    }
57}

着目すべき点をおさえておきましょう。

var appId～var appPassword

Microsoft Azureに登録したChatbotの「Microsoft App ID」と「Password」を指定します。Azureポータルの「ボットチャンネル登録」から該当Chatbotの「設定」メニュー「Microsoft App ID（管理)」から確認することができます。

Microsoft App IDとパスワードの確認

//Emulator～//WebChat

現在登録しているチャンネルごとに必要な情報を取得して割り当てています。チャンネルごとに値の様式が異なることが確認できます。conversationIdは対話ごとに毎回異なるので、その都度取得する必要があります。

MicrosoftAppCredentials.TrustServiceUrl……

メッセージ送信に必要な情報をそれぞれ割り当てます。

IMessageActivity message = Activity.CreateMessageActivity()

送信するメッセージを作成します。

message.Conversation = new ConversationAccount……

conversationIdで、どの対話にメッセージを割り込ませるかを指定します。

message.Conversation～connector.Conversations.SendToConversation……

メッセージの宛先、送信者、言語、テキストを指定します。メッセージには前回紹介したように画像も差し込むことができますので、HeroCardを使って画像を添付して送信します。

作成したコンソールアプリケーションを実行して、エミュレーターで確認してみましょう。

メッセージの送信

エミュレーター以外の他のチャンネルも実際に確認してみましょう。

FacebookのMessenger

Skype

WebChat

以上が、Chatbotへのプロアクティブメッセージの送信方法です。

それぞれレイアウトは異なりますが、同じコードを利用してプッシュでメッセージを配信することができました。メッセージングアプリケーションが異なっても、一つのコードで同様のメッセージ送信を実現できるのが、Chatbotのよいところです。今回は手作業でメッセージを送信していますが、タスクスケジューラーに登録して定期的にメッセージを自動送信したり、AIの言語解析を利用して特定のキーワードが入力されたらお勧めを紹介したりするなど、用途は限りなく広がります。

10回にわたり紹介してきました「Microsoft Bot Frameworkで作るChatbot」いかがでしたでしょうか。

まだまだ紹介しきれていない機能やテクニックもたくさんあります。実際にChatbotを作成して少しずつ育てていくと理解が深まり、より便利で使いやすいChatbotに成長していくはずです。この記事がMicrosoft Bot FrameworkでChatbotを育てる方のお役に立つことができればうれしいです。