Share via

Model - Get Prebuilt

Service:
Azure AI Services
API Version:
3.0-preview

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

GET {Endpoint}/luis/authoring/v3.0-preview/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/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/a065c863-918e-4c56-a267-9aaae3c7dced

Sample response

Status code:
200 
{
  "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

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

PrebuiltEntityExtractor

Object

Prebuilt Entity Extractor.

Name Type Description
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