#BotFramework Emulator の機能 #1 ~ Bot アプリケーションのテストクライアント機能

Bot Framework v4 / v4.1 関連のリリースで個人的に一番気に入っているのが、Bot Framework Emulator です。

v3 の頃は「Bot アプリケーションのテストクライアント」という位置づけのツールでした。
このため v4 でも単にバージョンが上がっただけだと思うかもしれません。

実は、V4 のEmulator はテストクライアントにとどまらない高機能ツールです。
ここから数回に分けて、Bot Framework Emulator の機能を紹介していきます。

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

今回は1回目ということで、皆さんご存知のテストクライアント機能を(念のため)紹介します。


Bot Framework V4 になって、Bot に関する設定項目は拡張子 “bot” ファイルで定義されるようになりました。
bot ファイルはアプリケーションの起動時に Web アプリケーションによって初期化時に読み込まれますが(Azure にアプリケーションを発行する際には bot ファイルもパッケージに含まれます)、Emulator も bot ファイルを読み込んで動作します。
このため、Emulator での設定間違いによる動作不良は発生しなくなり、対象の Bot アプリケーションを確実にデバッグ実行できるようになります。


bot ファイルでは複数の Web アプリケーションを保持しておき、接続を切り替えることができます。
Visual Studio の Bot テンプレート (Bot Builder V4 SDK Template) から作成した Bot アプリケーションは、接続先としてローカルの Web サービス “development”(http://localhost:3978/api/messages) のみ定義されています。

bfv4_emu_ep_development

Azure Bot Service の Web App Bot で Bot アプリケーションを作り、ZIP ファイルでソースコードをダウンロードした場合には、”development” の他に Azure 上の Web サービス “production” (https://<アプリ名&gt;.azurewebsites.net/api/messages) も定義されています。

bfv4_emu_ep_production

Emulator 上でどちらに接続するかを選択して、デバッグやテスト、動作確認ができるということです。


ローカルのテンプレートでアプリケーションを作成した Bot アプリケーションを Azure に発行した後では、当然 Emulator から接続したくなります。
その場合、Emulator でエンドポイントの定義を追加することができます。

左ペインの [ENDPOINT] – [+] をクリックすると、エンドポイントの編集ダイアログが表示されます。ここに接続したい Web アプリケーションの情報を入力することで新しいアプリケーションに接続できるようになります。

bfv4_add_endpoint

エンドポイントを追加した後で、Emulator では明示的に保存のための操作は不要です。
Emuulator を閉じると自動的に bot ファイルに反映されています。
これにより、タイプミスなどなく bot ファイルを編集することができます。

なお Emulator は Visual Studio でデバッグ実行を開始した後で開くものだと考えてしまうかもしれませんが、そんなことはありません。
任意のタイミングで bot ファイルを Emulator で開くことができます。Azure から ZIP でソースコードをダウンロードした直後で Visual Studio で一度も開いていないタイミングであっても問題ありません。


テストクライアントとしての機能の最後に、(これもご存知かと思いますが)会話全体のログや選択した Activity (直感的にはユーザー、Bot 双方の吹き出しの一つ一つ) の JSON 形式のデータが表示されることも確認しておきましょう。

bfv4_act_and_log

これらはデバッグ時には非常に大事な情報です。注意して見るようにするといいと思います。
また JSON 形式の Activity データは Bot Framework で開発をしていると、よく目にするデータです。
デバッグ時に限らず、設計時や運用開始後のトラブルシューティングでも目にします。これらについては後の回で紹介するので、今からフォーマットに慣れておくといいと思います。

Bot Framework Emulator V4 の機能紹介の第1回目、テストクライアント機能については以上です。
Bot 開発をしている人であればすでにご存じの内容だと思いますが、一度確認しておきました。

次回からは、Emulator の意外と知られていない機能を紹介していきます。

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

#BotFramework Emulator の機能 #1 ~ Bot アプリケーションのテストクライアント機能 への4件のフィードバック

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

  2. ピンバック: 「 #BotFramework Emulator はこんなにすごい」セッションを担当しました&資料を公開しました (#Cogbot 勉強会 #18 ~ 2018年11月28日開催) | 技術との戯れ

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

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

コメントを残す

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

WordPress.com ロゴ

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

Google+ フォト

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

Twitter 画像

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

Facebook の写真

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

%s と連携中