Model - List Custom Prebuilt Entity Roles

Service:

Azure AI Services

API Version:

3.0-preview

Get all roles for a prebuilt entity in a version of the application

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles

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).
entityId	path	True	string uuid	entity Id
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	EntityRole[]	A list of the entity roles
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Custom Prebuilt Entity Roles request

Sample request

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/2d3173b0-983c-43ae-92f8-6f5b5d09a11a/roles

Sample response

Status code:

200

[
  {
    "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
    "name": "role 1"
  },
  {
    "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
    "name": "role 2"
  }
]

Definitions

Name	Description
EntityRole	Entity extractor role
ErrorResponse	Error response when invoking an operation on the API.

EntityRole

Entity extractor role

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

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string