Поделиться через

Отладка бота с помощью файлов записей разговоров

ПРИМЕНИМО К: пакет SDK версии 4

Одним из ключей успешного тестирования и отладки бота является возможность записывать и проверять набор условий, возникающих при запуске бота. В этой статье описывается создание и использование файла расшифровки бота для предоставления подробного набора взаимодействий пользователей и ответов бота для тестирования и отладки.

Файл расшифровки бота

Файл расшифровки бота — это специализированный JSON-файл, который сохраняет взаимодействие между пользователем и ботом. Файл расшифровки сохраняет не только содержимое сообщения, но и сведения о взаимодействии, такие как идентификатор пользователя, идентификатор канала, тип канала, возможности канала, время взаимодействия и т. д. Затем все эти сведения можно использовать для поиска и устранения проблем при тестировании или отладке бота.

Создание и хранение файла расшифровки бота

В этой статье показано, как создать файлы расшифровки бота с помощью эмулятора Bot Framework. Файлы транскриптов также могут создаваться программным способом; больше информации об этом подходе можно найти в хранилище транскриптов BLOB-объектов. В этой статье мы будем использовать пример кода Bot Framework для бота с многократными подсказками, который запрашивает способ передвижения, имя и возраст пользователя, но любой код, к которому можно получить доступ с помощью эмулятора Microsoft Bot Framework, можно использовать для создания транскрипта.

Чтобы начать этот процесс, убедитесь, что тестируемый код бота выполняется в среде разработки.

  1. Запустите эмулятор.

  2. На вкладке Добро пожаловать выберите Открыть бот.

  3. Введите адрес порта, на который слушает ваш бот, затем /api/messages, например, http://localhost:3978/api/messages.

    Если бот настроен с идентификатором приложения Майкрософт и паролем, введите идентификатор и пароль в диалоговом окне "Открыть бот ". В противном случае эмулятор не сможет подключиться к боту.

  4. Выберите "Подключиться", чтобы подключить эмулятор к боту.

    Снимок экрана: диалоговое окно для подключения к боту из эмулятора.

Протестируйте код, взаимодействуя с ботом в эмуляторе. После ввода всех взаимодействий с пользователем, которые вы хотите сохранить, используйте эмулятор Bot Framework для создания и сохранения файла расшифровки, содержащего эту беседу.

  1. На вкладке Live Chat нажмите кнопку "Сохранить расшифровку".

    Снимок экрана: беседа и кнопка

  2. Выберите расположение и имя файла расшифровки и нажмите кнопку "Сохранить".

    Снимок экрана: диалоговое окно

Все введенные вами ответы взаимодействия пользователей и ботов, введенные для тестирования кода с помощью эмулятора, теперь были сохранены в файл расшифровки, который можно позже перезагрузить, чтобы помочь отладить взаимодействие между пользователем и ботом.

Получение файла расшифровки бота

При открытии файла расшифровки эмулятор загружает сохраненную беседу на новую вкладку.

Чтобы получить файл расшифровки бота, выполните следующее:

  1. Откройте эмулятор.
  2. В меню выберите "Файл" и "Открыть расшифровку".
  3. Используйте файл открытой расшифровки , чтобы выбрать и открыть файл расшифровки, который требуется извлечь.

Снимок экрана: диалоговое окно

Отладка с помощью файла расшифровки

После загрузки файла расшифровки теперь можно выполнить отладку взаимодействий, которые вы захватили между пользователем и ботом.

  1. Выберите любое сообщение пользователя или бота или действие, записанное в области журнала эмулятора.

  2. Эмулятор отобразит информацию о действиях в области инспектора. Сведения о действии — это полезные данные HTTP-запроса для действия.

    Действие сообщения включает в себя следующее:

    • Тип действия
    • Время отправки активности из канала или ее получения
    • Сведения о канале пользователя
    • Сведения об отправителе и получателе действия в from полях и recipient соответственно
    • Сведения, относящиеся к типу действия, например текст сообщения для действия сообщения.

Этот подробный уровень информации позволяет выполнять пошаговые взаимодействия между входными данными пользователя и ответом бота, что полезно для отладки ситуаций, когда бот либо не ответил таким образом, как вы ожидали или не ответили на него вообще. Наличие этих значений и записи шагов, ведущих к сбою взаимодействия, позволяет пошагово проверять код, находить место, где бот не отвечает как предполагалось, и устранять эти проблемы.

Использование файлов транскрибирования вместе с эмулятором Bot Framework — это только один из многих средств, которые можно использовать для тестирования и отладки кода бота и взаимодействия с пользователем.

Дополнительные сведения

Дополнительные сведения о тестировании и отладке см. в следующем разделе: