Eseguire il debug del bot usando i file di trascrizione

  • Articolo

SI APPLICA A: SDK v4

Una delle chiavi per testare ed eseguire correttamente il debug di un bot è la possibilità di registrare ed esaminare l'insieme delle condizioni che si verificano durante l'esecuzione del bot. Questo articolo illustra la creazione e l'uso di un file di trascrizione del bot per fornire un insieme dettagliato di interazioni utente e risposte del bot per i test e il debug.

File di trascrizione del bot

Un file di trascrizione del bot è un file JSON specializzato che conserva le interazioni tra un utente e il bot. Un file di trascrizione mantiene non solo il contenuto di un messaggio, ma anche i dettagli di interazione, ad esempio l'ID utente, l'ID canale, il tipo di canale, le funzionalità del canale, l'ora dell'interazione e così via. Tutte queste informazioni possono essere usate per trovare e risolvere i problemi durante i test o il debug del bot.

Creazione/archiviazione di un file di trascrizione del bot

Questo articolo illustra come creare file di trascrizione bot usando il Bot Framework Emulator. I file di trascrizione possono essere creati anche a livello di codice; vedere Archiviazione trascrizioni BLOB per altre informazioni su tale approccio. In questo articolo si userà il codice di esempio di Bot Framework per il bot di richiesta a più turni che richiede la modalità di trasporto, nome e età di un utente, ma qualsiasi codice a cui è possibile accedere usando il Bot Framework Emulator di Microsoft può essere usato per creare un file di trascrizione.

Per iniziare questo processo, assicurarsi che il codice del bot da testare sia in esecuzione nell'ambiente di sviluppo.

  1. Avviare l'emulatore.

  2. Nella scheda Generale selezionare Apri il bot.

  3. Immettere l'indirizzo della porta in cui il bot è in ascolto, seguito da /api/messages, ad esempio http://localhost:3978/api/messages.

    Se il bot è configurato con un ID e una password dell'app Microsoft, immettere l'ID e la password nella finestra di dialogo Apri un bot . In caso contrario, l'emulatore non sarà in grado di connettersi al bot.

  4. Selezionare Connetti per connettere l'emulatore al bot.

    Screenshot della finestra di dialogo per la connessione a un bot dall'emulatore.

Testare il codice interagendo con il bot nell'emulatore. Dopo aver immesso tutte le interazioni utente da mantenere, usare il Bot Framework Emulator per creare e salvare un file di trascrizione contenente questa conversazione.

  1. Nella scheda Live Chat selezionare Salva trascrizione.

    Screenshot di una conversazione e del pulsante

  2. Scegliere un percorso e un nome per il file di trascrizione e selezionare Salva.

    Screenshot della finestra di dialogo 'Salva trascrizione conversazione'.

Tutte le interazioni utente e le risposte del bot immesse per testare il codice con l'emulatore sono state salvate in un file di trascrizione che è possibile ricaricare in un secondo momento per consentire il debug delle interazioni tra l'utente e il bot.

Recupero di un file di trascrizione del bot

Quando si apre un file di trascrizione, l'emulatore carica la conversazione salvata in una nuova scheda.

Per recuperare un file di trascrizione del bot:

  1. Aprire l'emulatore.
  2. Scegliere File dal menu e quindi Apri trascrizione.
  3. Usare il file di trascrizione Apri per selezionare e aprire il file di trascrizione che si desidera recuperare.

Screenshot della finestra di dialogo

Eseguire il debug usando il file di trascrizione

Dopo aver caricato il file di trascrizione, è ora possibile eseguire il debug delle interazioni acquisite tra un utente e il bot.

  1. Selezionare qualsiasi messaggio utente o bot o attività registrata nel riquadro log dell'emulatore.

  2. L'emulatore visualizzerà le informazioni sull'attività nel riquadro di controllo . Le informazioni sull'attività sono il payload della richiesta HTTP per l'attività.

    Un'attività messaggio include:

    • Tipo di attività
    • Ora in cui l'attività è stata inviata o ricevuta dal canale
    • Informazioni sul canale dell'utente
    • Informazioni sul mittente e sul destinatario dell'attività, rispettivamente nei from campi e recipient
    • Informazioni specifiche del tipo di attività, ad esempio il testo del messaggio per un'attività di messaggio.

Questo livello dettagliato di informazioni consente di seguire le interazioni dettagliate tra l'input dell'utente e la risposta del bot, utile per il debug di situazioni in cui il bot non ha risposto nel modo previsto o non ha risposto affatto all'utente. La presenza di questi valori e di un record dei passaggi che portano all'interazione con errori consente di esaminare il codice, trovare la posizione in cui il bot non risponde come previsto e risolvere questi problemi.

L'uso dei file di trascrizione insieme a Bot Framework Emulator è solo uno dei tanti strumenti che possono essere usati per testare ed eseguire il debug del codice del bot e delle interazioni degli utenti.

Informazioni aggiuntive

Per altre informazioni su test e debug, vedere: