Model - List Prebuilt Entities

Service:

Azure AI Services

API Version:

2.0

Gets all the available prebuilt entities in a version of the application.

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/listprebuilts

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

Responses

Name	Type	Description
200 OK	AvailablePrebuiltEntityModel[]	A list of the possible prebuilt entity extractors.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Available Prebuilt Entity Extractors request

Sample request

HTTP

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

Sample response

Status code:

200

[
  {
    "name": "geography",
    "description": "Continents, Countries, Cities, Post codes, and other points of interest",
    "examples": "Antarctica, Portugal, Dubai, Sanjiang County, Lake Pontchartrain, CB3 0DS"
  },
  {
    "name": "datetime",
    "description": "Dates and times, resolved to a canonical form",
    "examples": "June 23, 1976, Jul 11 2012, 7 AM, 6:49 PM, tomorrow at 7 AM"
  },
  {
    "name": "email",
    "description": "Email Addresses",
    "examples": "user@site.net, user_name@mysite.com.eg"
  },
  {
    "name": "url",
    "description": "Websites URLs",
    "examples": "www.website.com, http://website.net?name=my_name&age=10, https://www.mywebsite.net.eg/page"
  },
  {
    "name": "phoneNumber",
    "description": "US phone numbers",
    "examples": "123-456-7890, +1 123 456 789, (123)456-789"
  }
]

Definitions

Name	Description
AvailablePrebuiltEntityModel	Available Prebuilt entity model for using in an application.
ErrorResponse	Error response when invoking an operation on the API.

AvailablePrebuiltEntityModel

Available Prebuilt entity model for using in an application.

Name	Type	Description
description	string	The entity description and usage information.
examples	string	Usage examples.
name	string	The entity name.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string