Model - Add Custom Prebuilt Entity

Reference

Service:: Azure AI Services

API Version:: 2.0

Adds a prebuilt entity model to a version of the application.

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

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
domainName	string	The domain name.
modelName	string	The intent name or entity name.

Responses

Name	Type	Description
201 Created	string	The ID of the created prebuilt model.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Add Custom Prebuilt Entity request

Sample request

HTTP

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


{
  "domainName": "Camera",
  "modelName": "AppName"
}

Sample response

Status code:: 201

"1c2e70c1-3cbf-4e89-9703-9583b81102b9"

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
PrebuiltDomainModelCreateObject	A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

PrebuiltDomainModelCreateObject

A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.

Name	Type	Description
domainName	string	The domain name.
modelName	string	The intent name or entity name.

Share via