Model - Get Prebuilt

Gets information about a prebuilt entity model in a version of the application.

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}

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).

prebuiltId
path True

string

uuid

The prebuilt entity extractor ID.

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

PrebuiltEntityExtractor

A prebuilt entity models info.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Prebuilt Info request

Sample request

GET {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/a065c863-918e-4c56-a267-9aaae3c7dced

Sample response

{
  "id": "a065c863-918e-4c56-a267-9aaae3c7dced",
  "name": "datetimeV2",
  "typeId": 2,
  "readableType": "Prebuilt Entity Extractor",
  "roles": [
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 1"
    },
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 2"
    }
  ]
}

Definitions

Name Description
EntityRole

Entity extractor role

ErrorResponse

Error response when invoking an operation on the API.

PrebuiltEntityExtractor

Prebuilt Entity Extractor.

ReadableType

Full name of the entity type.

EntityRole

Entity extractor role

Name Type Description
id

string

The entity role ID.

name

string

The entity role name.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

PrebuiltEntityExtractor

Prebuilt Entity Extractor.

Name Type Description
id

string

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

Full name of the entity type.

Name Type Description
Closed List Entity Extractor

string

Composite Entity Extractor

string

Entity Extractor

string

Hierarchical Child Entity Extractor

string

Hierarchical Entity Extractor

string

Intent Classifier

string

List Entity Extractor

string

Pattern.Any Entity Extractor

string

Prebuilt Entity Extractor

string

Regex Entity Extractor

string