Model - Get Hierarchical Entity

Gets information about a hierarchical entity in a version of the application.

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

URI Parameters

Name In Required Type Description
appId
path True

string

uuid

The application ID.

Endpoint
path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

hEntityId
path True

string

uuid

The hierarchical entity extractor ID.

versionId
path True

string

The version ID.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

HierarchicalEntityExtractor

A hierarchical entity model info.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Hierarchical Entity Info request

Sample request

GET {Endpoint}/luis/authoring/v3.0-preview/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities/fe559c31-9778-42ea-ba45-94e0bd7cf767

Sample response

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

Definitions

Name Description
ChildEntity

The base child entity type.

EntityRole

Entity extractor role

ErrorResponse

Error response when invoking an operation on the API.

HierarchicalEntityExtractor

Hierarchical Entity Extractor.

ReadableType

Full name of the entity type.

ChildEntity

The base child entity type.

Name Type Description
children

ChildEntity[]

List of children

id

string

The ID (GUID) belonging to a child entity.

instanceOf

string

Instance of Model.

name

string

The name of a child entity.

readableType

ReadableType

Full name of the entity type.

typeId

integer

The type ID of the Entity Model.

EntityRole

Entity extractor role

Name Type Description
id

string

The entity role ID.

name

string

The entity role name.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

HierarchicalEntityExtractor

Hierarchical Entity Extractor.

Name Type Description
children

ChildEntity[]

List of child entities.

id

string

The ID of the Entity Model.

name

string

Name of the Entity Model.

readableType

ReadableType

Full name of the entity type.

roles

EntityRole[]

List of Pattern.Any Entity Extractors.

typeId

integer

The type ID of the Entity Model.

ReadableType

Full name of the entity type.

Name Type Description
Child Entity Extractor

string

Closed List Entity Extractor

string

Composite Entity Extractor

string

Entity Extractor

string

Hierarchical Child Entity Extractor

string

Hierarchical Entity Extractor

string

Intent Classifier

string

List Entity Extractor

string

Pattern.Any Entity Extractor

string

Prebuilt Entity Extractor

string

Regex Entity Extractor

string