エミュレーターを使用したデバッグDebug with the emulator

Bot Framework Emulator は、ローカルでもリモートでも、ボットをテストし、デバッグできるデスクトップ アプリケーションです。The Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots, either locally or remotely. このエミュレーターを使用し、ボットとチャットしたり、ボットが送受信するメッセージを検査したりできます。Using the emulator, you can chat with your bot and inspect the messages that your bot sends and receives. このエミュレーターでは、Web チャット UI に表示されるときと同じようにメッセージが表示され、ボットとメッセージを交換するときの JSON の要求と応答がログに記録されます。The emulator displays messages as they would appear in a web chat UI and logs JSON requests and responses as you exchange messages with your bot. 自分のボットをクラウドにデプロイする前に、エミュレーターを使用してローカルで実行し、テストしてください。Before you deploy your bot to the cloud, run it locally and test it using the emulator. まだ Azure Bot Service で作成していない場合でも、何らかのチャネルで実行するように構成していない場合でも、エミュレーターを使用して自分のボットをテストできます。You can test your bot using the emulator even if you have not yet created it with Azure Bot Service or configured it to run on any channels.

前提条件Prerequisites

localhost で実行されているボットに接続するConnect to a bot running on localhost

エミュレーター UI

ローカルで実行されているボットに接続するには、[Open bot](ボットを開く) をクリックするか、事前構成済みファイル (.bot ファイル) を選択します。To connect to a bot running locally, click Open bot or select you preconfigured configuration file (a .bot file). ご自身のボットへの接続に構成ファイルは必要はありませんが、ボットに構成ファイルがある場合、エミュレーターは引き続きそのファイルで動作します。You don't need a configuration file to connect to your bot, but the emulator still works with one if your bot has one. お使いのボットが Microsoft アカウント (MSA) の資格情報で実行されている場合は、その資格情報も入力します。If your bot is running with Microsoft Account (MSA) credentials, enter these credentials too.

エミュレーター UI

インスペクターを利用してメッセージ アクティビティの詳細を表示するView detailed Message Activity with the Inspector

ボットにメッセージを送信すると、ボットが応答するはずです。Send message to your bot and the bot should respond back. 会話ウィンドウ内でメッセージ吹き出しをクリックし、ウィンドウの右にある INSPECTOR 機能を使用して raw JSON アクティビティを検査できます。You can click on message bubble within the conversation window and inspect the raw JSON activity using the INSPECTOR feature to the right of the window. メッセージ吹き出しは選択すると黄色になり、アクティビティ JSON オブジェクトがチャット ウィンドウの左に表示されます。When selected, the message bubble will turn yellow and the activity JSON object will be displayed to the left of the chat window. JSON 情報には、チャネル ID、アクティビティの種類、会話 ID、テキスト メッセージ、エンドポイント URL など、重要なメタデータが含まれます。ユーザーから送信されたアクティビティやボットの応答アクティビティを検査できます。JSON information includes key metadata including channelID, activity type, conversation id, the text message, endpoint URL, etc. You can inspect activities sent from the user, as well as activities the bot responds with.

エミュレーターのメッセージ アクティビティ

ボット トランスクリプトと共に会話を保存し、読み込むSave and load conversations with bot transcripts

エミュレーターのアクティビティはトランスクリプトとして保存できます。Activities in the emulator can be saved as transcripts. 開いているライブ チャット ウィンドウで、[Save Transcript As](トランスクリプトを名前を付けて保存) を選択してトランスクリプト ファイルを保存します。From an open live chat window, select Save Transcript As to the transacript file. [やり直す] ボタンを使用し、いつでも会話を消去し、ボットへの接続を再起動できます。The Start Over button can be used any time to clear a conversation and restart a connection to the bot.

エミュレーターでトランスクリプトを保存する

トランスクリプトを読み込むには、[ファイル] > [Open Transcript File](トランスクリプト ファイルを開く) の順に選択し、トランスクリプトを選択します。To load transcripts, simply select File > Open Tranascript File and select the transcript. 新しいトランスクリプト ウィンドウが開き、出力ウィンドウにメッセージ アクティビティが表示されます。A new Transcript window will open and render the message activity to the output window.

エミュレーターでトランスクリプトを読み込む

サービスの追加Add services

エミュレーターからボットに直接 LUIS アプリ、QnA ナレッジベース、ディスパッチ モデルを簡単に追加できます。You can easily add a LUIS app, QnA knowledge base, or dispatch model to your bot directly from the emulator. ボットが読み込まれたら、エミュレーター ウィンドウの左端にあるサービス ボタンを選択します。When the bot is loaded, select the services button on the far left of the emulator window. [サービス] メニューの下に LUIS、QnA Maker、ディスパッチ を追加するためのオプションが表示されます。You will see options under the Services menu to add LUIS, QnA Maker, and Dispatch.

サービス アプリを追加するには、+ ボタンをクリックして、追加するサービスを選択します。To add a service app, simply click on the + button and select the service you want to add. Azure portal にサインインしてボット ファイルにサービスを追加し、そのサービスをボット アプリケーションに接続するよう求められます。You will be prompted to sign in to the Azure portal to add the service to the bot file, and connect the service to your bot application.

重要

