Перейти к основному содержимому

Prompter API

Prompter API позволяет подключить суфлеров в Aimychat или интегрировать их в сторонний сервис.

подсказка
Суфлер — бот, который подключается к диалогу клиента и оператора. Он не общается с клиентом напрямую, а подсказывает оператору ответы на вопросы.

Чтобы использовать суфлеров в Aimychat:

  1. Добавьте в сценарий метод $prompter.pushReply
  2. Подключите канал Prompter API.
  3. Скопируйте вебхук и вставьте его в настройки Aimychat.
подсказка
Чтобы включить Prompter API, свяжитесь со своим аккаунт-менеджером или напишите нам на client@just-ai.com.

Добавление метода $prompter.pushReply

Метод $prompter.pushReply отправляет оператору подходящие варианты ответов на вопрос клиента.

  1. Перейдите в редактор кода в JAICP.

  2. Создайте интенты и добавьте событие match в сценарий или добавьте модули в базу знаний Q&A и подключите ее к сценарию, чтобы суфлеры могли использовать ответы оттуда:

    state: Match
    intentGroup!: /KnowledgeBase
    event!: match
    script:
    $prompter.pushReply();

Подключение Prompter API

Перейдите на панели управления в КаналыВходящиеПодключить канал. Выберите в разделе Суфлеры Prompter API.

Заполните поля:

  • Название — укажите название канала.

  • Ветка — укажите ветку проекта, которую вы хотите развернуть в канал, по умолчанию master. Вы также можете выбрать Git-тег или ввести хеш конкретного коммита.

  • Публикация — автоматически (после каждого сохранения внесенных в проект изменений) или вручную (с помощью кнопки Опубликовать в строке с описанием канала).

    предупреждение
    Публикацию сценария нужно выполнять перед запуском бота. На этом этапе происходит сборка бота, проверка синтаксиса сценариев и скриптов, а также проверка прохождения тестов.

Нажмите Создать. После создания откроется окно редактирования канала и появятся новые поля:

  • Токен — конфигурируется при создании канала.
  • Адрес вебхука — используется для подключения суфлеров в Aimychat. Скопируйте его.

Вебхук для подключения API к Aimychat

Перейдите в Aimychat → раздел Настройки. Во вкладке Суфлеры вы можете добавить суфлера и вставить вебхук Prompter API.

подсказка
О видах суфлеров и их настройке читайте в документации Aimychat.