Share
Explore

Пользовательская документация

Формат статей — инструкции: порядок шагов для выполнения определенной задачи с примерами и иллюстрациями.
Названия разделов и подразделов в данном плане обозначены красным цветом, статей — синим.

История изменений

История релизов (15 мин)

Релизы 2023 года

Январь

Февраль

Март

Апрель

Май

Июнь

Июль



НАЧАЛО РАБОТЫ С ПЛАТФОРМОЙ

Обзор возможностей Платформы

Краткий обзор возможностей Платформы

Основные термины

Аккаунт пользователя Платформы

Регистрация и авторизация на Платформе (15 мин)

Регистрация аккаунта на Платформе
Авторизация на Платформе
Восстановление пароля

Аккаунт и Компания пользователя (15 мин)

Основная Компания пользователя
Многопользовательский режим
Редактирование информации аккаунта пользователя
Personal Data
Account
Billing
Выход из аккаунта пользователя

Роли пользователей и управление пользователями Компании (15 мин)

Функционал ролей пользователей Компании
Управление пользователями Компании
Приглашение пользователя в Компанию
Редактирование роли пользователя в Компании
Удаление пользователя из Компании

Подписка и оплата (30 мин)

Тарифные планы
Условия тарифных планов
Переключение Тарифа
Переход на тариф Startup
Переход на тариф Free
Переход на тариф Custom
Периоды обновления
Расчетный период
Работа счетчика трафика и Актуализация подписки
Алерты подписки
Покупка пакета пополнения трафика

User Console – вкладки (15 мин)

Содержание User Console
Вкладка Dashboard (Страница Проектов)
Вкладка Ресурсов Компании
Вкладка Аналитики
Вкладка Пользователи
Панель информации об аккаунте
Панель настроек аккаунта и компании
Страница тарифов и биллинга


СОЗДАНИЕ АГЕНТА НА ПЛАТФОРМЕ

Перед созданием Агента

Определение цели и необходимого функционала

Подготовка данных для Агента

Стиль общения и человечность Агента

Начало работы в Bot Builder

BotBuilder и его вкладки (15 мин)

Переход в BotBuilder
Вкладки BotBuilder

Вкладка сценария Агента — Agent Designer (30 мин)

Переход в Agent Designer
Отображение информации об Агенте
Поиск Слотов
Простой поиск
Расширенный поиск
Результаты поиска и навигация
Обучение и DEBUG

Вкладка интентов — Intents (30 мин)

Вкладка Интентов
Создание, изменение и удаление Интентов
Создание нового Интента в ресурсах Компании
Редактирование Интента
Удаление Интента
Массовые действия с Интентами
Множественный выбор
Снятие выделения с Интентов
Массовое удаление Интентов
Экспорт-импорт интентов при экспорте-импорте Агента

Вкладка ресурсов Компании — Resourses (15 мин)

Содержание вкладки
Поиск по ресурсам

Вкладка словарей — Vocabularies (30 мин)

Формат словаря
Список словарей
Загрузка нового Словаря в ресурсах компании
Экспорт-импорт словарей при экспорте-импорте Агента
Редактирование Словаря
Выгрузка файла Словаря
Удаление Словаря
Массовые действия со Словарями
Множественный выбор
Снятие выделения со Словарей
Массовое удаление Словарей

Вкладка внешних запросов — External Requests (30 мин)

Запросы во внешние системы
Вкладка Внешних запросов
Создание, изменение и удаление Внешних запросов
Создание нового Внешнего запроса в ресурсах Компании
Вкладка Main
Вкладка Headers
Вкладка Query parameters
Вкладка Data
Вкладка Response
Вкладка Test
Редактирование Внешнего запроса
Удаление Внешнего запроса
Клонирование Внешних запросов
Массовые действия с Внешними запросами
Множественный выбор
Снятие выделения с Внешних запросов
Массовое удаление Внешних запросов
Массовое удаление Внешних запросов

Проекты (15 мин)

Общая информация
Создание Проекта
Информация на карточке Проекта
Редактирование Проекта
Удаление Проекта
Поиск по Проектам

Создание, редактирование и удаление Агента (15 мин)

