Share via

Model - Get Hierarchical Entity Child

Service:
Azure AI Services
API Version:
3.0-preview

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

GET {Endpoint}/luis/authoring/v3.0-preview/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/authoring/v3.0-preview/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities/fe559c31-9778-42ea-ba45-94e0bd7cf767/children/fe559c31-9778-42ea-ed45-94e0bd7cf767

Sample response

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

Definitions

Name Description
ChildEntity

The base child entity type.
ErrorResponse

Error response when invoking an operation on the API.
HierarchicalChildEntity

A Hierarchical Child Entity.
ReadableType

Full name of the entity type.

ChildEntity

Object

The base child entity type.

Name Type Description
children

ChildEntity[]

List of children
id

string (uuid)

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.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

HierarchicalChildEntity

Object

A Hierarchical Child Entity.

Name Type Description
children

ChildEntity[]

List of children
id

string (uuid)

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.

ReadableType

Enumeration

Full name of the entity type.

Value Description
Entity Extractor
Child Entity Extractor
Hierarchical Entity Extractor
Hierarchical Child Entity Extractor
Composite Entity Extractor
List Entity Extractor
Prebuilt Entity Extractor
Intent Classifier
Pattern.Any Entity Extractor
Closed List Entity Extractor
Regex Entity Extractor