Model - Add Hierarchical Entity

Adds a hierarchical entity extractor to a version of the application.

POST {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/hierarchicalentities

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

versionId
path True

string

The version ID.

Request Header

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

string

Request Body

Name Type Description
children

string[]

Child entities.

name

string

Entity name.

Responses

Name Type Description
201 Created

string

The ID of the created model.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Create Hierarchical Entity Extractor request

Sample request

POST {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities


{
  "name": "Location",
  "children": [
    "From",
    "To"
  ]
}

Sample response

"fe559c31-9778-42ea-ba45-94e0bd7cf767"

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.

HierarchicalEntityModel

A hierarchical entity extractor.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

HierarchicalEntityModel

A hierarchical entity extractor.

Name Type Description
children

string[]

Child entities.

name

string

Entity name.