ym88659208ym87991671
Сущности для смартапов | Документация для разработчиков

Сущности Brain

Обновлено 21 августа 2024

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

Brain предоставляет для работы:

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

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

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

Чтобы создать пользовательскую сущность:

  1. На панели слева выберите вкладку РедакторСущности.

  2. На вкладке Мои сущности нажмите Создать и заполните следующие параметры:

    • Название — имя сущности.
    • Описание — описание сущности.
  3. Задайте настройки сущности.

  4. Добавьте значения сущности в справочник.

Все изменения сохраняются автоматически.

Настройка пользовательских сущностей

Вы можете настроить поведение сущности в разделе Настройки.

По умолчанию созданная сущность будет активна в текущем сценарии. Для изменения этой настройки воспользуйтесь переключателем Активна в текущем сценарии.

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

В раскрывающемся списке Ошибки укажите, как должно работать исправление ошибок для выбранной сущности:

  • Выберите Исправлять опечатки, если хотите, чтобы сущность определялась после исправления опечаток. Исправление опечаток выполняется с учетом клиентского словаря.
  • Выберите Не исправлять опечатки, если хотите, чтобы сущность определялась без исправления опечаток, независимо от настроек проекта. Таким образом, если во фразе есть значение сущности с опечаткой, Code не определит данную сущность.

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

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

Установите флажок Использовать нечеткий поиск или поиск по подстроке, чтобы включить нечеткий поиск сущности.

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

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

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

Добавление значений сущности

Чтобы добавить значение:

  1. В разделе Словарь синонимов и шаблонов нажмите Добавить.
  2. Выберите способ, с помощью которого будет задана запись:
    • Синонимы — позволяет указать синонимы и варианты написания, которые считаются эквивалентными этому значению.
    • Шаблон — позволяет указать формальное правило, описывающее ключевые слова и выражения. Используйте базовые элементы паттернов.

Добавьте как минимум один синоним или шаблон. Нажмите на кнопку Добавить данные JSON, чтобы задать значение сущности в формате string или JSON.

Вы также можете импортировать CSV-справочник сущности. Для этого нажмите Загрузить и выберите файл для импорта.

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

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

Чтобы включить распознавание системных сущностей:

  1. На панели слева выберите вкладку РедакторСущности.
  2. Выберите вкладку Системные.
  3. Выберите сущность в списке, чтобы просмотреть ее описание и распознаваемые форматы.
  4. Включите сущность с помощью переключателя.
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.