$caila

Встроенный сервис $caila позволяет обращаться к NLP Direct API из сценария бота.

NLU

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

Метод	Описание
cdqaQuery	Получение фрагментов из документа CDQA.
markup markupWithToken	Разметка переданного текста.
getEntity getEntityWithToken	Возврат всех значений, заданных для сущности.
entitiesLookup entitiesLookupWithToken	Поиск сущностей в переданном тексте.
simpleInference simpleInferenceWithToken	Классификация текста без дополнительных параметров.
inference inferenceWithToken	Классификация текста с дополнительными параметрами.
inflect inflectWithToken inflectWithDictVersion inflectWithDictVersionWithToken	Преобразование слов и словосочетаний в нужную грамматическую форму.
conform conformWithToken	Согласование слов с числительными.
detectLanguage	Определение языка текста.
checkVocabulary	Проверка вхождения слова в словарь.

Передача API-ключа

Для большинства перечисленных методов также предусмотрены аналогичные методы с суффиксом WithToken: markupWithToken, entitiesLookupWithToken и т. д.

Эти методы работают так же, как основные, но принимают в качестве дополнительного последнего аргумента API-ключ NLP Direct API.

подсказка

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

Клиентские сущности

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

подсказка

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

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

Метод	Описание
addClientEntityRecords	Добавляет запись для определенного клиента к текущим записям сущности.
deleteClientEntityRecords	Удаляет записи с заданными идентификаторами id для определенного клиента.
getClientEntityRecords	Возвращает список записей сущности для определенного клиента.
setClientEntityRecords	Перезаписывает все записи сущности для определенного клиента.
setClientEntityRecord	Переопределяет запись сущности для определенного клиента.
setClientNerId	Устанавливает кастомный идентификатор клиента clientId, который будет в дальнейшем использоваться при анализе текста.
clearClientNerId	Удаляет кастомный идентификатор клиента clientId, который был установлен методом $caila.setClientNerId.