Chatbot開発が捗るFormFlow

Web開発

技術解説

連載 [第5回] :

Microsoft Bot Frameworkで作るChatbot

2017年12月12日(火)

樋口勝一

連載の5回目となる今回は、選択肢によるインターフェースを提供するFormFlowを用いて、Chatbotを拡張してみる。

FormFlowのカスタマイズ

FormFlowがダイアログに組み込めたところで、本格的に使えるようにカスタマイズしてみましょう。まずは選択項目が一つでは物足りないので、追加します。

リスト8：選択項目を追加

01public enum CurryOptions { ビーフ, チキン, ポーク, ベジタブル };
02public enum RiceOptions { ライス, バターライス, ナン };
03public enum SizeOptions { 大, 中, 小 };
04public enum ToppingOptions { トンカツ, コーン, ゆで卵, チーズ };
05 
06[Serializable]
07public class CurryFormQuery
08{
09    public CurryOptions? Curry;
10    public RiceOptions? Rice;
11    public SizeOptions? Size;
12    public ToppingOptions? Topping;
13}

今回は、上記のリストのような選択項目を追加してみました。エミュレーターで確認してみましょう。

追加された選択項目を確認

だんだんとカレーの注文らしくなってきました。

次にカレーダイアログ終了後、Rootダイアログに戻る際のメッセージ（現状では「カレーはビーフですね」）も修正しておきましょう。RootDialog.csを開き、CurryResumeAfterDialogメソッドを修正します。

リスト9：ダイアログに戻る際のメッセージを修正

01private async Task CurryResumeAfterDialog(IDialogContext context, IAwaitable<CurryFormQuery> result)
02{
03    var curry = await result;
04 
05    await context.PostAsync($@"カレーは {curry.Curry.ToString()}　ですね。
06 
07ライスは {curry.Rice.ToString()}　ですね。
08 
09サイズは {curry.Size.ToString()}　ですね。
10 
11トッピングは {curry.Topping.ToString()}　ですね。
12 
13");
14    MenuMessage(context);
15}

CurryFormQuery型で受け渡された戻り値には、各選択項目が含まれています。それぞれヒア文字列を使って、文字列型で表示しています。

ダイアログに戻る際に選択結果が受け渡されている

上記の実行結果で、カレーダイアログでの選択結果がきちんと受け渡されていることを確認できました。

今の設定では、選択項目の表示が「rice」「size」「topping」のように英語表記のままになっています。今度は、こちらをカスタマイズしてみましょう。

現状では選択項目が英語表記のままになっている

リスト10：選択項目の表示を日本語に

01[Serializable]
02public class CurryFormQuery
03{
04    [Describe("カレー")]
05    public CurryOptions? Curry;
06    [Describe("ライス")]
07    public RiceOptions? Rice;
08    [Describe("サイズ")]
09    public SizeOptions? Size;
10    [Describe("トッピング")]
11    public ToppingOptions? Topping;
12}

CurryFormQueryクラスで定義している属性に「Describe」で説明を追加することができます。それぞれに分かりやすく日本語名を追加しました。

選択項目の表示が日本語になっている

選択項目の表示が分かりやすくなりました。

複数選択を可能にする

選択項目の中には、複数の項目を選択できるようにしたいものもあります。その場合の設定方法を紹介します。例として、トッピングの種類を増やして、複数選択できるようにしてみましょう。ポイントは、「public List<ToppingOptions> Topping」の記述で、こちらはList型の属性を定義しています。

リスト11：トッピングを複数選べるようにする

01public enum CurryOptions { ビーフ, チキン, ポーク, ベジタブル };
02public enum RiceOptions { ライス, バターライス, ナン };
03public enum SizeOptions { 大, 中, 小 };
04public enum ToppingOptions { トンカツ, コーン, ゆで卵, チーズ, トマト, 辛さ増し, ハラペーニョ };
05 
06[Serializable]
07public class CurryFormQuery
08{
09    [Describe("カレー")]
10    public CurryOptions? Curry;
11    [Describe("ライス")]
12    public RiceOptions? Rice;
13    [Describe("サイズ")]
14    public SizeOptions? Size;
15    [Describe("トッピング")]
16    public List<ToppingOptions> Topping;
17}

この記述だけで複数選択が可能となります。実行してみましょう。

トッピングは複数選べるようになった

トッピングの選択がボタン形式ではなく、数字入力となっています。半角スペースで区切って数字を入力すれば、複数項目の選択が可能です。

上記の変更に合わせて、カレーダイアログを終了してRootダイアログに戻る際のメッセージも修正しておきましょう。RootDialog.csを開きCurryResumeAfterDialogメソッドを修正します。

for文でList型のcurry.Topping.Countから選択されたトッピングを取り出します。

リスト12：ダイアログに戻る際のメッセージも修正

01private async Task CurryResumeAfterDialog(IDialogContext context, IAwaitable<CurryFormQuery> result)
02{
03    var curry = await result;
04    var topping = "";
05 
06    for (int i = 0; i < curry.Topping.Count; i++)
07    {
08        topping += "　" + curry.Topping[i];
09    }
10 
11    await context.PostAsync($@"カレーは {curry.Curry.ToString()}　ですね。
12 
13ライスは {curry.Rice.ToString()}　ですね。
14 
15サイズは {curry.Size.ToString()}　ですね。
16 
17トッピングは {topping}　ですね。
18 
19");
20    MenuMessage(context);
21}