Model - Add Entity Child

Reference

Service:: Azure AI Services

API Version:: 3.0-preview

Creates a single child in an existing entity model hierarchy in a version of the application.

POST {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/entities/{entityId}/children

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).
entityId	path	True	string uuid	The 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	ChildEntityModelCreateObject[]	Child entities.
instanceOf	string	The instance of model name
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 Entity Child Model request

Sample request

HTTP

POST {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/fe559c31-9778-42ea-ba45-94e0bd7cf767/children


{
  "name": "Day",
  "children": [],
  "instanceOf": "number"
}

Sample response

Status code:: 201

"891c235f-4f42-4320-bc36-b6256b6c3f2b"

Definitions

Name	Description
ChildEntityModelCreateObject	A child entity extractor create object.
ErrorResponse	Error response when invoking an operation on the API.

ChildEntityModelCreateObject

A child entity extractor create object.

Name	Type	Description
children	ChildEntityModelCreateObject[]	Child entities.
instanceOf	string	The instance of model name
name	string	Entity name.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

Share via