Depuración del bot mediante archivos de transcripciónDebug your bot using transcript files

se aplica a: SDK V4APPLIES TO: 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.One of the keys to successful testing and debugging a bot is your ability to record and examine the set of conditions that occur when running your 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.This article discusses the creation and use of a bot transcript file to provide a detailed set of user interactions and bot responses for testing and debugging.

Archivo de transcripción de botThe bot transcript file

Un archivo de transcripción de bot es un archivo JSON especializado que conserva las interacciones entre un usuario y el bot.A bot transcript file is a specialized JSON file that preserves the interactions between a user and your bot. Un archivo de transcripción conserva no solo el contenido de un mensaje, sino también detalles de la interacción como el identificador de usuario, el identificador del canal, el tipo de canal, las funciones de canal, la hora de la interacción, etc. Toda esta información puede usarse para ayudar a encontrar y resolver problemas al probar o depurar el bot.A transcript file preserves not only the contents of a message, but also interaction details such as the user id, channel id, channel type, channel capabilities, time of the interaction, etc. All of this information can then be used to help find and resolve issues when testing or debugging your bot.

Creación o almacenamiento de un archivo de transcripción de botCreating/Storing a bot transcript file

En este artículo se muestra cómo crear archivos de transcripción de bot mediante Bot Framework Emulator de Microsoft.This article shows how to create bot transcript files using Microsoft's Bot Framework Emulator. Los archivos de transcripción también se pueden crear mediante programación; Consulte Almacenamiento de transcripciones de blobs para obtener más información sobre ese enfoque.Transcript files may also be created programmatically; see Blob transcript storage to read more concerning that approach. En este artículo se usará el código de ejemplo de Bot Framework para Multi Turn Prompt Bot que solicita un modo de transporte, nombre y edad de un usuario, pero se puede usar cualquier código al que se pueda acceder mediante Bot Framework Emulator de Microsoft para crear un archivo de transcripción.In this article we will use the Bot Framework sample code for Multi Turn Prompt Bot that requests a user's mode of transportation, name and age, but any code that can be accessed using Microsoft's Bot Framework Emulator may be used to create a transcript file.

Para comenzar este proceso, asegúrese de que el código del bot que desea probar se está ejecutando en el entorno de desarrollo.To begin this process ensure that the bot code you want to test is running within your development environment. Inicie bot framework Emulator, seleccione el botón Open Bot (Abrir bot) y escriba la dirección de localhost:port que se muestra en el explorador seguido de "/api/messages", como se muestra en la imagen siguiente.Start the bot framework Emulator, select the Open Bot button, then enter the address of localhost:port shown in your browser followed by "/api/messages" as shown in the image below. Ahora haga clic en el botón Conectar para conectar el emulador al bot.Now click the Connect button to connect the Emulator to your bot.

conectar el emulador al código

Después de conectar el emulador al código en ejecución, pruebe el código mediante el envío de interacciones de usuario simuladas al bot.After connecting the Emulator to your running code, test your code by sending simulated user interactions to the bot. En este ejemplo se ha pasado el modo de transporte, el nombre y la edad del usuario.For this example we have passed in the user's mode of transportation, name and age. Después de especificar todas las interacciones del usuario que desea conservar, use bot framework Emulator para crear y guardar un archivo de transcripción que contenga esta conversación.After you have entered all of the user interactions you want to preserve, use the bot framework Emulator to create and save a transcript file containing this conversation.

Dentro de la pestaña Live Chat (Chat en directo) (que se muestra a continuación), seleccione el botón Save transcript (Guardar transcripción).Within the Live Chat tab (shown below), select the Save transcript button.

selección de save transcript (guardar transcripción)

Elija una ubicación y un nombre para el archivo de transcripción y, después, seleccione el botón Save (Guardar).Choose a location and name for your transcript file and then select the save button.

transcripción guardada como ursula

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 más adelante para ayudar a depurar las interacciones entre el usuario y el bot.All of the user interactions and bot responses that you entered to test your code with the Emulator have now been saved into a transcript file that you can later reload to help debug interactions between your user and your bot.

