Model - Get Hierarchical Entity Child

Gets information about the child's model contained in an hierarchical entity child model in a version of the application.

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}

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).

hChildId
path True

string

uuid

The hierarchical entity extractor child ID.

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

HierarchicalChildEntity

The hierarchical entity child model info.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Hierarchical Entity Child Info request

Sample request

GET {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities/fe559c31-9778-42ea-ba45-94e0bd7cf767/children/fe559c31-9778-42ea-ed45-94e0bd7cf767

Sample response

{
  "id": "ef278a6c-d94f-4d20-a602-cf53d0acf0f5",
  "name": "From",
  "typeId": 6,
  "readableType": "Hierarchical Child Entity Extractor"
}

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.

HierarchicalChildEntity

A Hierarchical Child Entity.

ReadableType

Full name of the entity type.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

HierarchicalChildEntity

A Hierarchical Child Entity.

Name Type Description
id

string

The ID (GUID) belonging to a child entity.

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.

ReadableType

Full name of the entity type.

Name Type Description
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