Model - Update Custom Prebuilt Entity Role

Service:

Azure AI Services

API Version:

3.0-preview

Update a role for a given prebuilt entity in a version of the application.

PUT {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/customprebuiltentities/{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	The entity ID.
roleId	path	True	string uuid	The entity role ID.
versionId	path	True	string	The version ID.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Request Body

Name	Type	Description
name	string	The entity role name.

Responses

Name	Type	Description
200 OK	OperationStatus	Successfully updated the entity role.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Custom Prebuilt Entity Extractor Role request

Sample request

HTTP

PUT {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/3d73462d-98f0-4dcd-8d30-fab9e65f2e73/roles/6dbed7e2-7df6-4cd6-a225-97e6fbe4493d


{
  "name": "New Name"
}

Sample response

Status code:

200

{
  "code": "Success",
  "message": "Operation Successful"
}

Definitions

Name	Description
EntityRoleUpdateObject	Object model for updating an entity role.
ErrorResponse	Error response when invoking an operation on the API.
OperationStatus	Response of an Operation status.
OperationStatusType	Status Code.

EntityRoleUpdateObject

Object model for updating an entity role.

Name	Type	Description
name	string	The entity role name.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

OperationStatus

Response of an Operation status.

Name	Type	Description
code	OperationStatusType	Status Code.
message	string	Status details.

OperationStatusType

Status Code.

Name	Type	Description
FAILED	string
Failed	string
Success	string