Внешние данные (API)

База знаний - это статика: то, что вы загрузили один раз. Внешние API дают Нейро доступ к реальному времени: остатки на складе, статусы заказов, актуальные цены, расписание. Когда обратиться к вашей системе, Нейро решает по ходу разговора и отвечает живыми данными.

Функция доступна на тарифе «Компания».

Как это работает

Обёртка на вашей стороне - небольшой HTTP-эндпоинт (на 1С, PHP, Node - любой стек), который принимает наш JSON-запрос и отвечает JSON из вашей системы.
Опишите тулзы в кабинете - без кода: имя, когда вызывать и какие параметры. Это делается в разделе «Нейро» → «Обзор» → блок «Что знает Нейро», колонка «Умеет»: кнопка «Подключить систему», а у подключённой системы - «Открыть настройки системы».
Нейро вызывает их по ходу разговора - в диалоге с клиентом Нейро понимает, когда дёрнуть вашу систему, и отвечает актуальными данными.

Подключение и тулзы

Подключение - адрес вашей обёртки и способ авторизации (Bearer-токен, ключ в заголовке, Basic, HMAC или без авторизации).
Тулза - конкретное действие внутри подключения. Самое важное поле тулзы - «Когда вызывать»: простыми словами опишите, в каких вопросах клиента Нейро должен её дёрнуть. Чем точнее описание, тем правильнее вызовы.

Доступность и подтверждение

Для каждой тулзы настраивается, кому она доступна:

Клиенту в чате - Нейро использует её в автоответах;
Оператору - в подсказках и копайлоте.

Для действий записи (создать заявку, отменить заказ) включите «Требовать подтверждение» - Нейро спросит подтверждение перед вызовом.

Тулзу можно временно выключить, не удаляя. Прямо в кабинете есть проверка вызова - можно дёрнуть обёртку с примером значений, не запуская чат.

Кто и что может проверить:

Проверка доступна с правом «Знания: правка». Оператор и наблюдатель проверку не запускают.
Тулзу, которая меняет данные (запрос не GET), проверяет только сотрудник с правом «Знания: удаление» - из встроенных ролей это владелец и администратор. Остальные увидят: «Проверить действие, которое меняет данные, может только администратор.»
Тулзу с «Требовать подтверждение» из проверки не вызвать никому: «Это действие меняет данные в системе - проверить его отсюда нельзя.»
В результате проверки личные данные из ответа вашей системы - телефоны, почта, имена - заменены пометками вроде [телефон].

Сбой системы

Если ваша система начала отвечать ошибками, это видно сразу в двух местах:

в колонке «Умеет» у системы горит красная точка и пометка «сбой»;
в карточке «Следующий шаг» или в блоке «Требует вас» появляется дело
«Сбой системы: {название}» - оно идёт первым, раньше остальных дел.
В списке дел строка выглядит так: «Сбой системы: Статус доставки · 31 ошибка
за сутки».

Дело появляется, когда за последние сутки было не меньше 20 вызовов и
не меньше 10% из них закончились ошибкой. При малом потоке (несколько
ошибок на десяток вызовов) дела нет - только красная точка в «Умеет», чтобы
случайные сбои не отвлекали.

О сбое придёт и уведомление «Нейро: сбой системы», а бейдж
«Нейро» в меню станет красным.

В карточке сбоя:

«Ошибок 31 из 58 за сутки» и число запросов за неделю;
«Последняя ошибка» - когда, какое действие и что случилось: «нет ответа
сервера за 10 с», «сервис недоступен», «сервис ответил 500», «адрес не
разрешён» или «ошибка в ответе системы». Ответ вашей системы и данные запроса
в кабинет не попадают - только вид ошибки;
действия системы и можно ли их проверить отсюда: «можно проверить»,
«нужно: номер заказа» (действию нужны данные из разговора с клиентом) или
«нужны данные запроса»;
кнопки «Проверить подключение» и «Открыть настройки системы».

Проверить подключение

«Проверить подключение» делает один настоящий запрос к вашей системе -
через действие, которое только читает данные (запрос GET) и не требует
аргументов. Действие выбирается само: сначала то, что недавно отвечало без
ошибок. Действия, которые меняют данные или требуют подтверждения, проверка не
вызывает никогда.

Нажмите «Проверить подключение» - кнопка покажет «Проверяем…».
Результат появится в карточке:
- «Подключение работает» и строка вида: «Пункты выдачи» - ответ за 0,4 с,
  12 записей. Если ошибки шли у другого действия, ниже будет пояснение:
  «Ошибки шли у «Статус заказа»: проверить его без данных запроса нельзя.
  Последняя ошибка и настройки - в системе.»;
- «Подключение не работает: …» с видом ошибки - значит, система всё ещё
  недоступна, передайте это вашему разработчику.
После проверки в карточке остаётся строка «Проверено в 14:20: работает».

Проверять одну систему можно не чаще раза в 30 секунд - иначе «Проверить снова
можно через 30 секунд.». Если кнопки нет, у системы нет действия, которое можно
проверить без данных клиента: откройте «Открыть настройки системы» и
посмотрите последнюю ошибку там.

Проверка не попадает в журнал вызовов и в счётчик ошибок: дело «Сбой системы»
уходит само, когда система снова отвечает без ошибок, а не после удачной
проверки.

Систему ведёт команда Dialogi

Некоторые системы подключает и обслуживает наша команда - например, мост к
программе лояльности. При их сбое дела и уведомления у вас не будет, а в
колонке «Умеет» у системы будет пометка «сбой» и строка «Систему ведёт команда
Dialogi: о сбое уже знаем.» - команда получает тревогу сама и чинит.

Кто видит и проверяет

Дело «Сбой системы» видят все, у кого есть раздел «Нейро» (право
«Знания: просмотр»). Бейдж и уведомление о сбое получают только те, у
кого есть право «Знания: правка».
«Проверить подключение» - с правом «Знания: правка»: из встроенных
ролей это владелец, администратор и менеджер. Без права кнопок нет, вместо
них - «Проверять подключение могут администраторы и менеджеры проекта.»

Что можно подключить

Складские остатки, каталог товаров, статусы заказов, промокоды и акции - и любые другие данные из ваших систем.

Что дальше

Источники знаний - статические знания о бизнесе.
Темы Нейро (Wiki)