uHamkorДокументация
Руководство пользователя

Подключение виджета к агенту

Действия функций: показать виджет, вызов API + виджет, сопоставление ответа и проверка в песочнице.

🔌 Подключение виджета к агенту

Виджет не появляется сам — его показывает функция из раздела Конструктор → Функции. После привязки функции к агенту он сам решает, когда её вызвать.


🎬 Три действия

Выбираются в поле Действие формы функции:

  • Вызов API — обычная функция: агент вызывает эндпоинт и отвечает по данным. Виджет не участвует.
  • Показать виджет — без эндпоинта. Агент заполняет данные по схеме виджета, и виджет отрисовывается. Подходит для форм, карточек выбора и показа информации.
  • Вызов API + виджет — сначала вызывается эндпоинт, его ответ становится данными виджета. Подходит для живых данных (статус заказа, детали счёта).

🧩 Порядок настройки

  • 1. Нажмите Добавить функцию.
  • 2. Выберите Действие. При Показать виджет разделы эндпоинта, тела запроса и авторизации исчезают — у такой функции их нет.
  • 3. Выберите виджет в списке Виджет (в нём виджеты этого проекта).
  • 4. Заполните имя, когда использовать и что возвращает — именно по этим текстам агент решает вызвать функцию.
  • 5. Привяжите функцию к агенту.
Выбор действия
Три действия в форме функции: вызов API, показать виджет, вызов API + виджет.

🔀 Сопоставление ответа

При Вызов API + виджет ответ эндпоинта редко совпадает со схемой виджета. Поле Сопоставление ответа задаёт, какой путь попадёт в какое поле:

{ "orders": "data.items" }

Массив data.items из ответа окажется в поле orders виджета.

🧪 Проверка

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

💬 Как это хранится в диалоге

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

📋 В таблице функций

Функция с виджетом показывает имя виджета вместо URL — сразу видно, какая функция что отрисовывает.