Share via

Model - List Entities

Service:
Azure AI Services
API Version:
3.0-preview

Gets information about all the simple entity models in a version of the application.

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/entities
With optional parameters: 
GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/entities?skip={skip}&take={take}

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).
versionId
 path True

string

The version ID.
skip
 query

integer

minimum: 0

The number of entries to skip. Default value is 0.
take
 query

integer

minimum: 0
maximum: 500

The number of entries to return. Maximum page size is 500. Default is 100.

Request Header

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

string

Responses

Name Type Description
200 OK

NDepthEntityExtractor[]

A list of entity model infos.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Application Version Entity Infos request

Sample request

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities?skip=0&take=100

Sample response

Status code:
200 
[
  {
    "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
    "name": "DayOfWeek",
    "typeId": 1,
    "readableType": "Entity Extractor",
    "roles": [
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 1"
      },
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 2"
      }
    ]
  },
  {
    "id": "b8e31be4-300f-455e-894b-6f079abca0a2",
    "name": "$Camera.AppName",
    "typeId": 1,
    "readableType": "Entity Extractor",
    "customPrebuiltDomainName": "Camera",
    "customPrebuiltModelName": "AppName",
    "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.
EntityRole

Entity extractor role
ErrorResponse

Error response when invoking an operation on the API.
NDepthEntityExtractor

N-Depth Entity Extractor.
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.

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

NDepthEntityExtractor

Object

N-Depth Entity Extractor.

Name Type Description
children

ChildEntity[]

The base child entity type.
customPrebuiltDomainName

string

The domain name.
customPrebuiltModelName

string

The intent name or entity name.
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.

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