Depurar seu bot usando arquivos de transcrição

aplica-se a: SDK v4

Uma das chaves para testar e depurar um bot com sucesso é sua capacidade de registrar e examinar o conjunto de condições que ocorrem durante a execução do bot. Este artigo aborda a criação e uso de um arquivo de transcrição do bot para fornecer um conjunto detalhado de interações do usuário e respostas do bot para teste e depuração.

O arquivo de transcrição do bot

Um arquivo de transcrição do bot é um arquivo JSON especializado que preserva as interações entre um usuário e seu bot. Um arquivo de transcrição preserva não apenas o conteúdo de uma mensagem, mas também os detalhes da interação como a id de usuário, id do canal, tipo de canal, recursos do canal, a hora do interação, etc. Todas essas informações podem posteriormente ser usadas para ajudar a encontrar e resolver problemas ao testar ou depurar seu bot.

Criar/armazenar um arquivo de transcrição de bot

Este artigo mostra como criar arquivos de transcrição de bot usando o Bot Framework Emulator da Microsoft. Os arquivos de transcrição também podem ser criados programaticamente; consulte armazenamento de transcrição de blob para ler mais sobre essa abordagem. Neste artigo, usaremos o código de exemplo do Bot Framework para Multi Turn Prompt Bot que solicita o modo de transporte, o nome e a idade do usuário, mas qualquer código que possa ser acessado usando o Microsoft Bot Framework Emulator pode ser usado para criar um arquivo de transcrição.

Para iniciar esse processo, verifique se o código do bot que você deseja testar está em execução dentro de seu ambiente de desenvolvimento. Inicie o emulador do bot Framework, selecione o botão abrir bot e insira o endereço do localhost: porta mostrada em seu navegador, seguido por "/API/messages", conforme mostrado na imagem abaixo. Agora, clique no botão conectar para conectar o emulador ao bot.

conectar o emulador ao seu código

Depois de conectar o emulador ao código em execução, teste seu código enviando interações de usuário simuladas para o bot. Neste exemplo passamos o modo de transporte, o nome e a idade do usuário. Depois de inserir todas as interações de usuário que você deseja preservar, use o emulador do bot Framework para criar e salvar um arquivo de transcrição que contém essa conversa.

Na guia Chat ao vivo (mostrada abaixo), escolha o botão Salvar transcrição.

escolher salvar transcrição

Escolha um local e um nome para o arquivo de transcrição e, em seguida, escolha o botão salvar.

transcrição salvar como ursula

Todas as interações de usuário e respostas de bot que você inseriu para testar seu código com o emulador agora foram salvas em um arquivo de transcrição que você pode recarregar posteriormente para ajudar a depurar as interações entre o usuário e o bot.

Recuperar um arquivo de transcrição de bot

Para recuperar um arquivo de transcrição de bot usando o emulador do bot Framework, selecione o arquivo e, em seguida, abra transcrição... no canto superior esquerdo do emulador, conforme mostrado abaixo. Em seguida, escolha o arquivo de transcrição que você deseja recuperar. (As transcrições também podem ser acessadas de dentro do controle de lista transcrições na seção de recursos do emulador)

Neste exemplo estamos recuperando o arquivo de transcrição denominado “ursula_user.transcript”. A seleção de um arquivo de transcrição carregará automaticamente toda a conversa preservada em uma nova guia chamada transcrição.

recuperar transcrição salva

Depurar usando o arquivo de transcrição

Com seu arquivo de transcrição carregado, você agora está pronto para depurar as interações que capturadas entre um usuário e seu bot. Para fazer isso, basta clicar em qualquer evento ou atividade registrada na seção log mostrada na área inferior direita do emulador. No exemplo mostrado abaixo, escolhemos a primeira interação do usuário quando ele enviou a mensagem "Olá". Quando fazemos isso, todas as informações em seu arquivo de transcrição sobre essa interação específica são exibidas na janela Inspetor do emulador no formato JSON. Ao observar alguns desses valores de baixo para cima, podemos ver:

  • O tipo de interação era mensagem.
  • A hora em que a mensagem foi enviada.
  • Que o texto sem formatação enviado continha "Sim".
  • Que a mensagem foi enviada ao nosso bot.
  • A id e as informações do usuário.
  • A id, recursos e informações do canal.

depurar usando transcrição

Esse nível detalhado de informações permite que você siga as interações passo a passo entre a entrada do usuário e a resposta do bot, o que é útil para situações de depuração em que o bot não responde de volta da maneira esperada ou simplesmente não responde ao usuário. Ter esses valores e um registro das etapas até a interação com falha permite percorrer o código, localizar o local onde o bot não responde conforme o esperado e resolver esses problemas.

Usar arquivos de transcrição juntamente com o Bot Framework Emulator é apenas uma das muitas ferramentas que você pode usar para ajudá-lo a testar e depurar o código do bot e as interações do usuário. Para ver mais maneiras de testar e depurar seu bot, confira os recursos adicionais listados abaixo.

Informações adicionais

Para outras informações sobre teste e depuração confira: