{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/ru/NLU_core/entities/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"d15624c9-15d4-5389-945b-0aa0c3d4abb5","excerpt":"Сущности Сущность — единица NLU-ядра CAILA. Представляет собой последовательность слов, объединенных некоторым смыслом или правилом. Например: имена, дата и…","html":"

Сущности

\n
\n

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

\n

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

\n\n

Подробнее о редакторе сущностей

\n
\n

Использование сущностей

\n

Напрямую

\n

Все сущности, найденные во фразе будут доступны в сценарии через переменную $jsapi.context().entities или $entities.

\n

Например:

\n
    state:\r\n        q!: Информация по продукту *\r\n        a: Информация по продукту: {{ $entities[0].value }}
\n
\n

В интентах

\n

Сущности можно использовать в интентах.

\n

Подробнее о заполнении слотов в интентах и процессе Slot filling

\n

При активации интента данные по соответствующему слоту попадут в переменную $parseTree._<имя слота>.

\n

В этой переменной будет записан исходный текст, по которому найдено совпадение, либо данные DATA, заданные для данной сущности в редакторе сущностей.

\n

Например:

\n
    state:\r\n        intent: /купить\r\n        a: Action: {{ $parseTree._Action }}, Product: {{ $parseTree._Product }}\r\n\r\n    state:\r\n        intent: /продать\r\n        a: Action: {{ $parseTree._Action }}, Product: {{ $parseTree._Product }}
\n
\n

В паттернах

\n

Сущности можно использовать в паттернах, ссылаясь на них как @<имя сущности> или @<имя сущности>::<имя слота>.

\n

Для сущности, указанной в паттерне, автоматически создается слот, и она попадает в дерево разбора $parseTree. Значение сущности будет доступно в сценарии как $parseTree._<имя слота>.

\n

Например:

\n
    state:\r\n        q!: * @Product::p1 *\r\n        a: Информация по продукту: {{ $parseTree._p1 }}
\n

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

\n
patterns:\r\n    $four = @four || converter = function() {return 4}
\n

В этом примере мы создали сущность @four, в которой объявили конвертер converter. Функция конвертера вернет значение 4.

\n
\n

В примерах фраз классификатора STS

\n

Сущности можно использовать в примерах фраз классификатора STS, ссылаясь на них как @<имя сущности> или @<имя сущности>::<имя слота>.

\n

Для сущности, указанной в примере, автоматически создается слот, и она попадает в дерево разбора $parseTree.

\n

Значение сущности будет доступно в сценарии как $parseTree._<имя слота>.

\n

Например:

\n
    state:\r\n        e!: @Pizza::p2\r\n        a: Информация о пицце: {{ $parseTree._p2 }}
\n
\n

В сущностях

\n

В JAICP сущности могут ссылаться на другие сущности.

\n

Рассмотрим поведение сущностей при:

\n\n
Заполнение поля Значение
\n

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

\n

В меню проекта перейдите на вкладку CAILA > Сущности > Мои сущности и создайте сущности:

\n\n
Ленина\r\nШкольная\r\nЦентральная
\n\n
Улица @street_name
\n

Теперь создадим сущность address, которая будет ссылаться на сущность street и на системную сущность @duckling.number:

\n
@street дом @duckling.number
\n

Теперь допустим, что клиент вводит сообщение Улица Ленина. Поле Значение будет заполнено следующим образом:

\n\n

Если клиент вводит сообщение Улица Школьная дом 15, то Значение будет заполнено так:

\n\n
\n
Заполнение поля DATA
\n

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

\n

В меню проекта перейдите на вкладку CAILA > Сущности > Мои сущности и создайте сущности:

\n\n
(яблок*|ренет*)\r\n(банан*)\r\n(лимон*)
\n\n
(картошк*|картох*|картофель)\r\n(томат*|помидор*)
\n
\n

Кроме того, в поле DATA для каждого паттерна добавим значение сущности в формате JSON. В это поле можно указать любую информацию, которая может быть нужна для сценария. В нашем случае мы будем указывать характеристики name и type, которые отвечают за название и тип продукта.

\n

Например, для паттерна (банан*) укажите:

\n
{\r\n    \"name\": \"banana\",\r\n    \"type\": \"fruit\"\r\n}
\n

Сделайте то же самое для каждого паттерна сущности vegetable. Например:

\n
{\r\n    \"name\": \"potato\",\r\n    \"type\": \"vegetable\"\r\n}
\n
\n

Теперь объединим эти сущности в сущность grocery. Создайте сущность grocery и в поле Справочник укажите паттерны @vegetable и @fruit.

\n

\n \n \n

\n
\n

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

\n
state: Start\r\n    q!: $regex</start>\r\n    a: Здравствуйте! В нашем магазине представлен широкий ассортимент овощей и фруктов. Что вы хотите?\r\n\r\n    state: Grocery\r\n        q!: * @grocery *\r\n        script:\r\n            $reactions.answer(\"Название продукта: {{ $parseTree._grocery.name }}\");\r\n            $reactions.answer(\"Тип продукта: {{ $parseTree._grocery.type }}\");
\n

Таким образом, если клиент напишет сообщение Картошку, то это сообщение будет распознано сущностью vegetable, на которую ссылается сущность grocery. Поле DATA у сущности grocery заполнится содержимым поля DATA сущности vegetable. Бот выведет сообщения:

\n
Название продукта: potato\r\nТип продукта: vegetable
\n
\n

Заполнение массива $entities

\n

Рассмотрим пример наличия нескольких вариантов совпадения при поиске сущности.

\n

Создадим пользовательскую сущность @City. В справочник сущности поместим два значения Нижний Новгород и Великий Новгород. При запросе клиента Новгород бот должен уточнить, какой именно город пользователь подразумевал.

\n

Для этого необходимо, чтобы в массив $entities попали все значения сущности.

\n

При помощи метода CAILA API:

\n
PUT    /cailapub/api/caila/p/{accessToken}/entities/{entityId}
\n
\n

Добавим параметр для сущности @City:

\n
{\r\n  \"fuzzySearch\": true    // позволяет находить и помещать в массив несколько значений\r\n}
\n

Теперь в $context.entities будет храниться список из значений Нижний Новгород и Великий Новгород, и бот может задать уточняющий вопрос клиенту.

","frontmatter":{"title":"","description":null},"headings":[{"value":"Сущности"}]}},"pageContext":{"slug":"/docs/ru/NLU_core/entities/","previous":{"fields":{"slug":"/docs/ru/NLU_core/intent/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/ru/NLU_core/duckling/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}