使用文字記錄檔進行 Bot 偵錯
適用于: SDK v4
成功進行 Bot 測試和偵錯的關鍵之一,就是能夠記錄並檢查在執行 Bot 時所發生的一些情況。 本文討論 Bot 文字記錄檔的建立和使用方式,以提供一組詳細的使用者互動和 Bot 回應以供測試和偵錯。
Bot 文字記錄檔
Bot 文字記錄檔是特製化的 JSON 檔案,可保留使用者與 Bot 之間的互動。 文字記錄檔不僅會保留訊息的內容,也會保留互動詳細資料,例如使用者識別碼、通道識別碼、通道類型、通道功能、互動時間等等。 這些資訊接著可用來協助尋找及解決 Bot 測試或偵錯時的問題。
建立/儲存 Bot 文字記錄檔
本文說明如何使用Bot Framework Emulator建立 Bot 文字記錄檔。 您也可以以程式設計方式建立文字記錄檔;請參閱 Blob 文字記錄儲存體 ,以深入瞭解該方法。 在本文中,我們將使用多回合提示 Bot的 Bot Framework 範例程式碼,要求使用者的運輸模式、名稱和年齡,但可以使用 Microsoft 的Bot Framework Emulator存取的任何程式碼,都可用來建立文字記錄檔。
若要開始此程式,請確定您想要測試的 Bot 程式碼正在開發環境中執行。
啟動模擬器。
在 [歡迎使用] 索引標籤上,選取 [開啟 Bot]。
輸入 Bot 正在接聽的埠位址,後面接著
/api/messages
,例如http://localhost:3978/api/messages
。如果您的 Bot 設定為 Microsoft 應用程式識別碼和密碼,請在 [ 開啟 Bot ] 對話方塊中輸入識別碼和密碼。 否則,模擬器將無法連線到您的 Bot。
選取 [連線 ] 以將模擬器連線到您的 Bot。
在模擬器中與 Bot 互動,以測試您的程式碼。 輸入您想要保留的所有使用者互動之後,請使用Bot Framework Emulator來建立並儲存包含此交談的文字記錄檔。
在 [ 即時聊天] 索引標籤中,選取 [ 儲存文字記錄]。
選擇文字記錄檔的位置和名稱,然後選取 [ 儲存]。
您輸入以使用模擬器測試程式碼的所有使用者互動和 Bot 回應現在都已儲存到文字記錄檔中,稍後您可以重載,以協助偵錯使用者與 Bot 之間的互動。
擷取 Bot 文字記錄檔
當您開啟文字記錄檔時,模擬器會將儲存的交談載入新的索引標籤。
若要擷取 Bot 文字記錄檔:
- 開啟模擬器。
- 從功能表中,選取 [ 檔案 ],然後 選取 [開啟文字記錄]。
- 使用 [開啟文字記錄檔 ] 來選取並開啟您想要擷取的文字記錄檔。
使用文字記錄檔進行偵錯
載入文字記錄檔後,您現在可以開始對使用者與 Bot 之間擷取的互動進行偵錯。
選取模擬器 記錄 窗格中記錄的任何使用者或 Bot 訊息或活動。
模擬器會在 偵測器 窗格中顯示活動資訊。 活動資訊是活動的 HTTP 要求承載。
訊息活動包括:
- 活動類型
- 從通道傳送或接收活動的時間
- 使用者通道的相關資訊
- 活動傳送者和接收者的相關資訊,分別位於
from
和recipient
欄位中 - 活動類型的特定資訊,例如訊息活動的訊息文字。
這項詳細的資訊層級可讓您遵循使用者輸入與 Bot 回應之間的逐步互動,這適用于偵錯 Bot 未以您預期或完全未回應使用者的方式回應的情況。 同時擁有這些值和導致失敗互動之步驟的記錄,可讓您逐步執行程式碼、尋找 Bot 未如預期回應的位置,以及解決這些問題。
使用文字記錄檔搭配 Bot Framework 模擬器,只是可用來協助您進行 Bot 程式碼與使用者互動測試和偵錯的許多工具之一。
其他資訊
如需更多測試和偵錯資訊,請參閱:
- Bot 測試和偵錯指導方針
- 使用 Bot Framework 模擬器進行偵錯
- 針對一般問題進行疑難排解以及該區段中的其他疑難排解文章。
- Visual Studio 偵錯