Share via

Model - List Custom Prebuilt Intents

Service:
Azure AI Services
API Version:
2.0

Gets information about customizable prebuilt intents added to a version of the application.

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

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

IntentClassifier[]

Returns a list of all customizable prebuilt intents and their representations in a version of the application.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Custom Prebuilt Intent request

Sample request

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

Sample response

Status code:
200 
[
  {
    "id": "b8e31be4-300f-455e-894b-6f079abca0a2",
    "name": "Camera.AppName",
    "typeId": 1,
    "readableType": "Intent Classifier",
    "customPrebuiltDomainName": "Calendar",
    "customPrebuiltModelName": "Add"
  }
]

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.
IntentClassifier

Intent Classifier.
ReadableType

Full name of the entity type.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

IntentClassifier

Object

Intent Classifier.

Name Type Description
customPrebuiltDomainName

string

The domain name.
customPrebuiltModelName

string

The intent name or entity name.
id

string (uuid)

The ID of the Entity Model.
name

string

Name of the Entity Model.
readableType

ReadableType

Full name of the entity type.
typeId

integer

The type ID of the Entity Model.

ReadableType

Enumeration

Full name of the entity type.

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