Вебхуки¶

Вебхуки позволяют взаимодействовать с Rasa через HTTP-запросы.

Содержание инструкции:

Перезапуск Rasa
Загрузить файл
Удалить файл
Развернуть проект
Сообщить о сбое
Посттренинг

Перезапуск Rasa¶

Принимает HTTP POST запросы для перезапуска сервера Rasa. Вызывается при редактировании конечных точек или учетных данных. Полезно для применения изменений в настройках или конфигурации без полного перезапуска сервера. Ответ не требует JSON, важен только HTTP статус.

{
    "projectId": string,
    "environment" : string,
}

Загрузить файл¶

Принимает HTTP POST запросы для загрузки файлов в WiseBot. Поддерживаемые типы файлов: аудио, изображения, модели NLU и диалоги из других источников.

Request

{
    "projectId": string,
    "data": string, // image encoded in base64
    "mimeType": string,
    "language": string,
    "responseId": string // template name followed by unix timestamp, e.g. utter_get_started_1588107073256
}

Response

{
    "uri": string // the publicly accessible URI for the asset just received
}

Удалить файл¶

Принимает HTTP DELETE запросы для удаления файлов из WiseBot. Укажите путь к файлу в теле запроса.

Request

{
    "projectId": string,
    "uri": string // the publicly accessible URI for the asset to be deleted
}

Response

В случае успешного удаления ожидается ответ 204. Если же ресурс не был найден, то будет возвращён ответ 404.

Развернуть проект¶

Принимает HTTP POST запросы для развертывания WiseBot. Все внесенные изменения будут развернуты на сервере Rasa.

Request

{
    "projectId" : string, 
    "namespace" : string, 
    "environment" : string,
    "gitString" : string, 
}

Response

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

{
    "message" : string
}

Если код состояния не равен 200, отобразится подробное описание свойства в уведомлении.

{
    "detail" : string
}

Сообщить о сбое¶

Автоматически отправляет информацию о сбоях браузера, вызванных Wisebot.

Request

{
    "version": string,
    "path": string,
    "error": string,
    "trace": string
}

Response

Ожидается успешный HTTP код ответа.

Посттренинг¶

Принимает HTTP POST запросы для запуска процесса обучения модели NLU и диалогов в WiseBot. Обучение происходит на основе новых данных или изменений.

Каждый вебхук обеспечивает взаимодействие с WiseBot через стандартные HTTP методы (POST и DELETE), обеспечивая гибкость в управлении файлами, развертывании проекта, отчетах об ошибках и обучении модели.

Request

{
    "projectId" : string,
    "namespace" : string,
    "model" : string, // base64 conversion of the trained model
    "mimeType" string,
}

Expected response

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