Model - Add Prebuilt

Service:

Azure AI Services

API Version:

2.0

Adds a list of prebuilt entities to a version of the application.

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

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
prebuiltExtractorNames	string[]	An array of prebuilt entity extractor names.

Responses

Name	Type	Description
201 Created	PrebuiltEntityExtractor[]	An array of the created prebuilt extractor infos.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Add Application Version Prebuilt Infos request

Sample request

HTTP

POST {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts


[
  "datetimeV2"
]

Sample response

Status code:

201

[
  {
    "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
    "name": "datetime",
    "typeId": 2,
    "readableType": "Prebuilt Entity Extractor"
  }
]

Definitions

Name	Description
EntityRole	Entity extractor role
ErrorResponse	Error response when invoking an operation on the API.
PrebuiltEntityExtractor	Prebuilt Entity Extractor.
ReadableType	Full name of the entity type.

EntityRole

Object

Entity extractor role

Name	Type	Description
id	string	The entity role ID.
name	string	The entity role name.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

PrebuiltEntityExtractor

Object

Prebuilt Entity Extractor.

Name	Type	Description
id	string	The ID of the Entity Model.
name	string	Name of the Entity Model.
readableType	ReadableType	Full name of the entity type.
roles	EntityRole[]	List of Pattern.Any Entity Extractors.
typeId	integer	The type ID of the Entity Model.

ReadableType

Enumeration

Full name of the entity type.

Value	Description
Closed List Entity Extractor
Composite Entity Extractor
Entity Extractor
Hierarchical Child Entity Extractor
Hierarchical Entity Extractor
Intent Classifier
List Entity Extractor
Pattern.Any Entity Extractor
Prebuilt Entity Extractor
Regex Entity Extractor