Depurar o seu bot usando ficheiros de transcrição

APLICA-SE A: SDK v4

Uma das chaves para testar e depurar um bot com sucesso é a sua capacidade de gravar e examinar o conjunto de condições que ocorrem ao executar o seu bot. Este artigo discute a criação e utilização de um ficheiro de transcrição de bot para fornecer um conjunto detalhado de interações de utilizadores e respostas bot para testes e depurações.

O ficheiro de transcrição de bot

Um ficheiro de transcrição de bot é um ficheiro JSON especializado que preserva as interações entre um utilizador e o seu bot. Um ficheiro de transcrição preserva não só o conteúdo de uma mensagem, mas também detalhes de interação como o ID do utilizador, iD do canal, tipo de canal, capacidades de canal, tempo da interação, e assim por diante. Todas estas informações podem então ser usadas para ajudar a encontrar e resolver problemas ao testar ou depurar o seu bot.

Criar/Armazenar um ficheiro de transcrição de bot

Este artigo mostra como criar ficheiros de transcrição de bot usando o Bot Framework Emulator. Os ficheiros de transcrição também podem ser criados programáticamente; ver armazenamento de transcrição Blob para ler mais sobre esta abordagem. Neste artigo, usaremos o código de amostra do Bot Framework para o Multi Turn Prompt Bot que solicita o modo de transporte, nome e idade de um utilizador, mas qualquer código que possa ser acedido usando o Bot Framework Emulator da Microsoft pode ser usado para criar um ficheiro de transcrição.

Para iniciar este processo, certifique-se de que o código bot que pretende testar está a funcionar dentro do seu ambiente de desenvolvimento.

1. Inicie o Emulador.

2. No separador Welcome , selecione Open Bot.

3. Insira o endereço da porta a que o seu bot está a ouvir, seguido de, por /api/messagesexemplo, http://localhost:3978/api/messages.

   Se o seu bot estiver configurado com um ID e senha de aplicação da Microsoft, insira o ID e a palavra-passe no Open um diálogo bot . Caso contrário, o Emulator não poderá ligar-se ao seu bot.

4. Selecione Connect para ligar o Emulador ao seu bot.

   

Teste o seu código interagindo com o seu bot no Emulator. Depois de ter introduzido todas as interações do utilizador que pretende preservar, utilize o Bot Framework Emulator para criar e guardar uma transcrição que contenha esta conversa.

1. No separador Live Chat , selecione Guardar a transcrição.

   

2. Escolha uma localização e nome para o seu ficheiro de transcrição e selecione Save.

   

Todas as interações do utilizador e as respostas bot que inseriu para testar o seu código com o Emulator foram agora guardadas num ficheiro de transcrição que poderá posteriormente recarregar para ajudar a depurar interações entre o utilizador e o seu bot.

Recuperação de um ficheiro de transcrição de bot

Quando abre um ficheiro de transcrição, o Emulator carrega a conversa guardada numa nova guia.

Para recuperar um ficheiro de transcrição de bot:

1. Abra o Emulador.
2. A partir do menu, selecione 'Arquivo' e depois Abra a Transcrição.
3. Utilize o ficheiro de transcrição Open para selecionar e abrir o ficheiro de transcrição que pretende recuperar.

Depurar usando ficheiro de transcrição

Com o seu ficheiro de transcrição carregado, está agora pronto para depurar interações que capturou entre um utilizador e o seu bot.

1. Selecione qualquer utilizador ou mensagem bot, ou atividade registada no painel de registo do Emulador.

2. O Emulador mostrará a informação de atividade no painel de inspetores . A informação da atividade é a carga útil do pedido HTTP para a atividade.

   Uma atividade de mensagem inclui:

   • O tipo de atividade
   • O momento em que a atividade foi enviada ou recebida pelo canal
   • Informação sobre o canal do utilizador
   • Informação sobre o remetente e recetor da atividade, nos from campos e recipient campos, respectivamente
   • Informação específica para o tipo de atividade, como o texto de mensagem para uma atividade de mensagem.

Este nível de informação detalhado permite-lhe acompanhar as interações passo a passo entre a entrada do utilizador e a resposta do seu bot, o que é útil para depurar situações em que o seu bot não respondeu da forma que antecipou ou não respondeu ao utilizador. Ter estes valores e um registo dos passos que antecedem a interação falhada permite-lhe passar pelo seu código, encontrar o local onde o seu bot não responde como previsto, e resolver esses problemas.

A utilização de ficheiros de transcrição juntamente com o Bot Framework Emulator é apenas uma das muitas ferramentas que pode usar para o ajudar a testar e depurar o código do seu bot e as interações do utilizador.

Informações adicionais

Para obter mais informações sobre testes e depuragem, consulte:

• Orientações de teste e depuragem de bots
• Depurar com o Bot Framework Emulator
• Resolver problemas gerais e outros artigos de resolução de problemas nessa secção.
• Debugging no Estúdio Visual