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

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

Экспорт Агента

В
@Платформа
реализованы функции экспорта и импорта конфигурационного файла
@Агент
а. С помощью этих функций вы можете сохранить файл
@Агент
а на компьютер, переслать файл своим коллегам и загружать файлы
@Агент
ов в
@Платформа
.
Для экспорта
@Агент
а необходимо:
Перейти в раздел Dashboard, открыть
@Проект
, найти нужного
@Агент
а и нажать на кнопку Export в выпадающем меню. ​
image.png
@Агент
будет сохранен в формате .cfg. Содержимое экспортированного файла:
@Сценарий
@Агент
а;
Используемые в
@Сценарий
@Интент
ы;
Используемые в
@Сценарий
@Внешний запрос
ы;
Значение опции
@Продолжать общение
;
Значение
@Таймаут неактивности
в секундах — это время неактивности
@Собеседник
а, после которого
@Диалог
с
@Агент
ом закрывается;
Группировку
@Слот
ов (свернутые
@Ветка сценария
).
Теперь данного
@Агент
а можно импортировать в любой
@Проект
.

Импорт Агента

Процесс импорта файла

Для того чтобы импортировать
@Агент
а в новый
@Проект
, необходимо:
Нажать на кнопку Import agent в свойствах
@Проект
а. ​
image.png
В появившемся окне нажать Browse и выбрать нужный файл с расширением .cfg, .json. или .xlsx. Укажите название для этого
@Агент
а в новом
@Проект
е и нажмите Import. ​
image.png
@Агент
появится в списке
@Агент
ов данного
@Проект
а.
Импортированный
@Агент
не содержит
@Канал Агента
и не обучен.
При попытке загрузить файл с неподдерживаемым расширением или невалидной структурой появится ошибка с текстом Couldn’t import agent. ​
image.png

Импорт из конфигурационного файла Агента

Посредством импорта
@Сценарий
@Агент
а из конфигурационного файла возможно создавать
@Агент
ов с любой структурой, допустимой в
@Платформа
.
Файл данного формата является результатом экспорта
@Агент
а из
@Платформа
.

Допустимые расширения файлов

На данный момент к загрузке доступны конфигурационные файлы следующих расширений:
.cfg
.json

Содержание импортированного Агента

При импорте
@Агент
а из конфигурационного файла импортируются:
@Дерево сценария
@Агент
а, включая группировку группировку
@Слот
ов (свернутые
@Ветка сценария
);
@Ресурсы компании
, используемые в
@Сценарий
(
@Интент
ы,
@Внешний запрос
ы и
@Словарь
), согласно правилам импорта (, , );
Значение опции
@Продолжать общение
;
Значение
@Таймаут неактивности
;
В конфигурационном файле значение
@Таймаут неактивности
указано в секундах. После импорта значение отображается на карточке
@Агент
а в часах и минутах. ​
image.png
Если значение
@Таймаут неактивности
в конфигурационном файле было изменено вручную на значение, которое при переводе в минуты не дает целого числа, то при импорте произойдет округление до целого числа минут в большую сторону.
Если значение
@Таймаут неактивности
в конфигурационном файле было изменено вручную на отрицательное число, 0 или значение, не являющееся числом, то при импорте значение
@Таймаут неактивности
будет приведено к 15 минутам.
В случае наличия
@Слот
а
@Incoming Request
в
@Сценарий
будет сгенерирован новый адрес вебхука
@Слот
а
@Incoming Request
для этого
@Слот
а, который будет работать только после
@Обучение
@Агент
а.
В случае наличия
@Слот
а
@Notification
в
@Сценарий
будет сгенерирован новый адрес вебхука для этого
@Слот
а, который будет работать только после
@Обучение
@Агент
а.

Импорт из файла Excel

Посредством импорта
@Сценарий
@Агент
а из файла Excel возможно создавать FAQ-Агентов со структурой “вопрос-ответ”, в т.ч. ответ
@Агент
а может состоять из нескольких подряд идущих сообщений.

Допустимые расширения файлов

На данный момент к загрузке доступны файлы Excel следующих расширений:
.xlsx

Формат файла Excel