Создание Агента
Доступные для распознавания языки
Информация на Карточке Агента
Редактирование информации об Агенте
Удаление Агента

Экспорт, импорт, клонирование и замена Сценария Агента (30 мин)

Экспорт Агента
Импорт Агента
Процесс импорта файла
Импорт из конфигурационного файла Агента
Допустимые расширения файлов
Содержание импортированного Агента
Импорт из файла Excel
Допустимые расширения файлов
Формат файла Excel
Доступные для распознавания языки и их коды
Содержание импортированного Агента
Общий принцип построения Сценария
Логика создания ветки подслота intent
Логика создания ветки подслота fallback
Настройки импортированного агента
Клонирование Агента
Замена Сценария Агента

Создание Сценария Агента

Создание и типы Слотов и Подслотов (15 мин)

Типы Слотов
Создание Слота

Правила соседства Слотов (15 мин)

Дополнительные операции со Слотами (15 мин)

Удаление Слотов
Удаление отдельного Слота
Удаление ветки Сценария
Смена родителя ветки
Клонирование ветки сценария
Пользовательская подсветка Слотов
Сворачивание веток Сценария

СЛОТЫ

Начало Сценария | Слот Start (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Работа слота
Рассылки и уведомления | Слот Incoming Request (30 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Вебхук слота
Использование синтаксиса в слоте
Работа слота
Входящий запрос
Выполнение входящего запроса
Рассылки в WhatsApp| Слот Notification (45 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Вкладка General
Вкладка Incoming Data
Вкладка Destination
Вкладка Destination для разных каналов
Подслоты Notification fail, Notification no account и Notification success
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Notification Fail
Notification No Account
Notification Success
Запрос на рассылку на вебхук слота Notification
Работа слота
Запуск сценария по таймеру | Слот Timer (30 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Работа слота
Мониторинг
Триггеры запуска таймера
Запуск таймера
Срабатывание таймера
Удаление (остановка) таймера
Режимы работы таймера
Несколько слотов Timer в одном Агенте
Запуск нескольких таймеров в одном Агенте
Срабатывание нескольких таймеров в одном Агенте
Текстовые ответы бота | Слот Text (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Добавление нескольких вариантов текстового сообщения
Работа слота
Ожидание сообщения Собеседника | Слот Wait for reaction (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Работа слота
Сбор данных от собеседника | Слот Slot Filling (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Работа слота
Перевод диалога на оператора | Слот Change Chat Mode (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Работа слота
Переходы к произвольным шагам сценария | Слот Jump (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Работа слота
Создание и сохранение переменных контекста | Слот Memory (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Работа слота
Запросы во внешние системы | Слот External Request (30 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Создание внешнего запроса (ссылка на статью Вкладка внешних запросов — External Requests)
Работа слота
Распознавание сущностей | Слот Synonym (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Создание словарей (ссылка на статью Вкладка словарей — Vocabularies)
Работа слота
Отправка файлов Собеседнику | Слот Attachment (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Работа слота
Слот распознавания языка | Слот Language (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Использование синтаксиса в слоте
Работа слота
Реализация циклов в сценарии | Слот Repeat (30 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Подслоты Repeat Next, Repeat End, Repeat Error, Repeat Limit
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Repeat Next
Repeat End
Repeat Error
Repeat Limit
Использование синтаксиса в слоте
Особенности валидации сценария конструкции Repeat
Работа слота
Распознавание намерений | Слот NLU и под-слоты Intent и Fallback (30 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Подслоты Intent и Fallback
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Intent
Fallback
Работа слота
Процесс распознавания интентов
Пример
Использование кнопок в сообщениях бота | Слот Button Menu и под-слот Button (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Подслоты Button
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Использование синтаксиса в слоте
Работа слота
Проверка формата введенных собеседником данных | Слот Regular Expression и под-слот Result (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Создание регулярного выражения
Подслоты Result
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Работа слота
Разветвление сценария в зависимости от условий | Слот Transition Rule и под-слот Condition (15 мин)
Назначение и общая информация
Создание и настройки слота
Атрибуты слота
Подслоты Condition
Автоматическая генерация подслотов
Добавление подслотов
Удаление подслотов
Атрибуты подслотов
Работа слота

Распознавание агентом естественного языка

Распознавание естественного языка (15 мин)

Языки, распознаваемые слотом NLU
Обучающая выборка Интента
Рекомендации по наполнению выборки
Рекомендации по списку Интентов

Функционал "Топ-5 интентов" (15 мин)

Пример реализации Сценария с использованием функционала

Распознавание сущностей | Словари (15 мин)

Краткое описание и ссылка на статью Распознавание сущностей | Слот Synonym

Синтаксис (30 мин)

Общая информация о синтаксисе
Выражения
Управляющие конструкции
Ошибки при рендеринге Шаблонов

Перевод на оператора (15 мин)

Перевод на оператора в различных омниканальных платформах
Создание ветки перевода на Оператора на Платформе
Перевод на Оператора по запросу Собеседника
Автоматический перевод на Оператора

Опция "Точка сохранения" или Savepoint

Состояние общения. Опция "Продолжать общение"


ОБУЧЕНИЕ И ТЕСТИРОВАНИЕ АГЕНТА

Требования для успешного обучения Агента (15 мин)

Валидация Сценария Агента
Требования к агенту для успешной валидации
Возможные ошибки построения сценария и их обозначение в Дереве
Отсутствие блокирующих слотов в ветках сценария
Не закрытые ветки сценария
Недостаточное количество фраз в обучающей выборке
Недостаточное количество букв во фразе обучающей выборки
Синтаксис в подслоте result слота Regular Expression
Попытка перезаписи системных контекстных переменных, запрещенных для перезаписи
Некорректное написание шаблонов в новом синтаксисе
В слоте Notification использован удаленный канал
Некорректное имя пользовательской переменной
Вложенные циклы слота Repeat

Тестирование сценария Агента

Шаги тестирования Агента (упомянуть про подсветку при тестировании)

Тестирование и улучшение распознавания Агента: подбор Confidence threshold

Шаги подбора Confidence threshold

Дообучение Агента из страницы аналитики (15 мин)

Дообучение Агента по нераспознанным репликам
Дообучение Агента по неверно распознанным репликам


РАЗМЕЩЕНИЕ АГЕНТА В КАНАЛАХ

Принцип вывода Агента в различные каналы

Конфигурация каналов Агента
Заголовки каналов
Сервисные сообщения каналов

Вывод Агента в мессенджеры

Telegram

Подключение Агента
Конфигурация на стороне Telegram
Конфигурация канала Агента в Платформе
Общение
Общение в групповых чатах Telegram
Сервисные сообщения канала
Маппинг канальных переменных
Возможности общения

WhatsApp (360dialog)

Подключение Агента
Конфигурация на стороне 360dialog
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения
Подключение аккаунта WhatsApp Business через 360dialog
Создание и согласование шаблонов рассылочных сообщений

WhatsApp (Edna)

Подключение Агента
Конфигурация на стороне Edna
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения
Создание и согласование шаблонов рассылочных сообщений

Вывод Агента в VK

Подключение Агента
Конфигурация на стороне VK
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения

Microsoft Teams

Подключение Агента
Конфигурация на стороне Microsoft Teams
Подключение бота
Подготовка архива с приложением
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения

Вывод Агента в омниканальные платформы

Jivo

Подключение Агента
Конфигурация на стороне Jivo
Конфигурация канала Агента в Платформе
Общение
Сервисные сообщения канала
Маппинг канальных переменных
Возможности общения

Edna

Подключение Агента
Конфигурация на стороне Edna
Конфигурация канала Агента в Платформе
Общение
Сервисные сообщения канала
Маппинг канальных переменных
Возможности общения

Chat2Desk

Подключение Агента
Конфигурация на стороне Chat2Desk
Конфигурация канала Агента в Платформе
Общение
Сервисные сообщения канала
Маппинг канальных переменных
Возможности общения
Подключение оператора в Chat2Desk

LiveTex

Подключение Агента
Конфигурация на стороне LiveTex
Конфигурация канала Агента в Платформе
Дополнительная конфигурация в случае использования виджета LiveTex
Общение
Маппинг канальных переменных
Возможности общения

Webim

Подключение Агента
Конфигурация на стороне Webim
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения

Асинхронный Webim 2.0

Подключение Агента
Конфигурация на стороне Webim 2.0
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения
Перевод на оператора

Bitrix24

Подключение Агента
Конфигурация на стороне Bitrix24
Конфигурация канала Агента в Платформе
Общение
Маппинг канальных переменных
Возможности общения

Публичный асинхронный API "Omnichannel"

Подключение Агента
Конфигурация канала Агента в Платформе
Запросы из канала/сервера клиента к Агенту на Платформе
Общая структура запроса
Ответы на запросы из канала/сервера клиента к Агенту на Платформе
Ответ Платформы при успешном запросе
Ответ Платформы при неуспешном запросе
Запросы от Платформы в канал/сервер клиента
Базовый URL
Авторизация на стороне клиента
Общая структура запроса
Перевод на оператора
Общение

Поддержка разметки Markdown в Конечных каналах Агента

Использование Markdown в слотах


ЭКСПЛУАТАЦИЯ АГЕНТА

Лимиты

Количество сообщений в секунду
Лимиты

Мониторинг общения

Объекты мониторинга
Письма с алертами


КОНТЕКСТ

Контекстные переменные чата

Типы переменных
Наследование контекста

Системные контекстные переменные

Таблица системных контекстных переменных

Канальные контекстные переменные

Таблица канальных контекстных переменных

Пользовательские контекстные переменные

Создание пользовательских переменных
Требования к названию пользовательской переменной

Сброс значений контекстных переменных

Список методов управления Агентом по API
Получение токена доступа
Удаление контекстных переменных из определенного чата
Request Headers
Request Body
Response
Сброс контекста по ID Агента
Request Headers
Request Body
Response

Использование в диалоге информации о собеседнике из канала




АНАЛИТИКА ОБЩЕНИЯ АГЕНТА

Страница аналитики и фильтры

Информация в Таблице реплик
Описание полей
Применимые фильтры
Chat Data
Dialog Data

Выгрузка истории диалогов

Запрос и получение файла
Содержание файла

Выгрузка контекстных переменных

Запрос и получение файла
Содержание файла

Выгрузка статистики прохождения по Слотам

Запрос и получение файла
Содержание файла

Выгрузка отчета по слотам завершения диалога

Запрос и получение файла
Содержание файла

Выгрузка отчета по использованию Агента

Запрос и получение файла
Содержание файла


РЕАЛИЗАЦИЯ КЕЙСОВ

Примеры ботов

FAQ-бот интернет-магазина
Кнопочный бот-рекрутер
Бот-опрос уходящего сотрудника
Бот-опрос удовлетворенности процедурой приема на работу
Смоллток-бот
Бот-опрос удовлетворенности руководством
Бот логистики
Бот для оформления кредитов и займов
Бриф-бот
Бот, проверяющий подписку пользователя на Telegram-канал

Инструкции

Создаем бота вместе на примере интернет-магазина

Как составить регулярное выражение

Проверка соответствия сообщения нескольким форматам с помощью регулярных выражений и Transition Rule

Проверка условий в слотах Transition Rule и Timer

Распознавание сущностей с помощью

Отправка стикеров в ботах в Telegram

Получение файлов и геолокации от собеседников в Telegram

Отправка данных от бота на электронную почту

Omnidesk

Интеграции с внешними системами через Zapier и Albato

Видеоуроки



ДЛЯ РАЗРАБОТЧИКОВ

Технологический стек платформы

Варианты поставки платформы

Архитектура платформы

API



ПРИЛОЖЕНИЯ

FAQ: часто задаваемые вопросы

Заказ разработки и поддержки бота

Запрос на тестового FAQ-бота

Запрос на FAQ бота с интеграциями и переводом на оператора

Запрос на кластеризацию диалогов

Архитектура платформы

Каналы и коннекторы

Прочее

Best practice диалог-дизайна

Системные требования для работы с User Console

Функциональные, нефункциональные возможности платформы и технологии




















Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.