Depuración del bot mediante archivos de transcripción

  • Artículo

SE APLICA A: SDK v4

Una de las claves para probar y depurar correctamente un bot es la capacidad para registrar y examinar el conjunto de condiciones que se producen al ejecutar el bot. En este artículo se trata la creación y el uso de un archivo de transcripción de bots para proporcionar un conjunto detallado de interacciones del usuario y respuestas del bot para pruebas y depuración.

Archivo de transcripción de bot

Un archivo de transcripción de bot es un archivo JSON especializado que conserva las interacciones entre un usuario y el bot. Un archivo de transcripción conserva no solo el contenido de un mensaje, sino también los detalles de interacción, como el identificador de usuario, el identificador de canal, el tipo de canal, las funcionalidades del canal, el tiempo de la interacción, etc. Toda esta información puede usarse para ayudar a encontrar y resolver problemas al probar o depurar el bot.

Creación o almacenamiento de un archivo de transcripción de bot

En este artículo se muestra cómo crear archivos de transcripción de bots mediante el Bot Framework Emulator. También se pueden crear archivos de transcripción mediante programación; Consulte Almacenamiento de transcripciones de blobs para obtener más información sobre ese enfoque. En este artículo, usaremos el código de ejemplo de Bot Framework para el bot de solicitud multiturno que solicita el modo de transporte, el nombre y la antigüedad de un usuario, pero cualquier código al que se pueda acceder mediante el Bot Framework Emulator de Microsoft se puede usar para crear un archivo de transcripción.

Para comenzar este proceso, asegúrese de que el código del bot que desea probar se está ejecutando en el entorno de desarrollo.

  1. Inicie el emulador.

  2. En la pestaña Bienvenida seleccione Open Bot (Abrir bot).

  3. Escriba la dirección del puerto al que escucha el bot, seguido de /api/messages, por ejemplo, http://localhost:3978/api/messages.

    Si el bot está configurado con un identificador y una contraseña de aplicación de Microsoft, escriba el identificador y la contraseña en el cuadro de diálogo Abrir un bot . De lo contrario, el emulador no podrá conectarse al bot.

  4. Seleccione Conectar para conectar el emulador al bot.

    Captura de pantalla del cuadro de diálogo para conectarse a un bot desde el emulador.

Pruebe el código interactuando con el bot en el emulador. Después de escribir todas las interacciones del usuario que desea conservar, use el Bot Framework Emulator para crear y guardar un archivo de transcripción que contenga esta conversación.

  1. En la pestaña Live Chat , seleccione Guardar transcripción.

    Captura de pantalla de una conversación y el botón

  2. Elija una ubicación y un nombre para el archivo de transcripción y seleccione Guardar.

    Captura de pantalla del cuadro de diálogo

Todas las interacciones del usuario y las respuestas del bot que escribió para probar el código con el emulador ahora se han guardado en un archivo de transcripción que puede volver a cargar posteriormente para ayudar a depurar las interacciones entre el usuario y el bot.

Recuperación de un archivo de transcripción de bot

Al abrir un archivo de transcripción, el emulador carga la conversación guardada en una nueva pestaña.

Para recuperar un archivo de transcripción del bot:

  1. Abra el emulador.
  2. En el menú, seleccione Archivo y, después, Abrir transcripción.
  3. Use el archivo Abrir transcripción para seleccionar y abrir el archivo de transcripción que desea recuperar.

Captura de pantalla del cuadro de diálogo

Depuración con el archivo de transcripción

Con el archivo de transcripción cargado, ya está listo para depurar las interacciones que capturó entre un usuario y el bot.

  1. Seleccione cualquier mensaje de usuario o bot, o actividad registrada en el panel de registro del emulador.

  2. El emulador mostrará la información de actividad en el panel inspector . La información de actividad es la carga de la solicitud HTTP para la actividad.

    Una actividad de mensaje incluye:

    • Tipo de actividad
    • Hora a la que el canal envió o recibió la actividad.
    • Información sobre el canal del usuario
    • Información sobre el remitente y el receptor de la actividad, en los from campos y recipient , respectivamente
    • Información específica del tipo de actividad, como el texto del mensaje para una actividad de mensaje.

Este nivel detallado de información permite seguir las interacciones paso a paso entre la entrada del usuario y la respuesta del bot, lo que resulta útil para depurar situaciones en las que el bot no respondió de la manera prevista o no respondió al usuario. Tener estos valores y un registro de los pasos que conducen a la interacción con errores le permite recorrer el código, buscar la ubicación donde el bot no responde según lo previsto y resolver esos problemas.

El uso de archivos de transcripción junto con Bot Framework Emulator es solo una de las muchas herramientas que puede utilizar para ayudarle a probar y depurar el código del bot y las interacciones del usuario.

Información adicional

Para obtener más información sobre pruebas y depuración, consulte: