entitiesLookup

Обновлено 14 февраля 2025

GET

/api/caila/p/{accessToken}/nlu/entities

Возвращает массив именованных сущностей, обнаруженных в переданном тексте

Запрос

Path Parameters

accessToken

string

required

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

Query Parameters

query

string

required

Реплика для обработки или поиска

showAll

boolean

required

Указывает, что нужно вернуть все найденные сущности. Одному слову может соответствовать несколько сущностей.

clientId

string

Идентификатор пользователя

Header Parameters

Z-timezone

string

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

Z-refTime

int64

Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например duckling.time

Ответы

• 200

Массив найденных сущностей

• application/json

• Схема
• Пример из схемы

Schema

text
string
entities EntityMarkupData[]
Array [
entity
string
Имя сущности (типа). Должно совпадать с сущностями, одной из сущностей включенных в параметрах проекта
slot
string
Имя слота (переменной). Должно совпадать с одинм из слотов интента
startPos
integer
Начальное положение в исходной строке, включительно
endPos
integer
Конечное положение в исходной строке (исключительно)
text
string
Исходный текст сущности. Подстрока исходной реплики в диапазоне значени от StartPos до EndPos
value
JsonNode
Соответствующее значение
default
boolean
Указывает, что выбранная сущность — наиболее вероятная для заданной позиции
system
boolean
Указывает, что выбранная сущность — системная. Если false, то сущность пользовательская
entityId
int64
Идентификатор сущности
]
stagedPhraseIdx
integer

{
  "text": "string",
  "entities": [
    {
      "entity": "string",
      "slot": "string",
      "startPos": 0,
      "endPos": 0,
      "text": "string",
      "default": true,
      "system": true,
      "entityId": 0
    }
  ],
  "stagedPhraseIdx": 0
}

Loading...

Loading...