Debugowanie bota przy użyciu plików transkrypcji

DOTYCZY: Zestaw SDK w wersji 4

Jednym z kluczy do pomyślnego testowania i debugowania bota jest możliwość rejestrowania i analizowania zestawu warunków występujących podczas uruchamiania bota. W tym artykule omówiono tworzenie i używanie pliku transkrypcji bota w celu zapewnienia szczegółowego zestawu interakcji użytkownika i odpowiedzi bota na potrzeby testowania i debugowania.

Plik transkrypcji bota

Plik transkrypcji bota to wyspecjalizowany plik JSON, który zachowuje interakcje między użytkownikiem a botem. Plik transkrypcji zachowuje nie tylko zawartość komunikatu, ale także szczegóły interakcji, takie jak identyfikator użytkownika, identyfikator kanału, typ kanału, możliwości kanału, czas interakcji itd. Wszystkie te informacje mogą następnie służyć do znajdowania i rozwiązywania problemów podczas testowania lub debugowania bota.

Tworzenie/przechowywanie pliku transkrypcji bota

W tym artykule pokazano, jak utworzyć pliki transkrypcji bota przy użyciu Bot Framework Emulator. Pliki transkrypcji można również tworzyć programowo; zobacz Magazyn transkrypcji obiektów blob , aby dowiedzieć się więcej na temat tego podejścia. W tym artykule użyjemy przykładowego kodu platformy Bot Framework dla bota multi turn prompt, który żąda trybu transportu, nazwy i wieku użytkownika, ale dowolny kod, do którego można uzyskać dostęp przy użyciu Bot Framework Emulator firmy Microsoft, może służyć do tworzenia pliku transkrypcji.

Aby rozpocząć ten proces, upewnij się, że kod bota, który chcesz przetestować, jest uruchomiony w środowisku projektowym.

1. Uruchom emulator.

2. Na karcie Powitanie wybierz pozycję Otwórz bota.

3. Wprowadź adres portu, do którego nasłuchuje bot, a następnie , /api/messagesna przykład http://localhost:3978/api/messages.

   Jeśli bot jest skonfigurowany przy użyciu identyfikatora aplikacji i hasła firmy Microsoft, wprowadź identyfikator i hasło w oknie dialogowym Otwieranie bota . W przeciwnym razie emulator nie będzie mógł nawiązać połączenia z botem.

4. Wybierz pozycję Połącz, aby połączyć emulator z botem.

   

Przetestuj kod, korzystając z bota w emulatorze. Po wprowadzeniu wszystkich interakcji użytkownika, które chcesz zachować, użyj Bot Framework Emulator, aby utworzyć i zapisać plik transkrypcji zawierający tę konwersację.

1. Na karcie Czat na żywo wybierz pozycję Zapisz transkrypcję.

   

2. Wybierz lokalizację i nazwę pliku transkrypcji, a następnie wybierz pozycję Zapisz.

   

Wszystkie interakcje użytkownika i odpowiedzi bota wprowadzone w celu przetestowania kodu za pomocą emulatora zostały teraz zapisane w pliku transkrypcji, który można później ponownie załadować, aby ułatwić debugowanie interakcji między użytkownikiem a botem.

Pobieranie pliku transkrypcji bota

Po otwarciu pliku transkrypcji emulator ładuje zapisaną konwersację na nowej karcie.

Aby pobrać plik transkrypcji bota:

1. Otwórz emulator.
2. Z menu wybierz pozycję Plik , a następnie otwórz transkrypcję.
3. Użyj pliku Transkrypcji Otwórz , aby wybrać i otworzyć plik transkrypcji, który chcesz pobrać.

Debugowanie przy użyciu pliku transkrypcji

Po załadowaniu pliku transkrypcji możesz teraz debugować interakcje przechwycone między użytkownikiem a botem.

1. Wybierz dowolnego użytkownika lub komunikat bota albo działanie zarejestrowane w okienku dziennika emulatora.

2. Emulator wyświetli informacje o działaniu w okienku inspektora . Informacje o działaniu to ładunek żądania HTTP dla działania.

   Działanie komunikatu obejmuje:

   • Typ działania
   • Czas wysłania działania lub odebrania go przez kanał
   • Informacje o kanale użytkownika
   • Informacje o nadawcy i odbiorcy działania, odpowiednio w from polach i recipient
   • Informacje specyficzne dla typu działania, takie jak tekst wiadomości dla działania wiadomości.

Ten szczegółowy poziom informacji umożliwia wykonywanie interakcji krok po kroku między danymi wejściowymi użytkownika a odpowiedzią bota, co jest przydatne w przypadku debugowania sytuacji, w których bot nie odpowiedział w sposób oczekiwany lub nie odpowiedział na użytkownika. Posiadanie zarówno tych wartości, jak i rekord kroków poprzedzających nieudaną interakcję pozwala przejść przez kod, znaleźć lokalizację, w której bot nie odpowiada zgodnie z oczekiwaniami, i rozwiązać te problemy.

Używanie plików transkrypcji wraz z Bot Framework Emulator jest tylko jednym z wielu narzędzi, których można użyć, aby ułatwić testowanie i debugowanie kodu i interakcji użytkownika bota.

Dodatkowe informacje

Aby uzyskać więcej informacji dotyczących testowania i debugowania, zobacz:

• Wskazówki dotyczące testowania i debugowania bota
• Debugowanie za pomocą Bot Framework Emulator
• Rozwiązywanie ogólnych problemów i innych artykułów dotyczących rozwiązywania problemów w tej sekcji.
• Debugowanie w Visual Studio