#BotFramework Emulator の機能 #7 ~ chat ファイル (会話セットの設計) の閲覧

Bot Framework Emulator の機能紹介の 7回目です。

  1. テストクライアント機能
  2. Bot 作成手順の確認
  3. bot ファイル (設定ファイル) の暗号化・復号化
  4. Bot アプリのエンドポイント管理
  5. 外部サービス (LUIS, QnA Maker) の接続管理
  6. LUIS 再学習
  7. chat ファイル (会話セットの設計) の閲覧(今回)
  8. transcript ファイル (保存済み実行結果) の閲覧

今回は、chat ファイルの閲覧機能を紹介します。

Bot Framework Emulator V4 で、個人的に一番気に入っている機能です。


これまで)対話の設計書を作ってますか?

Bot アプリの開発で意外と時間をかけられていないのが、設計(と運用)ということは このシリーズの 2回目でも触れました。
会話セット(ダイアログ)についても必ずしも十分に検討されないままで実装に進むことはなかったでしょうか。

これまでは Bot の会話セットを考える場合、こんなツールを使ったことはないですか?(以下は私が実際にやったことがある方法)

  • Excel に、ユーザーの入力とそれに対する Bot の応答の形で書いていく
  • Office 文書(Excel だったり PowerPoint だったり)に吹き出しの図形を並べる
  • 付箋を吹き出しに見立てて大きな紙に貼っていく

対話の設計を行ったという点ではいいのですが、問題も少しあります。

  • 設計書として版数管理がやりづらいことがある
  • ユーザー用と開発者用とで別の文書を作ってしまう(メンテが大変)
  • 設計書からソースコードへの落とし込みでギャップがある

“.chat” ファイルは、これらの課題を解決してくれます。


chat ファイルとは

拡張子 “.chat” ファイルは、会話のモックアップ作成用フォーマットです。

こんな風に書きます。

user=User
bot=TsEntBotDemo

[ConversationUpdate=MembersAdded=User]
bot->User: 会議室予約 Bot です。
user: 会議室を予約したい
bot: [Typing][Delay=3000]
〇〇さんの予定表に接続します。
bot: 件名を教えてください。
user: 会議室予約Botシナリオ検討会
bot: 実施日を教えてください。
user: 2018年11月8日
bot: 開始時刻を教えてください。
user: 10時
bot: 会議の長さを分単位で教えてください。
user: 30分
bot: 出席者は何人ですか?
user: 5人
bot: [Typing][Delay=3000]
予約する会議室を選択してください。
user: 会議室B
bot: 会議室B を 2018年11月8日 10:00~10:30 の間、予約しますか?
user: はい
bot: [Typing][Delay=3000]
会議室を予約しました。
bot: 内容の確認および変更は、次のリンクから行えます。https://outlook.office365.com/owa/?itemid=XXX
bot: トップに戻ります。
user: 今から45分、2人で打ち合わせできる?
bot: [Typing][Delay=3000]
空いている会議室が見つかりませんでした。

詳しい書式は こちらのページ にありますが、開発者であれば上記を読むだけで会話の内容がイメージできるのではないでしょうか。
会話セットを厳密に定義できているのが分かると思います。

上の例を見ただけで、それぞれの案件ですぐにでも chat ファイルを書けるかもしれません。

プレーンなテキストファイルなので版数管理もやりやすいと思います。
(会話セットは案件全体を通して何度も改訂することが多いので、版数管理は大事です)


会話セットをユーザーと共有

chat ファイルは開発者には理解しやすい書式だと思いますが、ユーザーには「テキストファイル」から会話をイメージするのは難しいかもしれません。

Emulator は chat ファイルを認識してくれます。上の chat ファイルを読み込ませるとこんな風になります。

チャットクライアントの見た目も、ログや Activity の JSON フォーマットも再現されています。

これならユーザーも会話の内容をイメージしやすいし、開発者であっても直感的な理解に役立ちそうです。


chat ファイルの読み込み方

説明の順序は逆になりますが、Emulator に chat ファイルを読み込ませる手順を紹介します。

  1. Bot Framework Emulator を開き、”create a new bot configuration” リンクをクリック
  2. [Bot name] は適当な名前を付けます。[Endpoint URL] は “http://localhost:3978/api/messages” とでもしておけばいいでしょう。
  3. [Resouces] アイコンをクリックしてから [CHAT FILE] を開き、script ファイル (chat ファイル) を置くフォルダーを指定します。指定のフォルダーにある chat ファイルは自動的に表示されます。
  4. 表示された chat ファイルを選択すると、チャット領域に会話が表示されます。

まとめ ~ chat ファイルの活用

会話セットを、簡単な書式で定義して、ユーザーとも開発者とも一つのファイルで仕様を共有できます。

また chat ファイルを Emulator に読み込ませた結果と実際の Bot アプリを実行した時との表示差異もありません。このため、設計を正確に実装に反映させることもできます。

いいことだらけの chat ファイルです。Emulator とあわせて活用してください。

広告
カテゴリー: Bot Builder SDK, Bot Framework, Bot Service, Cogbot タグ: , , , , パーマリンク

#BotFramework Emulator の機能 #7 ~ chat ファイル (会話セットの設計) の閲覧 への7件のフィードバック

  1. ピンバック: #BotFramework Emulator の機能 #1 ~ Bot アプリケーションのテストクライアント機能 | 技術との戯れ

  2. ピンバック: #BotFramework Emulator の機能 #2 ~ Bot 作成手順の確認 | 技術との戯れ

  3. ピンバック: #BotFramework Emulator の機能 #3 ~ bot ファイルの暗号化・復号化 | 技術との戯れ

  4. ピンバック: #BotFramework Emulator の機能 #4 ~ Bot アプリのエンドポイント管理 | 技術との戯れ

  5. ピンバック: #BotFramework Emulator の機能 #5 ~ 外部サービス (LUIS, QnA Maker) の接続管理 | 技術との戯れ

  6. ピンバック: #BotFramework Emulator の機能 #6 ~ LUIS 再学習 | 技術との戯れ

  7. ピンバック: #BotFramework Emulator の機能 #8 ~ transcript ファイル (保存済み実行結果) の閲覧 | 技術との戯れ

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト /  変更 )

Google フォト

Google アカウントを使ってコメントしています。 ログアウト /  変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト /  変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト /  変更 )

%s と連携中