Получить сущность с записями по имени

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

GET

/api/caila/p/{accessToken}/entities-by-name/{entityName}

Получить сущность с записями по имени

Запрос

Path Parameters

accessToken

string

required

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

entityName

string

required

Уникальное имя сущности

Query Parameters

clientId

string

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

Ответы

• 200

Описание сущности

• application/json

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

Schema

entity NamedEntityData

id

int64

name

string

required

Имя сущности. Будет доступно как @<name> в паттернах и шаблонах фраз

enabled

boolean

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

Включена ли сущность

shared

boolean

Общая сущность, которая используется для поиска во всех проектах. Можно указать true только в общих проектах.

type

NamedEntityType (string)

required

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

Тип именованной сущности:

• Dictionary - справочники и правила;
• Annotation - сущности основанные на машинном обучении.

priority

integer

Поле для ручного разрешения конфликтов, возникающих в случае если сущность соответствует одной части текста

noSpelling

boolean

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

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

noMorph

boolean

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

Отключает морфологическую нечувствительность сущности.

itemsCount

integer

phoneticSearch

boolean

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

fuzzySearch

boolean

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

client

boolean

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

records NamedEntityRecordData[]
Array [
id
int64
type
NamedEntityRecordType (string)
required
Возможные значения: [pattern, synonyms]
rule
string[]
required
value
string
required
Значение, связанное с сущностью. Как правило — строка, число или JSON-объект
clientId
string
]

{
  "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"
    }
  ]
}

Loading...

Loading...