読者です 読者をやめる 読者になる 読者になる

とある技術の開発日記

Diary of irregular phrase programmer

Build 2016で発表された、Micorosft Bot Frameworkが楽しそうだったので少し動かしてみた

日本時間の昨夜からBuild 2016が開催されました。

Keynoteの様子や全体のまとめはぶちざっきを見ると良いかと思います。

//build/ 2016 Day 1 Keynote | ブチザッキ

//build/ 2016 Day 1 で発表されたリンクあれこれ | ブチザッキ

色々な発表があったのですが、この中で私が注目したのは「Microsoft Bot Framework

ChatOpsという言葉もありますが、最近はSkypeやSlackなどチャットツールの利用頻度が圧倒的に高くなっていますし、Hubotを利用してSlackのBotを作成している方も少なからず居ると思います。

今回発表されたMicrosoft Bot FrameworkではC#やNode.jsを利用して簡単にBotを作成する事ができます。かつ、作成したBotは登録する事で他のWebサービスと簡単に連携する事ができます。

サンプルを少し触ってみたのでご紹介します。詳細な説明は他の方がやってくれることでしょう・・・。

docs.botframework.com

GitHubにサンプルコードもあるので眺めてみるとBot周りのASP.NET WebAPIクラスが増えているのが確認できます。

github.com

ソリューション構成

ASP.NET WebAPIで開発したことある方ならお馴染みのソリューション構成です。 f:id:airish9:20160331094057p:plain

コントローラーの中身はこんな感じ。

using System;
using System.Linq;
using System.Threading.Tasks;
using System.Web.Http;

using Microsoft.Bot.Builder.Dialogs;
using Microsoft.Bot.Connector;
using Microsoft.Bot.Connector.Utilities;

namespace Microsoft.Bot.Sample.EchoBot
{
    [BotAuthentication]
    public class MessagesController : ApiController
    {
        /// <summary>
        /// POST: api/Messages
        /// receive a message from a user and reply to it
        /// </summary>
        public async Task<Message> Post([FromBody]Message message)
        {
            return await Conversation.SendAsync(message, () => new EchoDialog());
        }
    }
}

Microsoft.Botの名前空間にBot周りのクラスが定義されています。 BotAuthentication属性やMessageクラス、Microsoft.Bot.Builder.Dialogs.IDialogを実装しているクラス(ここではEchoDialog

Botの主な動作はMicrosoft.Bot.Builder.Dialogs.IDialogStartAsyncを実装してIDialogContext.Wait(ResumeAfter<Message> resume)を呼び出すことで動作します。

ResumeAfterはジェネリクスで指定されている型の引数とIDialogContextのデリゲートです。

public delegate Task ResumeAfter<in T>(IDialogContext context, IAwaitable<T> result);

サンプルソースを参考にして実装するとこんな感じです

        public async Task StartAsync(IDialogContext context)
        {
            context.Wait(MessageReceivedAsync);
        }

        public async Task MessageReceivedAsync(IDialogContext context, IAwaitable<Message> argument)
        {
            var message = await argument;

            // << ここで入力された内容を処理する >>

            // メッセージを返却する
            await context.PostAsync(string.Format("入力したメッセージは {0} ねっ?", message.Text));

            // 入力待ち状態で入力を受け付ける
            context.Wait(MessageReceivedAsync);

        }

デバック方法

BotのEmulatorツールが公開されています。

docs.botframework.com

作成したWeb APIをビルド&デバック状態にしてEmulatorからBotと会話する事が出来ます。(単純に指定したエンドポイントにPOSTリクエストを投げているだけっぽい?)

f:id:airish9:20160331101641p:plain

公開&連携

今回は以下のページを参考にしてAzure WebAppで作ったAPIをホストして、Bot FrameworkのページからBotの登録を行いました。

docs.botframework.com

登録するとAPIIDとKeyが発行されるのでWeb.configを書き換えましょう。

<?xml version="1.0" encoding="utf-8"?>
<!--
  For more information on how to configure your ASP.NET application, please visit
  http://go.microsoft.com/fwlink/?LinkId=301879
  -->
<configuration>
  <appSettings>
    <!-- update these with your appid and one of your appsecret keys-->
    <add key="AppId" value="hanayobot" />
    <add key="AppSecret" value="YourAppSecret" />
  </appSettings>

後は管理画面右側の連携したいサービスからADDすれば追加できます。Web Hook対応のサービスからなら登録できるはずなのでBotライフを楽しみましょう

f:id:airish9:20160331104915p:plain

うまくできなかった事

  • 管理画面の「Test connection to your bot」で会話できるはずなのですが、sendボタンを押しても無反応だった・・・
  • Web Chatで作成されたタグを仕込んでもbotが無反応だった。

認証系っぽい…。