Model - Get Entity Role

  • Reference
Service:
Azure AI Services
API Version:
3.0-preview

Get one role for a given entity in a version of the application

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

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.
roleId
 path True

string

uuid

entity role 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

An entity role
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Entity Extractor Role request

Sample request

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/3d73462d-98f0-4dcd-8d30-fab9e65f2e73/roles/a682a962-1f92-4ae7-b8b8-398414e30c12

Sample response

Status code:
200 
{
  "id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
  "name": "role 1"
}

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