Share via

Model - Add Entity

Service:
Azure AI Services
API Version:
3.0-preview

Adds an entity extractor to a version of the application.

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

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

ChildEntityModelCreateObject[]

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 Entity Extractor request

Sample request

POST {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities


{
  "name": "DayOfWeek",
  "children": [
    {
      "name": "Day",
      "instanceOf": "datetimeV2"
    }
  ]
}

Sample response

Status code:
201 
Location: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922
"3d73462d-98f0-4dcd-8d30-fab9e65f2e73"

Definitions

Name Description
ChildEntityModelCreateObject

A child entity extractor create object.
EntityModelCreateObject

An entity extractor create object.
ErrorResponse

Error response when invoking an operation on the API.

ChildEntityModelCreateObject

Object

A child entity extractor create object.

Name Type Description
children

ChildEntityModelCreateObject[]

Child entities.
instanceOf

string

The instance of model name
name

string

Entity name.

EntityModelCreateObject

Object

An entity extractor create object.

Name Type Description
children

ChildEntityModelCreateObject[]

Child entities.
name

string

Entity name.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string