Файл загрузки

Система позволяет массово загрузить документы в систему с помощью файла в xlsx формате. Что такое документы см. в разделе Что такое документы базы знаний?

Чтобы импортировать документы, подготовьте файл загрузки.

В файле должны быть созданы как минимум три колонки:

Название

Укажите название документа. Название может использоваться в качестве заголовка при формировании ответа клиенту, в качестве названия рекомендации ответа для операторов службы поддержки. Рекомендуется давать короткие и емкие наименования, так чтобы клиент или оператор могли понять из названия суть ответа.

Ответ

Текст ответа, который будет предоставляться пользователю.

Вопрос1

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

При наличии дополнительных формулировок вопроса стоит добавить новые колонки с названием “Вопрос2”, Вопрос3” и так далее с шагом 1.
См. раздел https://deephack.atlassian.net/wiki/spaces/AKB/pages/3114565666#%D0%A0%D0%B5%D0%BA%D0%BE%D0%BC%D0%B5%D0%BD%D0%B4%D0%B0%D1%86%D0%B8%D0%B8-%D0%BF%D0%BE-%D1%84%D0%BE%D1%80%D0%BC%D1%83%D0%BB%D0%B8%D1%80%D0%BE%D0%B2%D0%BA%D0%B0%D0%BC-%D0%B2%D0%BE%D0%BF%D1%80%D0%BE%D1%81%D0%BE%D0%B2

Импорт документов

Чтобы загрузить документы в базе знаний в меню “Действия“ выберите пункт “Загрузить из XLSX файла“. При нажатии откроется окно импорта. Перетащите файл в область импорта или нажмите на область для открытия браузера файлов. После добавления файла нажмите кнопку “Ок”, начнется загрузка документов. В правом верхнем углу системы будет отображаться статус загрузки.

по окончанию импорта система обновит страницу и отобразит список добавленных документов. При загрузке каждая строка таблицы будет преобразована в документ с заданным названием. Дополнительные формулировки будут отображаться на вкладке “Дополнительные формулировки вопроса”

После импорта документы создаются в статусе “Активный”. Документы доступны для редактирования, см. раздел Как добавить или изменить документ?

Загрузка новых документов изменяет статус базы знаний на “Изменения неопубликованы“ и для того, чтобы система начала их использовать в работе, необходимо опубликовать базу, см. раздел
Как и зачем публиковать изменения?

Примечание: При таком способе импорта документов система создаст новые документы без обновления имеющихся. Чтобы обновлять имеющиеся документы воспользуйтесь импортом файла, аналогичным файлу выгрузки, описание способа приведено ниже.

Обновление базы знаний с помощью загрузки файла

Чтобы обновить имеющиеся документы с помощью файла загрузки необходимо воспользоваться способом, когда изменения вносятся в файл выгрузки и последующем импорте файла. В данном случае система сможет по идентификатору документа внести обновления. Если же идентификатора нет, то система создаст новый документ.

Чтобы скачать файл выгрузки перейдите в меню “Действие” и выберите опцию “Выгрузить в XLSX файл“.

Файл выгрузки базы знаний

Файл выгрузки содержит несколько листов.

• Базы знаний

• контексты

• Словарь баз знаний

• Общий словарь

Описание каждой вкладки приведено ниже

Базы знаний

Список документов приведен на первом листе и содержит следящую информацию по каждому документу:

• База знаний

Идентификатор базы знаний. Не меняйте значение, если планируете обратно загружать файл

• Название базы знаний

Отображается название базы знаний

• Документ

Идентификатор документа. Не меняйте значение, если планируете обратно загружать файл. При импорте система сопоставит идентификатор в файле с имеющимися документами. При совпадении обновит информацию из файла. Если добавляете новую строку с документам оставьте пустым. В данном случае система создаст новый документ и присвоит новый уникальный идентификатор

• Время создания

дата и время создания документа в системе

• Время изменения

дата и время последнего обновления документа в системе

• Статус

отображается статус документа. Можно изменять значение на “Активный” или “Черновик”

• Название

название документа, можно изменить и при импорте данные в документе обновятся

• Тип ответа

тип ответа, указанный в документе. Существуют три типа:

Сообщение
Обычный ответ пользователю. Данный тип присваивается при создании документов, далее можно изменить в настройках документа

Контекстный ответ
Выбор из нескольких вариантов ответа, см. раздел
Как сделать несколько вариантов ответов для автоответа?
Ответы для вариантов указываются на вкладке “Контексты”

Сценарий
использование скрипта диалогов с помощью сценариев, см. раздел
Как сделать диалоги с помощью сценариев?

• Ответ

текст сценария диалога, или текст сообщения для документов с одним вариантом ответа, или текст ответа по умолчанию для документов с несколькими вариантами ответа.

• Комментарий

текст комментарий к документу

• Файлы

список приложенных к документу файлов

• Срок жизни

дата, по истечении которой документ автоматически перейдет в статус Черновик. Если значения нет, значит срок действия документа не указан

• Уточняющий вопрос

текст уточняющего вопроса для документов с несколькими вариантами ответа

• Вопрос 1

первый пример вопроса к документу. Является обязательным полем при обратном импорте

• Вопрос 2 и далее

второй и последующие примеры вопроса к документу

Контексты

Вкладка “Контексты” содержит информацию по каждому варианту ответа в документах с несколькими вариантами ответа

• База знаний

ID базы знаний

• Документ

ID документа

• Контекст

ID варианта ответа

• Название

название варианта ответа

• Тип ответа

текстовое сообщение и сценарий диалога

• Ответ

текст сообщения или текст сценария диалога

• Комментарий

не используется

• Файлы

список приложенных к варианту ответа файлов

• Вопрос 1

первый пример вопроса к варианту ответа (обязательное поле)

• Вопрос 2 ( и далее)

дополнительные примеры вопросов к варианту ответа

Словарь базы знаний и Общий словарь

Вкладки “Словарь базы знаний” и “Общий словарь” содержат словари расшифровки терминов для каждой базы знаний или общий на все базы знаний словарь соответственно в формате:

• База знаний

ID базы знаний (для словарей баз знаний)

• Термин

термин, к которому приводятся все синонимы

• Синоним

фраза в запросе, которая будет автоматически заменяться на термин

Правила обновления базы знаний на основе XLSX файла

В окне загрузки документов базы знаний из файла XLSX добавлена опция (с версии 5.2.4), которая регулирует процесс загрузки вопросов к документам.

Для изменения или пополнения существующих документов через файл можно выгрузить базу знаний в XLSX файл, внести в него исправления и загрузить обратно.

Отредактируйте необходимые данные в файле, сохраняя данные в колонке ID документа. При обратной загрузке файла в каждом документе сервис обновит поля Ответ, Наименование и все вопросы к этому документу. Укажите требуемый способ загрузки вопросов к документу:

• Дописать новые вопросы из файла к списку вопросов документа (игнорируя дубликаты)

• Полностью переписать список вопросов документа на указанные в файле

Чтобы загрузить файл выгрузки перейдите в меню “Действие” и выберите опцию “Загрузить из XLSX файла“.

При редактировании файла:

• не удалять из файла колонку База знаний и не менять данные в этой колонке

• не удалять из файла колонку Документ и не менять данные в этой колонке

• загружать файл в базу знаний с тем же ID что указан в колонке База знаний

Порядок обновления данных в базе знаний:

• если в строке файла заполнена колонка Документ система попытается найти в базе знаний документ с соответствующим ID и внесет все данные в него

• если в строке файла колонка Документ не заполнена - система попытается создать новый документ с данными из строки

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

• Если вы удалили строку в файле - система НЕ удалит соответствующий документ в базе знаний

• Если вы добавили строку с пустым значением в колонке Документ - система попытается создать новый документ

• Если вы изменили значение в колонке Документ - система попытается найти документ с указанным значением ID и обновить данные в нем, если такой документ не будет найден система пропустит строку в файле

Примечание: файл загружается в конкретную базу знаний, поэтому из одного файла XLSX можно обновить или создать только одну базу знаний

Особенности работы с контекстными документами

После создания документ можно будет переместить в нужную БЗ

Шаблон для загрузки контекстного документа с заполненными обязательными полями.

При создании файла загрузки необходимо учесть связь ID Документа и ID Контекста на вкладках “Базы знаний” и “Контексты”