Recuperación de un archivo de transcripción de botRetrieving a bot transcript file

Para recuperar un archivo de transcripción de bots mediante el Bot Framework Emulator, seleccione Archivo y, después, Abrir transcripción... en la esquina superior izquierda del emulador, como se muestra a continuación.To retrieve a bot transcript file using the Bot Framework Emulator, select the File then Open Transcript... in the upper left corner of the Emulator, as shown below. A continuación, seleccione el archivo de transcripción que se va a recuperar.Next, select the transcript file that you want to retrieve. (También se puede acceder a las transcripciones desde el control de lista TRANSCRIPTS en la sección RECURSOS del emulador)(Transcripts may also be accessed from within the TRANSCRIPTS list control in the RESOURCES section of the Emulator)

En este ejemplo estamos recuperando el archivo de transcripción denominado "ursula_user.transcript".In this example we are retrieving the transcript file named "ursula_user.transcript". Al seleccionar un archivo de transcripción, se cargará automáticamente toda la conversación conservada en una nueva pestaña titulada Transcripción.Selecting a transcript file will automatically load the entire preserved conversation into a new Tab titled Transcript.

recuperación de transcripción guardada

Depuración con el archivo de transcripciónDebug using transcript file

Con el archivo de transcripción cargado, ahora está listo para depurar las interacciones que ha capturado entre el usuario y el bot.With your transcript file loaded, you are now ready to debug interactions that you captured between a user and your bot. Para ello, simplemente haga clic en cualquier evento o actividad registrado en la sección LOG que se muestra en el área inferior derecha del emulador.To do this, simply click on any event or activity recorded in the LOG section shown in the lower right area of the Emulator. En el ejemplo que se muestra a continuación, seleccionamos la primera interacción del usuario cuando este ha enviado el mensaje "Hello".In the example shown below, we selected the user's first interaction when they sent the message "Hello". Al hacerlo, toda la información del archivo de transcripción relativa a esta interacción específica se muestra en la ventana INSPECTOR del emulador en formato JSON.When we do this, all of the information in your transcript file concerning this specific interaction is displayed in the Emulator's INSPECTOR window in JSON format. Si vemos algunos de estos valores de abajo hacia arriba, vemos lo siguiente:Looking at some of these values from the bottom upward, we see the:

  • El tipo de interacción era mensaje.Interaction type was message.
  • El tiempo que se envió el mensaje.Time the message was sent.
  • El texto sin formato enviado contiene "Yes".Plain text sent contained "Yes".
  • El mensaje se envió a nuestro bot.Message was sent to our bot.
  • El identificador de usuario y la información.User id and information.
  • El identificador del canal, funcionalidades e información.Channel id, capabilities and information.

depuración mediante la transcripción

Este nivel detallado de información le permite seguir paso a paso las interacciones entre la entrada del usuario y la respuesta del bot, lo cual es útil para depurar situaciones en las que el bot no ha respondido de la manera esperada o no ha respondido al usuario en absoluto.This detailed level of information allows you to follow the step-by-step interactions between the user's input and your bot's response, which is useful for debugging situations where your bot either did not respond back in the manner that you anticipated or did not respond back to the user at all. Tener estos valores y un registro de los pasos que conducen a la interacción errónea le permite avanzar a través del código, buscar la ubicación donde el bot no responde como se esperaba y resolver esos problemas.Having both these values and a record of the steps leading up to the failed interaction allows you to step through your code, find the location where your bot does not respond as anticipated, and resolve those issues.

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.Using transcript files together with the Bot Framework Emulator is just one of the many tools you can use to help you test and debug your bot's code and user interactions. Para encontrar más formas de probar y depurar el bot, consulte los recursos adicionales que se muestran a continuaciónTo find more ways to test and debug your bot, see the additional resources listed below.

Información adicionalAdditional information

Para obtener información adicional sobre pruebas y depuración, consulte:For additional testing and debugging information see: