Model - Update Entity

Updates the name of an entity in a version of the application.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/entities/{entityId}

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 extractor 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's new name.

Responses

Name Type Description
200 OK

OperationStatus

Successfully updated entity extractor name.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Rename Entity Info request

Sample request

PUT {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/3d73462d-98f0-4dcd-8d30-fab9e65f2e73


{
  "name": "New Name"
}

Sample response

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

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.

ModelUpdateObject

Object model for updating an intent classifier.

OperationStatus

Response of an Operation status.

OperationStatusType

Status Code.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

ModelUpdateObject

Object model for updating an intent classifier.

Name Type Description
name

string

The entity's new name.

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