Загружаемый файл Excel должен иметь следующие характеристики:
Структура файла: ​
image.png
1-я строка:
значение ячейки А1 — текст language;
значение ячейки B1 — код языка для
@NLU
-модели
@Агент
а (язык, который будет распознаваться
@Слот
ом
@NLU
). Код может быть прописан в любом регистре. Подробнее в таблице ).
2-я строка обязательно пустая. В ином случае произойдет ошибка импорта: будут выведены сообщения об ошибке и
@Агент
не будет импортирован в
@Платформа
. ​
image.png
Начиная с 3-ей строки располагается таблица с данными для создания FAQ-Бота:
@Обучающая выборка
для
@Интент
ов, которые будут включены
@Сценарий
@Агент
а, названия
@Интент
ов и ответы на них:
Столбец A:
название: intent в ячейке А3;
содержимое: названия
@Интент
ов, которые будут включены в
@Сценарий
@Агент
а.
Столбец B:
название: examples в ячейке B3;
содержимое:
@Обучающая выборка
для
@Интент
ов.
@Обучающая фраза
прописываются начиная с ячейки напротив названия
@Интент
а и ниже. ​
image.png
Столбец C:
название: message в ячейке C3;
содержимое: ответы
@Агент
а на
@Интент
ы. Содержит любые текстовые данные, включая ссылки на файлы, которые служат контентом для ответов
@Агент
а, также поддерживается рандомизация ответов
@Агент
а (подробнее: ). ​
image.png
Столбцы D и E:
опциональные поля. Если
@Агент
должен давать ответ в нескольких сообщениях, а не в одном, то можно указать от 1 до 3х последовательных сообщений.
заполняются аналогично столбцу C. ​
image.png
Для указания ответа
@Агент
а на
@fallback
(в случае, если не распознан ни один из
@Интент
ов. Подробнее: ) ​
image.png
в столбце intent прописывается значение ячейки fallback;
ячейки в столбце examples остаются пустыми. В случае, если ячейки заполнены, при импорте файла их значения игнорируются;
в столбце/столбцах message указывается ответ
@Агент
а на
@fallback
.
Доступные для распознавания языки и их коды
Язык
Excel
1
Русский
ru
2
Английский
en
3
Португальский
pt
4
Украинский
uk
5
Испанский
es
6
Вьетнамский
vi
7
Тайский
th
8
Индонезийский
id
9
Малайский
ms
10
Филиппинский
tl
11
Сербский (доступно распознавание текста на латинице и кириллице)
sr
12
Немецкий
de
13
Польский
pl
14
Французский
fr
15
Пакистанский (урду)
ur
16
Киргизский
ky
17
Арабский
ar
There are no rows in this table

Содержание импортированного Агента

Общий принцип построения Сценария
При импорте файла в
@Платформа
создается
@Агент
со следующей структурой
@Сценарий
: ​
image.png
@Слот
@Start
;
Затем
@Слот
@NLU
с
@Подслот
ами
@intent
для каждого
@Интент
а из загружаемого файла и
@Подслот
ом
@fallback
;
После
@Подслот
ов
@intent
и
@fallback
следуют
@Слот
ы с сообщениями/ответами
@Агент
а, если они указаны в загружаемом файле в колонке message. В ином случае
@Слот
ы с сообщениями/ответами
@Агент
а не будут созданы;
На конце каждой
@Ветка сценария
стоит
@Слот
@Wait For Reaction
.
Логика создания ветки подслота intent
Для каждого
@Интент
а из загружаемого файла:
Создается
@Интент
в
@Ресурсы компании
с прописанной в файле
@Обучающая выборка
;
@Интент
ы создаются с соответствии с правилами импорта
@Интент
ов.
@Интент
ы, содержащие менее 2х строк в
@Обучающая выборка
, при импорте будут игнорироваться: они не появятся в
@Ресурсы компании
и для них не будут созданы соответствующие
@Подслот
ы с
@Ветка сценария
.
В
@Подслот
е
@intent
устанавливается данный
@Интент
;
Создаются от 1 до 3х
@Слот
ов
@Text
или
@Attachment
с сообщениями/ответами
@Агент
а, следующих за данным
@Подслот
ом
@intent
. Контент данных
@Слот
ов
@Text
или
@Attachment
соответствует контенту столбцов message (C,D,E колонки) для данного Интента: ​
image.png
image.png
если ячейки в столбцах message пустые, то
@Слот
ы
@Text
или
@Attachment
не создаются после Подслота intent;
если напротив одного
@Интент
а в файле заполнено несколько ячеек в одном столбце message, то создается
@Слот
@Text
и содержимое каждой ячейки импортируется в качестве одного из рандомных ответов
@Агент
а (подробнее про рандомизацию ответов: ). ​
image.png
в
@Слот
е по умолчанию выключен Markdown, опция
@Точка сохранения
выключена.
ячейки в столбцах message, содержащие текст, соответствующий шаблону <ссылка на файл> + текст или текст + <ссылка на файл>, будут импортированы в виде
@Слот
ов
@Attachment
, поля которых заполнены следующим образом: ​
image.png
поле Name — заполняется первыми 40 символами текста из ячейки, сопровождающим ссылку
поле Source — заполняется ссылкой из ячейки
поле Caption — заполняется текстом из ячейки, сопровождающим ссылку
поле Primary type — тип файла устанавливается согласно расширению в ссылке:
Image — jpg, jpeg, png, gif, bmp
Audio — mp3, wav, wma, aac, ogg
Video — mp4, mov, avi, wmv, flv, mkv
Примеры:
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
в
@Слот
е по умолчанию выключен Markdown, опция
@Точка сохранения
выключена.
остальные ячейки в столбцах message импортируются в качестве
@Слот
ов Text.
Логика создания ветки подслота fallback
Создается
@Подслот
@fallback
;
Если файл содержит ответ на
@fallback
, за
@Подслот
ом
@fallback
создаются
@Слот
ы
@Text
или
@Attachment
в соответствии с порядком от столбца С к столбцу Е в таблице; ​
image.png
image.png
Если файл содержит несколько строк
@fallback
а, то при импорте файла текст для ответа переносится из первого из них, остальные строки
@fallback
игнорируются; ​
image.png
image.png
Если в файле нет
@fallback
или не заполнены соответствующие ему ячейки в столбце message, то при импорте создается
@Подслот
@fallback
со следующим за ним
@Слот
ом
@Wait For Reaction
. ​
image.png

