Partilhar via

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 ao executar seu bot. Este artigo discute a criação e o uso de um arquivo de transcrição de bot para fornecer um conjunto detalhado de interações do usuário e respostas de bot para teste e depuração.

O arquivo de transcrição do bot

Um arquivo de transcrição de 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 detalhes de interação, como ID do usuário, ID do canal, tipo de canal, recursos do canal, hora da interação e assim por diante. Todas essas informações podem ser usadas para ajudar a encontrar e resolver problemas ao testar ou depurar seu bot.

Criando/armazenando um arquivo de transcrição do bot

Este artigo mostra como criar arquivos de transcrição de bot usando o Bot Framework Emulator. 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 o Multi Turn Prompt Bot que solicita o modo de transporte, nome e idade de um usuário, mas qualquer código que possa ser acessado usando o Bot Framework Emulator da Microsoft 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á sendo executado em seu ambiente de desenvolvimento.

  1. Inicie o emulador.

  2. Na guia Bem-vindo, selecione Abrir Bot.

  3. Digite o endereço da porta para a qual seu bot está escutando, seguido por /api/messages, por exemplo, http://localhost:3978/api/messages.

    Se o bot estiver configurado com uma ID e senha de aplicativo da Microsoft, insira a ID e a senha na caixa de diálogo Abrir um bot . Caso contrário, o emulador não poderá se conectar ao seu bot.

  4. Selecione Conectar para conectar o emulador ao bot.

    Captura de tela da caixa de diálogo para se conectar a um bot a partir do emulador.

Teste seu código interagindo com seu bot no emulador. Depois de inserir todas as interações do usuário que deseja preservar, use o Bot Framework Emulator para criar e salvar um arquivo de transcrição contendo essa conversa.

  1. Na guia Bate-papo ao vivo , selecione Salvar transcrição.

    Captura de tela de uma conversa e o botão 'salvar transcrição' no emulador.

  2. Escolha um local e um nome para o arquivo de transcrição e selecione Salvar.

    Captura de ecrã da caixa de diálogo 'guardar transcrição da conversa'.

Todas as interações do usuário e as respostas do 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.

Recuperando um arquivo de transcrição do bot

Quando você abre um arquivo de transcrição, o emulador carrega a conversa salva em uma nova guia.

Para recuperar um arquivo de transcrição do bot:

  1. Abra o emulador.
  2. No menu, selecione Arquivo e, em seguida, Abrir transcrição.
  3. Use o Abrir arquivo de transcrição para selecionar e abrir o arquivo de transcrição que deseja recuperar.

Captura de ecrã da caixa de diálogo 'abrir ficheiro de transcrição'.

Depurar usando o arquivo de transcrição

Com o arquivo de transcrição carregado, você está pronto para depurar as interações capturadas entre um usuário e seu bot.

  1. Selecione qualquer mensagem de usuário ou bot ou atividade registrada no painel de log do emulador.

  2. O emulador exibirá as informações de atividade no painel do inspetor . As informações da atividade constituem a carga da solicitação HTTP destinada à atividade.

    Uma atividade de mensagem inclui:

    • O tipo de atividade
    • A hora em que a atividade foi enviada ou recebida pelo canal
    • Informações sobre o canal do usuário
    • Informações sobre o emissor e o destinatário da atividade, nos campos from e recipient, respetivamente
    • Informações específicas para o tipo de atividade, como o texto da mensagem para uma atividade de mensagem.

Esse nível detalhado de informações permite que você acompanhe as interações passo a passo entre a entrada do usuário e a resposta do seu bot, o que é útil para depurar situações em que o bot não respondeu da maneira que você esperava ou não respondeu ao usuário. Ter esses valores e um registro das etapas que levam à interação com falha permite que você percorra seu código, encontre o local onde seu bot não responde como previsto e resolva esses problemas.

Usar arquivos de transcrição junto 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.

Informações adicionais

Para obter mais informações de teste e depuração, consulte: