analyze

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

POST

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

Выполняет три операции в одном запросе — первоначальную разметку, поиск именованных сущностей и склонение текста

Запрос

Path Parameters

accessToken

string

required

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

Header Parameters

Z-timezone

string

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

Z-refTime

int64

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

• application/json

Body

required

data

InferenceRequestData

phrase

PhraseMarkupData

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

knownSlots

KnownSlotData[]

Array [

name

string

value

JsonNode

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

nBest

integer

По умолчанию: 1

showDebugInfo

boolean

По умолчанию: false

clientId

string

addtitionalData

InferenceRequestData

phrase

PhraseMarkupData

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

knownSlots

KnownSlotData[]

Array [

name

string

value

JsonNode

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

nBest

integer

По умолчанию: 1

showDebugInfo

boolean

По умолчанию: false

clientId

string
showAll

boolean

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

Ответы

• 200

Результат запроса

• application/json

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

Schema

markup

InitialMarkupData

source

string

required

correctedText

string

required

words

WordMarkupData[]

required

Array [

annotations

object

lemma

string

pos

string

startPos

integer

endPos

integer

pattern

boolean

punctuation

boolean

source

string

word

string

]

entitiesLookup

PhraseMarkupData

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

inference

InferenceResultsData

phrase

PhraseMarkupData

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

variants

InferenceResultData[]

Array [

intent

IntentResultData

id

int64

path

string

answer

string

customData

string

business

boolean

slots

SlotData[]

Array [

name

string

Имя слота (переменной)

entity

string

Имя сущности (типа)

required

boolean

Указывает, что для слота нужен интент

prompts

string[]

Список подскащок, которые будут использоваться в качестве вопросов для запроса значения

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

confidence

double

slots

KnownSlotData[]

Array [

name

string

value

JsonNode

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

debug

object

]

spelledWords

SpelledWordsData[]

Array [

source

string

required

startPos

integer

required

endPos

integer

required

variants

string[]

required

type

string

Возможные значения: [mlps, local]

]

addtitionalInference

InferenceResultsData

phrase

PhraseMarkupData

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

variants

InferenceResultData[]

Array [

intent

IntentResultData

id

int64

path

string

answer

string

customData

string

business

boolean

slots

SlotData[]

Array [

name

string

Имя слота (переменной)

entity

string

Имя сущности (типа)

required

boolean

Указывает, что для слота нужен интент

prompts

string[]

Список подскащок, которые будут использоваться в качестве вопросов для запроса значения

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

confidence

double

slots

KnownSlotData[]

Array [

name

string

value

JsonNode

array

boolean

По умолчанию: false

Указывает, что слоты заданы в виде массива. Если true — объект parseTree будет содержать список значений слота. Если false, показано будет только первое значение

client

boolean

По умолчанию: false

]

debug

object

]

spelledWords

SpelledWordsData[]

Array [

source

string

required

startPos

integer

required

endPos

integer

required

variants

string[]

required

type

string

Возможные значения: [mlps, local]

]

{
  "markup": {
    "source": "string",
    "correctedText": "string",
    "words": [
      {
        "annotations": {
          "lemma": "string",
          "pos": "string"
        },
        "startPos": 0,
        "endPos": 0,
        "pattern": true,
        "punctuation": true,
        "source": "string",
        "word": "string"
      }
    ]
  },
  "entitiesLookup": {
    "text": "string",
    "entities": [
      {
        "entity": "string",
        "slot": "string",
        "startPos": 0,
        "endPos": 0,
        "text": "string",
        "default": true,
        "system": true,
        "entityId": 0
      }
    ],
    "stagedPhraseIdx": 0
  },
  "inference": {
    "phrase": {
      "text": "string",
      "entities": [
        {
          "entity": "string",
          "slot": "string",
          "startPos": 0,
          "endPos": 0,
          "text": "string",
          "default": true,
          "system": true,
          "entityId": 0
        }
      ],
      "stagedPhraseIdx": 0
    },
    "variants": [
      {
        "intent": {
          "id": 0,
          "path": "string",
          "answer": "string",
          "customData": "string",
          "business": true,
          "slots": [
            {
              "name": "string",
              "entity": "string",
              "required": true,
              "prompts": [
                "string"
              ],
              "array": false,
              "client": false
            }
          ]
        },
        "confidence": 0,
        "slots": [
          {
            "name": "string",
            "array": false,
            "client": false
          }
        ],
        "debug": {}
      }
    ],
    "spelledWords": [
      {
        "source": "string",
        "startPos": 0,
        "endPos": 0,
        "variants": [
          "string"
        ],
        "type": "mlps"
      }
    ]
  },
  "addtitionalInference": {
    "phrase": {
      "text": "string",
      "entities": [
        {
          "entity": "string",
          "slot": "string",
          "startPos": 0,
          "endPos": 0,
          "text": "string",
          "default": true,
          "system": true,
          "entityId": 0
        }
      ],
      "stagedPhraseIdx": 0
    },
    "variants": [
      {
        "intent": {
          "id": 0,
          "path": "string",
          "answer": "string",
          "customData": "string",
          "business": true,
          "slots": [
            {
              "name": "string",
              "entity": "string",
              "required": true,
              "prompts": [
                "string"
              ],
              "array": false,
              "client": false
            }
          ]
        },
        "confidence": 0,
        "slots": [
          {
            "name": "string",
            "array": false,
            "client": false
          }
        ],
        "debug": {}
      }
    ],
    "spelledWords": [
      {
        "source": "string",
        "startPos": 0,
        "endPos": 0,
        "variants": [
          "string"
        ],
        "type": "mlps"
      }
    ]
  }
}

Loading...

Loading...