サービスの追加は、.bot 構成ファイルを使用している場合にのみ機能します。Adding services only works if you're using a .bot configuration file. サービスは個別に追加する必要があります。Services will need to be added independently. 詳細については、「ボット リソースの管理」または追加しようとしているサービスに関する個別のハウツー記事をご覧ください。For details on that, see Manage bot resources or the individual how to articles for the service you're trying to add.

.bot ファイルを使用していない場合、(ご自身のボットでサービスが使用されていても) 左側のウィンドウにはサービスは表示されず、"サービスが使用できない" ことを示すメッセージが表示されます。If you are not using a .bot file, the left pane won't have your services listed (even if your bot uses services) and will display Services not available.

LUIS 接続

いずれかのサービスが接続されているとき、ライブ チャット ウィンドウに戻り、サービスが接続され、動作していることを確認できます。When either service is connected, you can go back to a live chat window and verify that your services are connected and working.

QnA 接続完了

サービスの検査Inspect services

新しい v4 エミュレーターでは、LUIS と QnA から JSON 応答を検査することもできます。With the new v4 emulator you can also inspect the JSON responses from LUIS and QnA. ボットと言語サービスが接続されているとき、右下の LOG ウィンドウにある [トレース] を選択できます。Using a bot with a connected language service, you can select trace in the LOG window to the bottom right. この新しいツールには、エミュレーターから直接、言語サービスを更新するための機能もあります。This new tool also provides features to update your language services directly from the emulator.

LUIS インスペクター

LUIS サービスに接続しているとき、トレース リンクに Luis Trace と指定されていることに気付きます。With a connected LUIS service, you'll notice that the trace link specifies Luis Trace. これが選択されると、意図、エンティティ、指定スコアなど、LUIS サービスからの raw 応答が表示されます。When selected, you'll see the raw response from your LUIS service, which includes intents, entities along with their specified scores. ユーザー発話の意図を再割り当てすることもできます。You also have the option to re-assign intents for your user utterances.

QnA インスペクター

QnA サービスに接続しているとき、ログに QnA Trace と表示されます。これが選択されると、そのアクティビティに関連付けられている質問と回答の組みと信頼度スコアをプレビューできます。With a connected QnA service, the log will display QnA Trace, and when selected you can preview the question and answer pair associated with that activity, along with a confidence score. ここから、ある回答に対する質問に別の言い回しを追加できます。From here, you can add alternative question phrasing for an answer.

Azure にログインするLogin to Azure

Emulator を使って、ご自身の Azure アカウントにログインできます。You can use Emulator to login in to your Azure account. これは、ご自身のボットが依存するサービスを追加および管理するときに特に役に立ちます。This is particularly helpful for you to add and manage services your bot depends on. Emulator を使用して管理できるサービスの詳細については、の説明を参照してください。See above to learn more about services you can manage using the Emulator.

ログインするTo login

Azure ログイン

ログインするにはTo login

  • [ファイル]、[Sign in with Azure](Azure を使ってサインインする) の順にクリックしますYou can click on File -> Sign in with Azure
  • ようこそ画面で、[Sign in with your Azure account](Azure アカウントを使ってサインインする) をクリックします。Emulator アプリケーションを再起動しても、その Emulator でのサインイン状態が継続されるようにするように設定することもできます。On the welcome screen click on Sign in with your Azure account You can optionally have Emulator keep you signed in across Emulator application restarts.

Azure ログイン

データ収集の無効化Disabling data collection

Emulator による使用状況データの収集を許可する必要がなくなった場合は、次の手順に従って、データ収集を簡単に無効にできます。If you decide that you no longer want to allow the Emulator to collect usage data, you can easily disable data collection by following these steps:

  1. 左側のナビゲーション バーにある設定ボタン (歯車アイコン) をクリックして、Emulator の設定ページに移動します。Navigate to the Emulator's settings page by clicking on the Settings button (gear icon) in the nav bar on the left side.

    データ収集を無効にする

  2. [データ収集] セクションの [Help improve the Emulator by allowing us to collect usage data](使用状況データの収集を許可して Emulator を改善する) チェック ボックスをオフにします。Uncheck the checkbox labeled Help improve the Emulator by allowing us to collect usage data under the Data Collection section.

    データ収集を無効にする

  3. [Save](保存) ボタンをクリックします。Click the "Save" button.

    データ収集を無効にする

気が変わった場合は、いつでもチェック ボックスをオンにして有効にできます。If you change your mind, you can always enable it by re-checking the checkbox.

その他のリソースAdditional resources

Bot Framework Emulator はオープン ソースです。The Bot Framework Emulator is open source. 開発に貢献したり、バグや提案を送信したりできます。You can contribute to the development and submit bugs and suggestions.

トラブルシューティングについては、一般的な問題のトラブルシューティングに関する記事、およびそのセクションに示されているトラブルシューティングに関するその他の記事をご覧ください。For troubleshooting, see troubleshoot general problems and the other troubleshooting articles in that section.

次の手順Next steps

会話をトランスクリプト ファイルに保存すると、デバッグのために一連のやり取りの下書きをすばやく作成し、そのやり取りを再生できます。Saving a conversation to a transcript file allows you to quickly draft and replay a certain set of interactions for debugging.