Freigeben über

Debuggen Ihres Bots mit Transkriptdateien

  • Artikel

GILT FÜR: SDK v4

Einer der Schlüssel für das erfolgreiche Testen und Debuggen eines Bots ist, dass Sie die Bedingungen aufzeichnen und untersuchen können, die beim Ausführen Ihres Bots herrschen. In diesem Artikel wird die Erstellung und Verwendung einer Bot-Transkriptdatei beschrieben, um einen ausführlichen Satz mit Benutzerinteraktionen und Bot-Antworten für das Testen und Debuggen bereitzustellen.

Bot-Transkriptdatei

Eine Bot-Transkriptdatei ist eine spezielle JSON-Datei, mit der die Interaktionen zwischen einem Benutzer und Ihrem Bot beibehalten (gespeichert) werden. Eine Transkriptdatei behält nicht nur den Inhalt einer Nachricht, sondern auch Interaktionsdetails wie die Benutzer-ID, Kanal-ID, Kanaltyp, Kanalfunktionen, Zeit der Interaktion und so weiter. Diese Informationen können dann verwendet werden, um beim Testen bzw. Debuggen Ihres Bots Probleme zu ermitteln und zu beheben.

Erstellen/Speichern einer Bot-Transkriptdatei

In diesem Artikel wird gezeigt, wie Sie Bot-Transkriptdateien mithilfe der Bot Framework Emulator erstellen. Transkriptdateien können auch programmgesteuert erstellt werden; Siehe Blob-Transkriptspeicher , um mehr über diesen Ansatz zu erfahren. In diesem Artikel verwenden wir den Bot Framework-Beispielcode für Multi Turn Prompt Bot, der den Transportmodus, den Namen und das Alter eines Benutzers anfordert, aber jeder Code, auf den mithilfe der Bot Framework Emulator von Microsoft zugegriffen werden kann, kann verwendet werden, um eine Transkriptdatei zu erstellen.

Stellen Sie sicher, dass der Botcode, den Sie testen möchten, in Ihrer Entwicklungsumgebung ausgeführt wird.

  1. Starten Sie den Emulator.

  2. Klicken Sie auf der Registerkarte Welcome (Willkommen) auf die Option Open Bot (Bot öffnen).

  3. Geben Sie die Adresse des Ports ein, auf den Ihr Bot zuhört, gefolgt von /api/messages, z http://localhost:3978/api/messages. B. .

    Wenn Ihr Bot mit einer Microsoft-App-ID und einem Kennwort konfiguriert ist, geben Sie die ID und das Kennwort im Dialogfeld " Bot öffnen " ein. Andernfalls kann der Emulator keine Verbindung mit Ihrem Bot herstellen.

  4. Wählen Sie "Verbinden " aus, um den Emulator mit Ihrem Bot zu verbinden.

    Screenshot des Dialogfelds zum Herstellen einer Verbindung mit einem Bot aus dem Emulator.

Testen Sie Ihren Code, indem Sie mit Ihrem Bot im Emulator interagieren. Nachdem Sie alle Benutzerinteraktionen eingegeben haben, die Sie beibehalten möchten, verwenden Sie die Bot Framework Emulator, um eine Transkriptdatei zu erstellen und zu speichern, die diese Unterhaltung enthält.

  1. Wählen Sie auf der Registerkarte "Live Chat" die Option "Transkript speichern" aus.

    Screenshot einer Unterhaltung und der Schaltfläche

  2. Wählen Sie einen Speicherort und Namen für Ihre Transkriptdatei aus, und wählen Sie "Speichern" aus.

    Screenshot des Dialogfelds

Alle Benutzerinteraktionen und Botantworten, die Sie eingegeben haben, um Ihren Code mit dem Emulator zu testen, wurden jetzt in einer Transkriptdatei gespeichert, die Sie später erneut laden können, um Interaktionen zwischen Ihrem Benutzer und Ihrem Bot zu debuggen.

Abrufen einer Bot-Transkriptdatei

Wenn Sie eine Transkriptdatei öffnen, lädt der Emulator die gespeicherte Unterhaltung in eine neue Registerkarte.

So rufen Sie eine Bot-Transkriptdatei ab:

  1. Öffnen Sie den Emulator.
  2. Wählen Sie im Menü "Datei" dann "Transkriptöffnen" aus.
  3. Verwenden Sie die Datei "Transkript öffnen", um die Transkriptdatei auszuwählen und zu öffnen, die Sie abrufen möchten.

Screenshot des Dialogfelds

Debuggen mit der Transkriptdatei

Mit der geladenen Transkriptdatei können Sie jetzt Interaktionen debuggen, die Sie zwischen einem Benutzer und Ihrem Bot erfasst haben.

  1. Wählen Sie eine beliebige Benutzer- oder Botnachricht oder Aktivität aus, die im Protokollbereich des Emulators aufgezeichnet wurde.

  2. Der Emulator zeigt die Aktivitätsinformationen im Inspektorbereich an. Die Aktivitätsinformationen sind die Nutzlast der HTTP-Anforderung für die Aktivität.

    Eine Nachrichtenaktivität umfasst:

    • Der Aktivitätstyp
    • Die Uhrzeit, zu der die Aktivität vom Kanal gesendet oder empfangen wurde
    • Informationen zum Kanal des Benutzers
    • Informationen über den Absender und Empfänger der Aktivität, in den Feldern oder recipient in den from Feldern
    • Informationen, die dem Typ der Aktivität spezifisch sind, z. B. der Nachrichtentext für eine Nachrichtenaktivität.

Diese detaillierte Informationsstufe ermöglicht Es Ihnen, die schrittweisen Interaktionen zwischen der Eingabe des Benutzers und der Antwort Ihres Bots zu befolgen, die für Das Debuggen von Situationen nützlich ist, in denen Ihr Bot entweder nicht auf die Art und Weise reagierte, die Sie erwartet oder nicht auf den Benutzer reagiert haben. Mit diesen Werten und einem Datensatz der Schritte, die zu der fehlgeschlagenen Interaktion führen, können Sie den Code durchlaufen, den Speicherort finden, an dem Ihr Bot nicht wie erwartet reagiert und diese Probleme beheben kann.

Die Nutzung von Transkriptdateien zusammen mit dem Bot Framework Emulator ist nur einer der vielen Tool-Ansätze, die Sie verwenden können, um den Code und die Benutzerinteraktionen Ihres Bots zu testen und zu debuggen.

Zusätzliche Informationen

Weitere Test- und Debuginformationen finden Sie unter: