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

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

В Платформе реализованы функции экспорта и импорта конфигурационного файла Агента. С помощью этих функций вы можете сохранить файл Агента на компьютер, переслать файл своим коллегам и загружать файлы Агентов в Платформу.

1. Для экспорта нужно перейти в раздел Dashboard, открыть Проект, найти нужного Агента и выбрать опцию Export из выпадающего меню.
2. Агент будет сохранен в формате .cfg. Содержимое экспортированного файла:

   1. Сценарий Агента;

   2. Используемые в Сценарии Интенты;

   3. Используемые в сценарии Внешние запросы;

   4. Значение опции Продолжать общение;

   5. Значение Таймаута неактивности в секундах – это время неактивности Собеседника, после которого Диалог с Агентом закрывается;

   6. Группировку Слотов (свернутые ветки Сценария).

3. Теперь данного Агента можно импортировать в любой Проект. Про создание Проектов подробнее читайте в статье Проекты

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

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

1. Для того чтобы импортировать Агента в новый Проект, нажмите на кнопку Import agent в свойствах Проекта.
2. В появившемся окне нажмите Browse и выберите нужный файл с расширением .cfg, .json. или .xlsx. Укажите название для этого Агента в новом Проекте и нажмите Import.
3. Агент появится в списке Агентов данного Проекта.

4. Импортированный Агент не содержит Каналов Агента и не обучен.

5. При попытке загрузить файл с неподдерживаемым расширением или невалидной структурой появится ошибка с текстом Couldn’t import agent.

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

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

Файл данного формата является результатом экспорта Агента из Платформы.

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

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

• .cfg

• .json

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

1. При импорте Агента из конфигурационного файла импортируются:

   1. Дерево сценария Агента, включая группировку Слотов (свернутые Ветки сценария).

   2. Ресурсы компании, используемые в Сценарии (Внешние запросы, Интенты, Словари), согласно правилам импорта.

   3. значение настройки Продолжать общение.

   4. значение Таймаут неактивности.

      1. В конфигурационном файле значение Таймаут неактивности указано в секундах. После импорта значение отображается на Карточка агента в часах и минутах.
      2. Если значение Таймаута неактивности в конфигурационном файле было изменено вручную на значение, которое при переводе в минуты не дает целого числа, то при импорте произойдет округление до целого числа минут в большую сторону.

      3. Если значение Таймаута неактивности в конфигурационном файле было изменено вручную на отрицательное число, 0 или значение, не являющееся числом, то при импорте значение Таймаута неактивности будет приведено к 15 минутам.

   5. В случае наличия Слота Incoming Request в Сценарии будет сгенерирован новый адрес Вебхука слота Incoming Request для этого Слота, который будет работать только после обучения Агента.

   6. В случае наличия Слота Notification в Сценарий будет сгенерирован новый адрес вебхука для этого Слота, который будет работать только после обучения Агента.

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

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

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

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

• .xlsx

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

Загружаемый файл Excel должен иметь следующие характеристики:

1. Структура файла:

   1. 1-я строка:

      1. значение ячейки А1 — текст language;

      2. значение ячейки B1 — код языка для NLU-модели Агента (язык, который будет распознаваться слотом NLU). Код может быть прописан в любом регистре. Подробнее: Доступные для распознавания языки и их коды.

   2. 2-я строка обязательно пустая. В ином случае произойдет ошибка импорта: будут выведены сообщения об ошибке и Агент не будет импортирован в Платформу.
   3. Начиная с 3-ей строки располагается таблица с данными для создания FAQ-Бота: Обучающая выборка для Интентов, которые будут включены Сценарий Агента, названия Интентов и ответы на них:

      1. Столбец A:

         1. название: intent в ячейке А3;

         2. содержимое: названия Интентов, которые будут включены в Сценарий Агента.

      2. Столбец B:

         1. название: examples в ячейке B3;

         2. содержимое: Обучающая выборка Интентов. Обучающие фразы прописываются начиная с ячейки напротив названия Интента и ниже.
      3. Столбец C:

         1. название: message в ячейке C3;

         2. содержимое: ответы Агента на Интенты. Содержит любые текстовые данные, включая ссылки на файлы, которые служат контентом для ответов Агента, также поддерживается рандомизация ответов Агента (подробнее: Логика создания ветки подслота Интент).
      4. Столбцы D и E:

         1. опциональные поля. Если Агент должен давать ответ в нескольких сообщениях, а не в одном, то можно указать от 1 до 3х последовательных сообщений.

         2. заполняются аналогично столбцу C.
      5. Для указания ответа Агента на fallback (в случае, если не распознан ни один из Интентов см. Распознавание намерений | Слот NLU и под-слоты Intent и Fallback):

         1. в столбце intent прописывается значение ячейки fallback;

         2. ячейки в столбце examples остаются пустыми. В случае, если ячейки заполнены, при импорте файла их значения игнорируются;

         3. в столбце/столбцах message указывается ответ Агента на fallback.

Доступные для распознавания языки и их коды

Язык	Код языка для создания Агента через Excel
Русский	ru
Английский	en
Португальский	pt
Украинский	uk
Испанский	es

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

Общий принцип построения Сценария

При импорте файла в Платформу создается Агент со следующей структурой Сценария:

1. Слот Start;

2. Затем Слот NLU с Подслотами intent для каждого Интента из загружаемого файла и Подслотом fallback;

3. После Подслотов intent и fallback следуют Слоты с сообщениями/ответами Агента, если они указаны в загружаемом файле в колонке message. В ином случае Слоты с сообщениями/ответами Агента не будут созданы;

4. На конце каждой Ветка сценария стоит Слот Wait For Reaction.

Логика создания ветки подслота intent

Для каждого Интента из загружаемого файла:

1. Создается Интент в Ресурсах компании с прописанной в файле Обучающей выборки;

   1. Интенты создаются с соответствии с правилами импорта Интентов.

   2. Интенты, содержащие менее 2х строк в Обучающая выборка, при импорте будут игнорироваться: они не появятся в Ресурсы компании и для них не будут созданы соответствующие Подслоты с Ветка сценария.

2. В Подслоте intent устанавливается данный Интент;

3. Создаются от 1 до 3х Слотов Text или Attachment с сообщениями/ответами Агента, следующих за данным Подслотом intent. Контент данных Слотов Text или Attachment соответствует контенту столбцов message (C,D,E колонки) для данного Интента:

   1. если ячейки в столбцах message пустые, то Слоты Text или Attachment не создаются после Подслота intent;

   2. если напротив одного Интента в файле заполнено несколько ячеек в одном столбце message, то создается Слот Text и содержимое каждой ячейки импортируется в качестве одного из рандомных ответов Агента (подробнее про рандомизацию ответов: Text).

      1. в Слоте по умолчанию выключен Markdown, опция Точка сохранения выключена.

   3. ячейки в столбцах message, содержащие текст, соответствующий шаблону <ссылка на файл> + текст или текст + <ссылка на файл>, будут импортированы в виде Слотов Attachment, поля которых заполнены следующим образом:

      1. поле Name — заполняется первыми 40 символами текста из ячейки, сопровождающим ссылку

      2. поле Source — заполняется ссылкой из ячейки

      3. поле Caption — заполняется текстом из ячейки, сопровождающим ссылку

      4. поле Primary type — тип файла устанавливается согласно расширению в ссылке:

         1. Image — jpg, jpeg, png, gif, bmp

         2. Audio — mp3, wav, wma, aac, ogg

         3. Video — mp4, mov, avi, wmv, flv, mkv

      5. Примеры:

         1. 
         2. 
         3. 
         4. 
      6. в Слоте по умолчанию выключен Markdown, опция Точка сохранения выключена.

   4. остальные ячейки в столбцах message импортируются в качестве Слотов Text.

Логика создания ветки подслота fallback

Создается Подслот fallback;

1. Если файл содержит ответ на fallback, за Подслотом fallback создаются Слоты Text или Attachment в соответствии с порядком от столбца С к столбцу Е в таблице;
2. Если файл содержит несколько строк fallbackа, то при импорте файла текст для ответа переносится из первого из них, остальные строки fallback игнорируются;
3. Если в файле нет fallback или не заполнены соответствующие ему ячейки в столбце message, то при импорте создается Подслот fallback со следующим за ним Слотом Wait For Reaction.

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

1. В импортированном Агенте опция Продолжать общение выключена.

2. При импорте устанавливается стандартное значение Таймаута неактивности — 15 минут.

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

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

1. Агент может быть клонирован по нажатию кнопки Duplicate в меню настроек Агента.
2. По нажатию кнопки Duplicate открывается диалоговое окно, в котором необходимо подтвердить действие.

   1. По нажатию кнопки YES, I’M SURE произойдет клонирование Агента;

   2. по нажатию кнопки NO, IT’S A MISTAKE произойдет закрытие диалогового окна.

3. После клонирования создается новый Агент с именем COPY-[название клонируемого агента] и со своим уникальным идентификатором agent_id.
4. При клонировании Агента клонируются Ресурсы компании, используемые в Сценарии (внешние запросы, интенты), согласно правилам импорта.

5. При клонировании Агента сохраняется значение опции "Продолжать общение".

6. При клонировании Агента сохраняется значение Таймаута неактивности.

7. В случае наличия слота Incoming Request в Сценарии будет сгенерирован новый адрес вебхука для этого слота.

8. Клонированный Агент не содержит Каналов Агента кроме Debug-канала и не обучен.

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

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

• При импорте из конфигурационного файла устанавливаются значения в соответствии с указанными в файле;

• При импорте из файла Excel устанавливается устанавливается стандартное значение Таймаут неактивности — 15 минут, опция Продолжать общение выключена.

Функция замены Сценария Агента может использоваться, к примеру, для внесения правок в Агента, который уже общается с Собеседниками в Конечных каналах.

1. Производится экспорт конфигурационного файла Агента;

2. Импорт его в Платформу;

3. Внесение правок в импортированного Агента;

4. В случае успешного тестирования, производится экспорт импортированного Агента и замена рабочего Агента этим конфигурационным файлом.

Таким образом сохраняются уже существующие Чаты Агента с Собеседниками и процесс тестирования внесенных правок не нарушает процесс общения Агента с этими Собеседниками.

Замена Сценария Агента осуществляется следующим образом:

1. Нажмите кнопку Replace config в меню настроек Агента.
2. В появившемся окне нажмите Browse и выберите нужный файл с расширением .cfg или .json. Нажмите Replace.
3. Чтобы Агент заработал, обучите его, нажав кнопку Train в Ботбилдере или на карточке Агента.