SmartApp Brain Direct API
Скачать OpenAPI-спецификацию:Скачать
С помощью SmartApp Brain Direct API вы можете использовать сторонний обученный классификатор в своих проектах. Для обращения к SmartApp Brain Direct API из проектов, разработанных в Code, используйте встроенный сервис $caila
.
Если переобучение модели не удалось, то для классификации будет использоваться предыдущая версия.
Для подтверждения запросов используется API-ключ Brain.
Чтобы получить ключ:
- Откройте проект Code.
- Перейдите в раздел Настройки проекта.
- Откройте вкладку Классификатор.
- Сгенерируйте ключ в поле API-ключ Brain.
- Скопируйте ключ.
Для получения API-ключа текущего проекта в сценарии используйте метод $jsapi.cailaService.getCurrentClassifierToken()
.
Основные операции - простая классификация, классификация текста с дополнительными параметрами, согласование текста в требуемый формат, согласование текста с числительными.
conform
Согласование слова. Параметры согласования (исправление орфографии и язык) задаются в настройках проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
text required | string Слово, которое нужно согласовать с числительным. |
number required | integer Числительное, с которым нужно согласовать слово. |
Ответы
inflect
Склонение. Параметры склонения (исправление орфографии и язык) задаются в настройках проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
text required | string Слово для склонения. |
tags required | Array of strings Массив падежей для склонения |
Ответы
simpleInference
Простая классификация и слот-филлилинг с минимумом входных параметров
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
query required | string Реплика для обработки или поиска |
clientId | string Идентификатор пользователя |
Заголовки
Z-timezone | string Часовой пояс пользователя. Необязательный параметр. Если параметр не задан, используется часовой пояс проекта. Если часовой пояс проекта не задан, используется часовой пояс сервера |
Z-refTime | integer <int64> Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например |
Ответы
Пример ответа
- 200
{- "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",
- "value": null,
- "array": false,
- "client": false
}
], - "debug": { }
}
inference
Классификация и слот-филлинг с дополнительными параметрами
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Заголовки
Z-timezone | string Часовой пояс пользователя. Необязательный параметр. Если параметр не задан, используется часовой пояс проекта. Если часовой пояс проекта не задан, используется часовой пояс сервера |
Z-refTime | integer <int64> Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например |
Схема запроса: application/json
Тело запроса
object (PhraseMarkupData) | |
Array of objects (KnownSlotData) [ items ] | |
nBest | integer Default: 1 |
showDebugInfo | boolean Default: false |
clientId | string |
Ответы
Пример запроса
- Payload
{- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}, - "knownSlots": [
- {
- "name": "string",
- "value": null,
- "array": false,
- "client": false
}
], - "nBest": 1,
- "showDebugInfo": false,
- "clientId": "string"
}
Пример ответа
- 200
{- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "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",
- "value": null,
- "array": false,
- "client": false
}
], - "debug": { }
}
], - "spelledWords": [
- {
- "source": "string",
- "startPos": 0,
- "endPos": 0,
- "variants": [
- "string"
], - "type": "mlps"
}
]
}
inferenceMultiple
Слот-филлиг и классификация с дополнительными параметрами и возможностью пакетной обработки
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Заголовки
Z-timezone | string Часовой пояс пользователя. Необязательный параметр. Если параметр не задан, используется часовой пояс проекта. Если часовой пояс проекта не задан, используется часовой пояс сервера |
Z-refTime | integer <int64> Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например |
Схема запроса: application/json
Тело запроса
Array of objects (InferenceRequestPhrasesAndSlots) [ items ] | |
nBest | integer Default: 1 |
showDebugInfo | boolean Default: false |
Ответы
Пример запроса
- Payload
{- "phrases": [
- {
- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}, - "knownSlots": [
- {
- "name": "string",
- "value": null,
- "array": false,
- "client": false
}
]
}
], - "nBest": 1,
- "showDebugInfo": false
}
Пример ответа
- 200
[- {
- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "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",
- "value": null,
- "array": false,
- "client": false
}
], - "debug": { }
}
], - "spelledWords": [
- {
- "source": "string",
- "startPos": 0,
- "endPos": 0,
- "variants": [
- "string"
], - "type": "mlps"
}
]
}
]
entitiesLookup
Возвращает массив именованных сущностей, обнаруженных в переданном тексте
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
query required | string Реплика для обработки или поиска |
showAll required | boolean Указывает, что нужно вернуть все найденные сущности. Одному слову может соответствовать несколько сущностей. |
clientId | string Идентификатор пользователя |
Заголовки
Z-timezone | string Часовой пояс пользователя. Необязательный параметр. Если параметр не задан, используется часовой пояс проекта. Если часовой пояс проекта не задан, используется часовой пояс сервера |
Z-refTime | integer <int64> Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например |
Ответы
Пример ответа
- 200
{- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}
analyze
Выполняет три операции в одном запросе — первоначальную разметку, поиск именованных сущностей и склонение текста
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Заголовки
Z-timezone | string Часовой пояс пользователя. Необязательный параметр. Если параметр не задан, используется часовой пояс проекта. Если часовой пояс проекта не задан, используется часовой пояс сервера |
Z-refTime | integer <int64> Текущее время тестов. Используется для обработки реплик вроде «сейчас» или «завтра» с помощью сущностей, которые зависят от времени, например |
Схема запроса: application/json
object (InferenceRequestData) | |
object (InferenceRequestData) | |
showAll | boolean Указывает, что нужно вернуть все найденные сущности. Одному слову может соответствовать несколько сущностей. |
Ответы
Пример запроса
- Payload
{- "data": {
- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}, - "knownSlots": [
- {
- "name": "string",
- "value": null,
- "array": false,
- "client": false
}
], - "nBest": 1,
- "showDebugInfo": false,
- "clientId": "string"
}, - "addtitionalData": {
- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}, - "knownSlots": [
- {
- "name": "string",
- "value": null,
- "array": false,
- "client": false
}
], - "nBest": 1,
- "showDebugInfo": false,
- "clientId": "string"
}, - "showAll": true
}
Пример ответа
- 200
{- "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",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}, - "inference": {
- "phrase": {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "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",
- "value": null,
- "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",
- "value": null,
- "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",
- "value": null,
- "array": false,
- "client": false
}
], - "debug": { }
}
], - "spelledWords": [
- {
- "source": "string",
- "startPos": 0,
- "endPos": 0,
- "variants": [
- "string"
], - "type": "mlps"
}
]
}
}
initialMarkup
Получить текущую разметку
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
query required | string Query text |
Ответы
Пример ответа
- 200
{- "source": "string",
- "correctedText": "string",
- "words": [
- {
- "annotations": {
- "lemma": "string",
- "pos": "string"
}, - "startPos": 0,
- "endPos": 0,
- "pattern": true,
- "punctuation": true,
- "source": "string",
- "word": "string"
}
]
}
initialMarkupInternal
Создать разметку для паттернов, примеров и словарей
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Схема запроса: application/json
Array of texts for processing
Ответы
Пример запроса
- Payload
[- "string"
]
Пример ответа
- 200
[- {
- "source": "string",
- "correctedText": "string",
- "words": [
- {
- "annotations": {
- "lemma": "string",
- "pos": "string"
}, - "startPos": 0,
- "endPos": 0,
- "pattern": true,
- "punctuation": true,
- "source": "string",
- "word": "string"
}
]
}
]
Экспорт проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Ответы
Пример ответа
- 200
{- "project": {
- "id": "string",
- "name": "string",
- "folder": "string"
}, - "settings": {
- "language": "ru",
- "spellingCorrection": false,
- "classificationAlgorithm": "sts",
- "timezone": "Europe/Moscow",
- "extendedSettings": {
- "patternsEnabled": true,
- "tokenizerEngine": "string",
- "stsSettings": { },
- "cnnSettings": { },
- "bertSettings": { },
- "classicMLSettings": { },
- "dictionaryAutogeneration": true,
- "luceneAnalyzer": "standard",
- "shareIntents": true,
- "shareEntities": true,
- "shareIntentsForBusiness": true
}, - "shared": false,
- "businessShared": true,
- "business": true
}, - "intents": [
- {
- "id": 0,
- "path": "string",
- "description": "string",
- "answer": "string",
- "customData": "string",
- "enabled": true,
- "shared": true,
- "businessShared": true,
- "business": true,
- "phrases": [
- {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}
], - "patterns": [
- "string"
], - "slots": [
- {
- "name": "string",
- "entity": "string",
- "required": true,
- "prompts": [
- "string"
], - "array": false,
- "client": false
}
]
}
], - "entities": [
- {
- "entity": {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}, - "records": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
}
], - "enabledSystemEntities": [
- "string"
]
}
Импорт проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Схема запроса: application/json
object (ProjectData) | |
object (ProjectSettingsData) | |
Array of objects (IntentData) [ items ] | |
Array of objects (NamedEntityWithRecordsData) [ items ] | |
enabledSystemEntities | Array of strings |
Ответы
Пример запроса
- Payload
{- "project": {
- "id": "string",
- "name": "string",
- "folder": "string"
}, - "settings": {
- "language": "ru",
- "spellingCorrection": false,
- "classificationAlgorithm": "sts",
- "timezone": "Europe/Moscow",
- "extendedSettings": {
- "patternsEnabled": true,
- "tokenizerEngine": "string",
- "stsSettings": { },
- "cnnSettings": { },
- "bertSettings": { },
- "classicMLSettings": { },
- "dictionaryAutogeneration": true,
- "luceneAnalyzer": "standard",
- "shareIntents": true,
- "shareEntities": true,
- "shareIntentsForBusiness": true
}, - "shared": false,
- "businessShared": true,
- "business": true
}, - "intents": [
- {
- "id": 0,
- "path": "string",
- "description": "string",
- "answer": "string",
- "customData": "string",
- "enabled": true,
- "shared": true,
- "businessShared": true,
- "business": true,
- "phrases": [
- {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}
], - "patterns": [
- "string"
], - "slots": [
- {
- "name": "string",
- "entity": "string",
- "required": true,
- "prompts": [
- "string"
], - "array": false,
- "client": false
}
]
}
], - "entities": [
- {
- "entity": {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}, - "records": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
}
], - "enabledSystemEntities": [
- "string"
]
}
Пример ответа
- 200
{- "project": {
- "id": "string",
- "name": "string",
- "folder": "string"
}, - "settings": {
- "language": "ru",
- "spellingCorrection": false,
- "classificationAlgorithm": "sts",
- "timezone": "Europe/Moscow",
- "extendedSettings": {
- "patternsEnabled": true,
- "tokenizerEngine": "string",
- "stsSettings": { },
- "cnnSettings": { },
- "bertSettings": { },
- "classicMLSettings": { },
- "dictionaryAutogeneration": true,
- "luceneAnalyzer": "standard",
- "shareIntents": true,
- "shareEntities": true,
- "shareIntentsForBusiness": true
}, - "shared": false,
- "businessShared": true,
- "business": true
}, - "intents": [
- {
- "id": 0,
- "path": "string",
- "description": "string",
- "answer": "string",
- "customData": "string",
- "enabled": true,
- "shared": true,
- "businessShared": true,
- "business": true,
- "phrases": [
- {
- "text": "string",
- "entities": [
- {
- "entity": "string",
- "slot": "string",
- "startPos": 0,
- "endPos": 0,
- "text": "string",
- "value": null,
- "default": true,
- "system": true,
- "entityId": 0
}
], - "stagedPhraseIdx": 0
}
], - "patterns": [
- "string"
], - "slots": [
- {
- "name": "string",
- "entity": "string",
- "required": true,
- "prompts": [
- "string"
], - "array": false,
- "client": false
}
]
}
], - "entities": [
- {
- "entity": {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}, - "records": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
}
], - "enabledSystemEntities": [
- "string"
]
}
Получить сущности проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
withRecordsCount | boolean Default: false Указывает, что нужно добавить счетчик количества сущностей |
Ответы
Пример ответа
- 200
[- {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
]
Создать новую сущность
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Схема запроса: application/json
Новые интенты
id | integer <int64> |
name required | string Имя сущности. Будет доступно как |
enabled | boolean Default: true Включена ли сущность |
shared | boolean Общая сущность, которая используется для поиска во всех проектах. Можно указать |
type required | string (NamedEntityType) Enum: "dictionary" "annotation" Тип именованной сущности:
|
priority | integer Поле для ручного разрешения конфликтов, возникающих в случае если сущность соответствует одной части текста |
noSpelling | boolean Default: false Отключить автоматическое исправление орфографии для сущности. Включение указывает, что извлечение сущностей будет выполнено до исправления орфографии |
noMorph | boolean Default: false Отключает морфологическую нечувствительность сущности. |
itemsCount | integer |
phoneticSearch | boolean Default: false |
fuzzySearch | boolean Default: false |
client | boolean Default: false |
Ответы
Пример запроса
- Payload
{- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
Пример ответа
- 201
{- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
Обновить все сущности проекта
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Схема запроса: application/json
Массив новых сущностей
id | integer <int64> |
name required | string Имя сущности. Будет доступно как |
enabled | boolean Default: true Включена ли сущность |
shared | boolean Общая сущность, которая используется для поиска во всех проектах. Можно указать |
type required | string (NamedEntityType) Enum: "dictionary" "annotation" Тип именованной сущности:
|
priority | integer Поле для ручного разрешения конфликтов, возникающих в случае если сущность соответствует одной части текста |
noSpelling | boolean Default: false Отключить автоматическое исправление орфографии для сущности. Включение указывает, что извлечение сущностей будет выполнено до исправления орфографии |
noMorph | boolean Default: false Отключает морфологическую нечувствительность сущности. |
itemsCount | integer |
phoneticSearch | boolean Default: false |
fuzzySearch | boolean Default: false |
client | boolean Default: false |
Ответы
Пример запроса
- Payload
[- {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
]
Пример ответа
- 200
[- {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
]
Получить сущность с записями по имени
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityName required | string Уникальное имя сущности |
QUERY-ПАРАМЕТРЫ
clientId | string Идентификатор пользователя |
Ответы
Пример ответа
- 200
{- "entity": {
- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}, - "records": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
}
Обновить содержание сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityName required | string Уникальное имя сущности |
Схема запроса: application/json
Список новых записей для сущности
required | Array of objects (NamedEntityRecordData) [ items ] |
clientId | string |
Ответы
Пример запроса
- Payload
{- "data": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
], - "clientId": "string"
}
Пример ответа
- 200
[- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
Создать новую запись в сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityName required | string Уникальное имя сущности |
Схема запроса: application/json
Новая запись
required | object (NamedEntityRecordData) |
clientId | string |
Ответы
Пример запроса
- Payload
{- "data": {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}, - "clientId": "string"
}
Пример ответа
- 201
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Удалить несколько записей
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityName required | string Уникальное имя сущности |
QUERY-ПАРАМЕТРЫ
clientId | string Идентификатор пользователя |
Схема запроса: application/json
Идентификаторы записей, которые нужно удалить
Ответы
Пример запроса
- Payload
[- 0
]
Обновить запись в сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityName required | string Уникальное имя сущности |
recordId required | integer <int64> Идентификатор записи |
Схема запроса: application/json
Новая запись
required | object (NamedEntityRecordData) |
clientId | string |
Ответы
Пример запроса
- Payload
{- "data": {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}, - "clientId": "string"
}
Пример ответа
- 200
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Удалить список сущностей
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Схема запроса: application/json
Список идентификаторов сущностей
Ответы
Пример запроса
- Payload
[- 0
]
Получить именованную сущность
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
Ответы
Пример ответа
- 200
{- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
Обновить именованную сущность
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
Схема запроса: application/json
Новые сущности
id | integer <int64> |
name required | string Имя сущности. Будет доступно как |
enabled | boolean Default: true Включена ли сущность |
shared | boolean Общая сущность, которая используется для поиска во всех проектах. Можно указать |
type required | string (NamedEntityType) Enum: "dictionary" "annotation" Тип именованной сущности:
|
priority | integer Поле для ручного разрешения конфликтов, возникающих в случае если сущность соответствует одной части текста |
noSpelling | boolean Default: false Отключить автоматическое исправление орфографии для сущности. Включение указывает, что извлечение сущностей будет выполнено до исправления орфографии |
noMorph | boolean Default: false Отключает морфологическую нечувствительность сущности. |
itemsCount | integer |
phoneticSearch | boolean Default: false |
fuzzySearch | boolean Default: false |
client | boolean Default: false |
Ответы
Пример запроса
- Payload
{- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
Пример ответа
- 200
{- "id": 0,
- "name": "string",
- "enabled": true,
- "shared": true,
- "type": "dictionary",
- "priority": 0,
- "noSpelling": false,
- "noMorph": false,
- "itemsCount": 0,
- "phoneticSearch": false,
- "fuzzySearch": false,
- "client": false
}
Получить словарь именованной сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
QUERY-ПАРАМЕТРЫ
page | integer <int32> >= 0 Default: 0 Страница |
size | integer <int32> >= 1 Default: 20 Максимальное количество элементов в ответе |
searchQuery | string Поисковый запрос для фильтрации записей сущности |
Ответы
Пример ответа
- 200
{- "paging": {
- "pageNum": 0,
- "pageSize": 0,
- "totalCount": 0
}, - "records": [
- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
}
Добавить запись в словарь сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
Схема запроса: application/json
Новая запись
id | integer <int64> |
type required | string (NamedEntityRecordType) Enum: "pattern" "synonyms" |
rule required | Array of strings |
value required | string Значение, связанное с сущностью. Как правило — строка, число или JSON-объект |
clientId | string |
Ответы
Пример запроса
- Payload
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Пример ответа
- 201
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Обновить все содержание сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
Схема запроса: application/json
Новые сущности
id | integer <int64> |
type required | string (NamedEntityRecordType) Enum: "pattern" "synonyms" |
rule required | Array of strings |
value required | string Значение, связанное с сущностью. Как правило — строка, число или JSON-объект |
clientId | string |
Ответы
Пример запроса
- Payload
[- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
Пример ответа
- 200
[- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
Удалить несколько записей
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
Схема запроса: application/json
Массив идентификаторов зписией, которые нужно удалить
Ответы
Пример запроса
- Payload
[- 0
]
Загрузить записи из файла
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
QUERY-ПАРАМЕТРЫ
type required | string Value: "zb-csv" |
Схема запроса: multipart/form-data
CSV-файл с записями именованных сущностей
file | string <binary> |
Ответы
Пример ответа
- 200
[- {
- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
]
Получить указанную запись из сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
recordId required | integer <int64> Идентификатор записи |
Ответы
Пример ответа
- 200
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Обновить указанную запись в сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
recordId required | integer <int64> Идентификатор записи |
Схема запроса: application/json
Новая запись
id | integer <int64> |
type required | string (NamedEntityRecordType) Enum: "pattern" "synonyms" |
rule required | Array of strings |
value required | string Значение, связанное с сущностью. Как правило — строка, число или JSON-объект |
clientId | string |
Ответы
Пример запроса
- Payload
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Пример ответа
- 200
{- "id": 0,
- "type": "pattern",
- "rule": [
- "string"
], - "value": "string",
- "clientId": "string"
}
Удалить указанную запись в сущности
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
entityId required | integer <int64> Идентификатор сущности |
recordId required | integer <int64> Идентификатор записи |
Ответы
trainNLU
Запуск обучения NLU-модели
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
QUERY-ПАРАМЕТРЫ
incremental | boolean Default: true Пошаговое обучение. Переобучает только измененные части. Например, изменение единственной сущности приведет только к ее пересозданию, модель классификатора не изменится. |
logLabelingSessionId | integer <int64> |
Ответы
getNLUStatus
Возвращает статус обучения NLU-модели
PATH-ПАРАМЕТРЫ
accessToken required | string Токен доступа, который можно найти в настройках проекта |
Ответы
Пример ответа
- 200
{- "trainingStatus": "NONE",
- "lastError": "string",
- "lastChangeInIntents": "2019-08-24T14:15:22Z",
- "lastChangeInEntities": "2019-08-24T14:15:22Z",
- "lastModelTrainStart": "2019-08-24T14:15:22Z",
- "lastModelTrainTime": "2019-08-24T14:15:22Z",
- "cachedModelTrainStart": "2019-08-24T14:15:22Z",
- "cachedModelTrainTime": "2019-08-24T14:15:22Z"
}