Model - Update Entity Child

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

Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.

PATCH {Endpoint}/luis/authoring/v3.0-preview/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 or the child 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
instanceOf

string

The instance of model name
name

string

Entity name.

Responses

Name Type Description
200 OK

OperationStatus

Successful operation.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Entity Extractor request

Sample request

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


{
  "name": "New Name",
  "instanceOf": "number"
}

Sample response

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

Definitions

Name Description
EntityModelUpdateObject

An entity extractor update object.
ErrorResponse

Error response when invoking an operation on the API.
OperationStatus

Response of an Operation status.
OperationStatusType

Status Code.

EntityModelUpdateObject

An entity extractor update object.

Name Type Description
instanceOf

string

The instance of model name
name

string

Entity 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