Сущности

Сущность — единица NLU-ядра CAILA. Представляет собой последовательность слов, объединенных некоторым смыслом или правилом. Например: имена, дата и время, местоположение и пр.

Подробнее о работе с сущностями в сценарии

Пользовательские сущности

Пользовательские сущности — сущности, которые разработчик заполняет и настраивает в редакторе сущностей самостоятельно.

Войдите в проект, на панели управления нажмите CAILA > Сущности. Вы перешили в справочник сущностей проекта.

Перейдите на вкладку CAILA > сущности из панели управления

Настройка сущности

Нажмите Создать сущность > укажите название сущности.

Распознается

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

Рассмотрим поведение сценария при различных настройках:

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

Клиентская

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

Рассмотрим поведение сценария при различных настройках:

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

Подробнее о работе с клиентскими сущностями

Исправление орфографии

Функция Исправление орфографии позволяет исправлять орфографические ошибки в запросах клиентов. При активной функции распознавание сущностей будет проводиться с учетом возможных опечаток.

Рассмотрим поведение сценария при различных настройках:

Настройка	Поведение	Пример
Исправлять опечатки	Поиск сущностей будет выполняться после исправления опечаток системным способом и клиентским словарем.	Например, исправление орфографии в проекте включено, а для сущности со списком городов `@City` включено исправление опечаток. Фраза `Масква моя столица` будет исправлена на `Москва моя столица`. Затем исправленная фраза будет направлена на поиск сущностей.
Не исправлять опечатки	Поиск сущностей выполняется в исходной фразе без исправления опечаток, независимо от настроек проекта.	Например, исправление орфографии в проекте включено, а для сущности со списком городов `@City` исправление опечаток выключено. Для фразы `Масква моя столица` сущность `@City` не будет обнаружена.

Дополнительные настройки

Настройка	Поведение
Приводить к нормальной форме	При активном параметре перед началом поиска сущностей все слова будут приведены к нормальной форме. Лемматизация для проектов на китайском и португальском языках не поддерживается.
Использовать нечеткий поиск/поиск по подстроке	Включает поиск сущностей с учетом возможных вставок других слов, а также поиск по подстроке.
Автоматически расширять интенты	При активном параметре, если эта сущность была найдена в интенте и во фразе клиента, вес для попадания в интент будет увеличен. При включении параметра сущность также будет добавлена в расширенные настройки NLU как `allowedPatterns`. Обратите внимание, что настройка доступна только для STS классификатора.

Справочник

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

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

Также дополнительно в качестве справочных данных вы можете указать DATA — значение сущности, в формате string или JSON.

Импорт справочника

Вы также можете загрузить уже заранее подготовленный набор значений для сущности. Нажмите Импорт справочника > выберите .csv.

Структура строки файла:

id; имя; значение

Например:

149;Иван, Ваня;{"name": "Иван", "sex": "male"}
150;Игорь;{"name": "Игорь", "sex": "male"}

Параметры, переданные внутри {} будут перенесены как DATA.

Системные сущности

Системные сущности — встроенные сущности, которые разработчик может активировать в редакторе сущностей.

Вы можете активировать распознавание системных сущностей. Войдите в проект, на панели управления нажмите Редактор > Сущности > Системные.

Активируйте распознавание системных сущностей

Нажмите на название сущности, чтобы просмотреть описание и распознаваемые форматы.

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