Model - Update Hierarchical Entity

Updates the name and children of a hierarchical entity model in a version of the application.

PUT {Endpoint}/luis/api/v2.0/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

Request Body

Name Type Description
children

string[]

Child entities.

name

string

Entity name.

Responses

Name Type Description
200 OK

OperationStatus

Successful operation.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Hierarchical Entity Info request

Sample Request

PUT {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/fe559c31-9778-42ea-ba45-94e0bd7cf767


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

Sample Response

{
  "code": "Success",
  "message": "Operation Successful"
}

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.

HierarchicalEntityModel

A hierarchical entity extractor.

OperationStatus

Response of an Operation status.

OperationStatusType

Status Code.

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.

OperationStatus

Response of an Operation status.

Name Type Description
code

OperationStatusType

Status Code.

message

string

Status details.

OperationStatusType

Status Code.

Name Type Description
FAILED

string

Failed

string

Success

string