Share via

Model - Get Composite Entity

Service:
Azure AI Services
API Version:
3.0-preview

Gets information about a composite entity in a version of the application.

GET {Endpoint}/luis/authoring/v3.0-preview/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

Responses

Name Type Description
200 OK

CompositeEntityExtractor

The composite entity model info.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Composite Entity Info request

Sample request

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

Sample response

Status code:
200 
{
  "id": "bc1bae43-7904-48ad-a165-88b1910174f9",
  "name": "Reservation",
  "typeId": 4,
  "readableType": "Composite Entity Extractor",
  "children": [
    {
      "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
      "name": "Location::To"
    },
    {
      "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
      "name": "datetime"
    }
  ],
  "roles": [
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 1"
    },
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 2"
    }
  ]
}

Definitions

Name Description
ChildEntity

The base child entity type.
CompositeEntityExtractor

A Composite Entity Extractor.
EntityRole

Entity extractor role
ErrorResponse

Error response when invoking an operation on the API.
ReadableType

Full name of the entity type.

ChildEntity

Object

The base child entity type.

Name Type Description
children

ChildEntity[]

List of children
id

string (uuid)

The ID (GUID) belonging to a child entity.
instanceOf

string

Instance of Model.
name

string

The name of a child entity.
readableType

ReadableType

Full name of the entity type.
typeId

integer

The type ID of the Entity Model.

CompositeEntityExtractor

Object

A Composite Entity Extractor.

Name Type Description
children

ChildEntity[]

List of child entities.
id

string (uuid)

The ID of the Entity Model.
name

string

Name of the Entity Model.
readableType

ReadableType

Full name of the entity type.
roles

EntityRole[]

List of Pattern.Any Entity Extractors.
typeId

integer

The type ID of the Entity Model.

EntityRole

Object

Entity extractor role

Name Type Description
id

string (uuid)

The entity role ID.
name

string

The entity role name.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

ReadableType

Enumeration

Full name of the entity type.

Value Description
Entity Extractor
Child Entity Extractor
Hierarchical Entity Extractor
Hierarchical Child Entity Extractor
Composite Entity Extractor
List Entity Extractor
Prebuilt Entity Extractor
Intent Classifier
Pattern.Any Entity Extractor
Closed List Entity Extractor
Regex Entity Extractor