# Общий гайд по Платформе
## Платформа Chatme.ai
Платформа Chatme.ai — это система для создания, эксплуатации и управления чат-ботами. С помощью Платформы Chatme.ai вы сможете:
* создавать чат-ботов;
* реализовывать в них разнообразные сценарии с помощью широкого функционала БотБилдера:
* сценарии с распознаванием естественного языка (на технологиях NLU, RAG, LLM, ASR, TTS);
* линейные сценарии (опрос, интервью, сбор данных);
* сценарии, автоматизирующие процессы (перевод на различные группы операторов по определенному условию);
* благодаря многопользовательскому режиму, работать над ними совместно с коллегами;
* выводить чат-ботов в различные каналы (мессенджеры, социальные сети, виджет на сайте и т.д.);
* делать интеграции с различными внешними системами (например, CRM-системы, таск-менеджеры);
* просматривать историю общения чат-бота с собеседниками;
* выгружать различные статистические отчеты об общении чат-ботов;
* улучшать своих чат-ботов на основе аналитики.
## Регистрация и пользователи
### Регистрация аккаунта
Первым делом необходимо завести аккаунт на Платформе. Для того чтобы зарегистрироваться или войти в уже существующий аккаунт, воспользуйтесь статьей [Регистрация и авторизация на Платформе.](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/akkaunt-polzovatelya-na-platforme/registraciya-i-avtorizaciya-na-platforme)
### Настройки аккаунта и компании
После регистрации будет создан Аккаунт пользователя и его Компания — пространство для работы над Агентами.
> Агент — это объект Платформы, конфигурация будущего Бота, в то время как Бот — это выведенный в какой-либо Конечный канал Агент, с кем непосредственно общается Собеседник.
Чтобы ознакомиться с настройками Аккаунта пользователя и Компании, узнать, какая информация о них доступна для редактирования, перейдите к статье [Аккаунт и Компания пользователя.](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/akkaunt-polzovatelya-na-platforme/akkaunt-i-kompaniya-polzovatelya)
### Многопользовательский режим и роли пользователей
На Платформе реализован многопользовательский режим, при котором пользователь может приглашать в Компанию других пользователей на определенные роли с разными уровнями доступа к определенным функциям для совместной работы над Ботами.
О том, как приглашать пользователей в Компанию, вы также узнаете из статьи [Аккаунт и Компания пользователя](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/akkaunt-polzovatelya-na-platforme/akkaunt-i-kompaniya-polzovatelya).
Чтобы узнать, какие существуют роли пользователей и чем они отличаются, ознакомьтесь со статьей [Роли пользователей и управление пользователями Компании](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/akkaunt-polzovatelya-na-platforme/roli-polzovatelei-i-upravlenie-polzovatelyami-kompanii).
### Подписка и тарифы
Использование Платформы может осуществляться как на платной, так и бесплатной основе. Чтобы ознакомиться с условиями тарифов и узнать, как переключаться между ними, изучите статью [Подписка и оплата](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/akkaunt-polzovatelya-na-platforme/podpiska-i-oplata).
## Агенты и Сценарии
### Вкладки Платформы (верхняя панель)
Теперь ознакомимся с вкладками Платформы. Вы видите их на верхней панели:
Узнать о них подробнее можно из статьи [Обзор вкладок Платформы](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/obzor-vkladok-platformy).
### Создание агентов
Создание Агентов осуществляется на вкладке Папка. Подробнее о вкладке: [Вкладка Папок](https://chatme-ai-4.gitbook.io/docs/kak-nachat-rabotu-s-platformoi/obzor-vkladok-platformy/vkladka-papok).
О том, как создать Агента: [Создание, редактирование и удаление Агента](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/sozdanie-redaktirovanie-i-udalenie-agenta).
О дополнительных операциях с Агентами — экспорте, импорте, клонировании и замене Сценария агента: [Экспорт, импорт, клонирование и замена Сценария Агента](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/eksport-import-klonirovanie-i-zamena-scenariya-agenta).
Пошаговая инструкция по созданию кнопочного бота: [Создание простого бота-опросника](https://chatme-ai-4.gitbook.io/docs/poshagovye-instrukcii-po-sozdaniyu-shablonnykh-botov/sozdanie-prostogo-bota-oprosnika).
Пошаговая инструкция по созданию бота с интеграцией с внешней системой: [Создание бота с интеграцией с сервисом погоды](https://chatme-ai-4.gitbook.io/docs/poshagovye-instrukcii-po-sozdaniyu-shablonnykh-botov/sozdanie-bota-s-integraciei-s-servisom-pogody).
Пошаговая инструкция по созданию бота, распознающего естественную речь: [Создание бота с распознаванием речи](https://chatme-ai-4.gitbook.io/docs/poshagovye-instrukcii-po-sozdaniyu-shablonnykh-botov/sozdanie-bota-s-raspoznavaniem-rechi).
### Ботбилдер
Создание Сценария агента Агента происходит в конструкторе — БотБилдере. Узнать о том, как перейти в БотБилдер и из чего он состоит, вы можете в статье [Обзор конструктора сценария Агента и вкладок](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/obzor-konstruktora-scenariya-agenta-i-vkladok).
### Слоты
После того, как вы перешли в БотБилдер и ознакомились с его вкладками, необходимо узнать о Слотах, из которых строится Сценарий Агента — это элементы, отвечающие за действия Агента. О том, какие существуют Слоты, и о их создании вы узнаете в статье [Создание и типы Слотов и Подслотов](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/sozdanie-i-tipy-slotov-i-podslotov). О том, как перемещать и копировать Слоты и Ветки сценария читайте в статье [Перемещение и копирование Слотов и Веток Сценария](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/peremeshenie-i-kopirovanie-slotov-i-vetok-scenariya).
О том, как облегчить себе навигацию в Дереве сценария и проще в нем ориентироваться с помощью сворачивания Веток сценария и окрашивания Слотов: [Навигация по Дереву Сценария](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/navigaciya-po-derevu-scenariya).
Существуют статьи о каждом Слоте: об их настройках и особенностях работы. Все они содержатся в разделе [Как создавать и настраивать Слоты](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/kak-sozdavat-i-nastraivat-sloty).
### Распознавание Агентами естественного языка
Агенты могут распознавать сообщения Собеседника, написанные на естественном языке, причем Агент может распознать как целое намерение в Реплике Собеседника ([Распознавание естественного языка](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/raspoznavanie-agentom-estestvennogo-yazyka/raspoznavanie-estestvennogo-yazyka)), так и отдельную сущность ([Распознавание сущностей | Словари](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/raspoznavanie-agentom-estestvennogo-yazyka/raspoznavanie-sushnostei-or-slovari)).
### Контекстные переменные Чата
На Платформе существуют Контекстные переменные — это переменные, хранящиеся в Чате и доступные для чтения и изменения системой по заложенной в Сценарии агента или Платформой логике.
Контекстные переменные могут быть частью текста, отправляемого Ботом (например, в Слотах Text, Attachment), или передаваться во внешнюю систему через External Request. Весь набор Контекстных переменных называют Контекстом Чата.
О том, какие бывают Контекстные переменные и как их использовать — раздел [Как использовать Контекстные переменные в Агенте](https://chatme-ai-4.gitbook.io/docs/sostoyanie-obsheniya-tochka-v-scenarii-agenta-v-kotoroi-agent-nakhoditsya-v-tekushii-moment.-sostoya/kontekstnye-peremennye-chata).
### Обучение Агента
Чтобы с Агентом можно было пообщаться, после того как его Сценарий агента полностью собран, его необходимо обучить. Для успешного Обучения Агент должен соответствовать требованиям, описанным в статье [Требования для успешного обучения Агента](https://chatme-ai-4.gitbook.io/docs/kak-obuchit-i-protestirovat-agenta/trebovaniya-dlya-uspeshnogo-obucheniya-agenta). С помощью этой статьи вы также сможете исправить ошибки, если они будут выявлены в процессе Обучения Агента.
### Тестирование Агента
О том, как качественно протестировать Сценарий Агента и улучшить в нем распознавание естественного языка, вы узнаете из статей [Тестирование сценария Агента](https://chatme-ai-4.gitbook.io/docs/kak-obuchit-i-protestirovat-agenta/testirovanie-scenariya-agenta) и [Тестирование и улучшение распознавания Агента: подбор Confidence threshold](https://chatme-ai-4.gitbook.io/docs/kak-obuchit-i-protestirovat-agenta/testirovanie-i-uluchshenie-raspoznavaniya-agenta-podbor-confidence-threshold).
Чтобы улучшить распознавание естественного языка в Агенте, можно добавить новые Обучающие фразы в его Обучающую выборку прямо на вкладке Аналитики: [Дообучение Агента из страницы аналитики](https://chatme-ai-4.gitbook.io/docs/kak-obuchit-i-protestirovat-agenta/doobuchenie-agenta-iz-stranicy-analitiki).
## Каналы и интеграции
### Вывод Агента в Каналы
После того, как Сценарий Агента протестирован, его можно выводить в Конечный каналы для общения с Собеседниками.
Агента можно вывести как напрямую в мессенджеры, так и в омниканальные платформы, которые предоставляют возможность переключения диалога с Агента на оператора. Доступны следующие каналы для вывода Агента:
| Name |
| ---------------------------- |
| Telegram |
| 360dialog (Whatsapp) |
| 360dialog (cloud) |
| Jivo |
| Webim (External Bot API 1.0) |
| Webim (External Bot API 2.0) |
| Edna Chat Center |
| Livetex |
| Дебаг виджет |
| Bitrix24 |
| Chat2Desk |
| Chat API |
| VK |
| Microsoft Teams |
| Edna Pulse |
| GMS (In progress) |
| Viber |
| VK Teams |
| Line messenger |
| Widget |
| Omnidesk |
О том, как вывести Агента в канал: раздел [Как вывести Агента в Конечные каналы](https://chatme-ai-4.gitbook.io/docs/kak-vyvesti-agenta-v-konechnye-kanaly).
### Chat API
Агента также можно вывести и в те Конечные каналы, для которых нет встроенного в Платформе Коннектора. Для этого существует универсальный коннектор Chat API с публичным API. Подробнее: [Chat API](https://chatme-ai-4.gitbook.io/docs/kak-vyvesti-agenta-v-konechnye-kanaly/universalnyi-konnektor-chat-api).
### Кастомные интеграции c внешними системами
На Платформе есть возможность совершать интеграции Агента с внешними системами, которые предоставляют открытый API, например, с CRM или другими сервисами. Это осуществляется с помощью Внешнего запроса. Подробнее: [Запросы во внешние системы | Слот External Request](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/kak-sozdavat-i-nastraivat-sloty/zaprosy-vo-vneshnie-sistemy-or-slot-external-request).
Также есть возможность отправить в Агента запрос из внешней системы, таким образом Агент может писать первым в Чат Собеседнику, например, чтобы послать уведомление о статусе его заказа. Это осуществляется с помощью Слота Incoming Request. Подробнее: [Рассылки и уведомления | Слот Incoming Request](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/kak-sozdavat-i-nastraivat-sloty/rassylki-i-uvedomleniya-or-slot-incoming-request).
### Рассылки в WhatsApp
На Платформе реализована функция, позволяющая делать рассылки из Агента в WhatsApp. Для этого существует Слот Notification, предназначенный для отправки рассылочных сообщений в том случае, когда Чат с Собеседником еще не создан или Чат создан, но Агенту нельзя писать в Чат первым после определенного таймаута (ограничение некоторых каналов). Подробнее: [Рассылки в WhatsApp| Слот Notification](https://chatme-ai-4.gitbook.io/docs/proekty-na-platforme/proekt-i-ego-soderzhimoe/agenty-na-platforme/kak-postroit-scenarii-agenta/kak-sozdavat-i-nastraivat-sloty/rassylki-v-whatsapp-or-slot-notification).
На данный момент рассылки в WhatsApp через Слот Notification доступны в следующих каналах:
* 360dialog
* Edna Platform
* Edna Chat Center
* Chat2Desk
## Работа ботов, общение
### Лимиты
На Платформе установлены лимиты на определенные события. Узнать о них можно из статьи [Лимиты](https://chatme-ai-4.gitbook.io/docs/ekspluataciya-agenta/limity).
### Аналитика общения
На Платформе есть возможность просмотреть аналитику (Вкладка Аналитики и фильтры) и выгрузить статистику общения Агентов с Собеседниками:
* Информация о том, сколько всего было попаданий в те или иные Слоты за выбранный период и общая статистика по Агенту: [Выгрузка отчета по использованию Агента](https://chatme-ai-4.gitbook.io/docs/kak-proveryat-analitiku-obsheniya-agenta/vygruzka-otcheta-po-ispolzovaniyu-agenta)
* История общения Агентов с Собеседниками: [Выгрузка истории диалогов](https://chatme-ai-4.gitbook.io/docs/kak-proveryat-analitiku-obsheniya-agenta/vygruzka-istorii-dialogov)
* Контекстные переменные всех Чатов: [Выгрузка контекстных переменных чатов](https://chatme-ai-4.gitbook.io/docs/kak-proveryat-analitiku-obsheniya-agenta/vygruzka-kontekstnykh-peremennykh-chatov)
* Информация о количестве выполнений Агентом того или иного Слота: [Выгрузка статистики прохождения по Слотам](https://chatme-ai-4.gitbook.io/docs/kak-proveryat-analitiku-obsheniya-agenta/vygruzka-statistiki-prokhozhdeniya-po-slotam)
* Информация по Слотам, на которых окончились Диалоги в определенном Агенте: [Выгрузка отчета по слотам завершения диалога](https://chatme-ai-4.gitbook.io/docs/kak-proveryat-analitiku-obsheniya-agenta/vygruzka-otcheta-po-slotam-zaversheniya-dialoga)