Настройки импортированного агента

В импортированном
@Агент
е опция
@Продолжать общение
выключена.
При импорте устанавливается стандартное значение
@Таймаут неактивности
— 15 минут.

Замена Сценария Агента

Функция замены
@Сценарий
@Агент
а замещает
@Сценарий
уже существующего
@Агент
а
@Сценарий
@Агент
а, который содержится в загружаемом конфигурационном файле. При этом также происходит замена значения
@Таймаут неактивности
и значения опции
@Продолжать общение
.
При импорте из конфигурационного файла устанавливаются значения в соответствии с указанными в файле;
При импорте из файла Excel устанавливается стандартное значение
@Таймаут неактивности
— 15 минут, опция
@Продолжать общение
выключена.
Функция замены
@Сценарий
@Агент
а может использоваться, к примеру, для внесения правок в
@Агент
а, который уже общается с
@Собеседник
ами в
@Конечный канал
ах.
Производится экспорт конфигурационного файла
@Агент
а;
Импорт его в
@Платформа
;
Внесение правок в импортированного
@Агент
а;
В случае успешного тестирования, производится экспорт импортированного
@Агент
а и замена рабочего
@Агент
а этим конфигурационным файлом.
Таким образом сохраняются уже существующие
@Чат
ы
@Агент
а с
@Собеседник
ами и процесс тестирования внесенных правок не нарушает процесс общения
@Агент
а с этими
@Собеседник
ами.
Замена
@Сценарий
@Агент
а осуществляется следующим образом:
Нажмите кнопку Replace config в меню настроек
@Агент
а. ​
image.png
В появившемся окне нажмите Browse и выберите нужный файл с расширением .cfg или .json. Нажмите Replace. ​
image.png
Чтобы
@Агент
заработал, обучите его, нажав кнопку Train в
@БотБилдер
е или на карточке
@Агент
а.
В процессе замены из конфигурационного файла будут импортированы:
@Дерево сценария
@Агент
а, включая группировку группировку
@Слот
ов (свернутые
@Ветка сценария
);
@Ресурсы компании
, используемые в
@Сценарий
(
@Интент
ы,
@Внешний запрос
ы и
@Словарь
), согласно правилам импорта (, , );
Значение опции
@Продолжать общение
;
Значение
@Таймаут неактивности
.
При импорте конфигурационного файла с
@Incoming Request
:
Если в
@Сценарий
до замены уже присутствовал
@Слот
@Incoming Request
, адрес вебхука
@Слот
а
@Incoming Request
в новом
@Сценарий
останется таким же, как до замены;
Если в
@Сценарий
до замены не было
@Слот
а
@Incoming Request
, будет сгенерирован новый адрес вебхука
@Слот
а
@Incoming Request
, который начнет работать после
@Обучение
@Агент
а.
При импорте конфигурационного файла с
@Notification
:
Если в
@Сценарий
до замены уже присутствовал
@Слот
@Notification
, адрес вебхука
@Notification
в новом
@Сценарий
останется таким же, как до замены;
Если в
@Сценарий
до замены не было
@Слот
а
@Notification
, будет сгенерирован новый адрес вебхука для этого
@Слот
а, который начнет работать после обучения
@Агент
а.
В процессе замены из файла Excel (по аналогии с созданием
@Агент
а из Excel) будут импортированы:
@Сценарий
@Агент
а;
@Интент
ы
@Агент
а будут импортированы в
@Ресурсы компании
;
В импортированном
@Агент
е опция
@Продолжать общение
выключена;
При импорте устанавливается стандартное значение
@Таймаут неактивности
— 15 минут.
Новый
@Сценарий
начнет работу только после переобучения
@Агент
а.

Клонирование Агента

Для клонирования
@Агент
а необходимо:
Открыть настройки
@Агент
а, кликнув по кнопке на карточке
@Агент
а.
image.png
Нажать кнопку Duplicate. ​
image.png
После нажатия кнопки появится диалоговое окно с предупреждением: ​
image.png
необходимо подтвердить клонирование
@Агент
а, нажав кнопку YES, I’M SURE.
После клонирования создается новый
@Агент
с именем COPY-[название клонируемого агента] и со своим уникальным идентификатором
. ​
image.png
При клонировании
@Агент
а клонируются
@Ресурсы компании
, используемые в
@Сценарий
, согласно правилам импорта (, , ).
При клонировании
@Агент
а сохраняется значение опции
@Продолжать общение
.
При клонировании
@Агент
а сохраняется значение
@Таймаут неактивности
.
В случае наличия
@Слот
а
@Incoming Request
в
@Сценарий
будет сгенерирован новый адрес вебхука для этого
@Слот
а.
Клонированный
@Агент
не содержит
@Канал Агента
и не обучен.
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.