Model - List Hierarchical Entities

Служба:

Azure AI Services

Версия API:

3.0-preview

Получает сведения обо всех иерархических моделях сущностей в версии приложения.

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/hierarchicalentities

С использованием необязательных параметров:

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/hierarchicalentities?skip={skip}&take={take}

Параметры URI

Имя	В	Обязательно	Тип	Описание
appId	path	True	string (uuid)	Идентификатор приложения.
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://westus.api.cognitive.microsoft.com).
versionId	path	True	string	Идентификатор версии.
skip	query		integer minimum: 0	Количество пропускаемых записей. Значение по умолчанию равно 0.
take	query		integer minimum: 0 maximum: 500	Количество возвращаемых записей. Максимальный размер страницы составляет 500. Значение по умолчанию — 100.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	HierarchicalEntityExtractor[]	Список сведений об иерархической модели сущностей.
Other Status Codes	ErrorResponse	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful Get Application Version Hierarchical Entity Infos request

Образец запроса

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities?skip=0&take=100

Пример ответа

Код состояния:

200

[
  {
    "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
    "name": "Location",
    "typeId": 3,
    "readableType": "Hierarchical Entity Extractor",
    "children": [
      {
        "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
        "name": "From"
      },
      {
        "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
        "name": "To"
      }
    ],
    "roles": [
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 1"
      },
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 2"
      }
    ]
  }
]

Определения

Имя	Описание
ChildEntity	Тип базовой дочерней сущности.
EntityRole	Роль извлечения сущностей
ErrorResponse	Ответ об ошибке при вызове операции в API.
HierarchicalEntityExtractor	Средство извлечения иерархических сущностей.
ReadableType	Полное имя типа сущности.

ChildEntity

Object

Тип базовой дочерней сущности.

Имя	Тип	Описание
children	ChildEntity[]	Список дочерних элементов
id	string (uuid)	Идентификатор (GUID), принадлежащий дочерней сущности.
instanceOf	string	Экземпляр модели.
name	string	Имя дочерней сущности.
readableType	ReadableType	Полное имя типа сущности.
typeId	integer	Идентификатор типа модели сущности.

EntityRole

Object

Роль извлечения сущностей

Имя	Тип	Описание
id	string (uuid)	Идентификатор роли сущности.
name	string	Имя роли сущности.

ErrorResponse

Object

Ответ об ошибке при вызове операции в API.

Имя	Тип	Описание
errorType	string

HierarchicalEntityExtractor

Object

Средство извлечения иерархических сущностей.

Имя	Тип	Описание
children	ChildEntity[]	Список дочерних сущностей.
id	string (uuid)	Идентификатор модели сущностей.
name	string	Имя модели сущности.
readableType	ReadableType	Полное имя типа сущности.
roles	EntityRole[]	Список средств извлечения сущностей Pattern.Any.
typeId	integer	Идентификатор типа модели сущности.

ReadableType

Перечисление

Полное имя типа сущности.

Значение	Описание
Child Entity Extractor
Closed List Entity Extractor
Composite Entity Extractor
Entity Extractor
Hierarchical Child Entity Extractor
Hierarchical Entity Extractor
Intent Classifier
List Entity Extractor
Pattern.Any Entity Extractor
Prebuilt Entity Extractor
Regex Entity Extractor