Share via

Model - Update Composite Entity

Service:
Azure AI Services
API Version:
2.0

Updates a composite entity in a version of the application.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}

URI Parameters

Name In Required Type Description
appId
 path True

string (uuid)

The application ID.
cEntityId
 path True

string (uuid)

The composite entity extractor ID.
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
versionId
 path True

string

The version ID.

Request Header

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

string

Request Body

Name Type Description
children

string[]

Child entities.
name

string

Entity name.

Responses

Name Type Description
200 OK

OperationStatus

Successfully updated composite entity.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Composite Entity Extractor request

Sample request

PUT {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/compositeentities/3d73462d-98f0-4dcd-8d30-fab9e65f2e73


{
  "name": "Renamed Entity"
}

Sample response

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

Definitions

Name Description
CompositeEntityModel

A composite entity extractor.
ErrorResponse

Error response when invoking an operation on the API.
OperationStatus

Response of an Operation status.
OperationStatusType

Status Code.

CompositeEntityModel

Object

A composite entity extractor.

Name Type Description
children

string[]

Child entities.
name

string

Entity name.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

OperationStatus

Object

Response of an Operation status.

Name Type Description
code

OperationStatusType

Status Code.
message

string

Status details.

OperationStatusType

Enumeration

Status Code.

Value Description
Failed
FAILED
Success