Model - Get Closed List

Reference

Service:: Azure AI Services

API Version:: 3.0-preview

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

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}

URI Parameters

Name	In	Required	Type	Description
appId	path	True	string uuid	The application ID.
clEntityId	path	True	string uuid	The list model 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	ClosedListEntityExtractor	The list model info.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Closed List Entity Info request

Sample request

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/8713b104-78ec-4c4f-9f96-f2e53562cc16

Sample response

Status code:: 200

{
  "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
  "name": "States",
  "typeId": 5,
  "readableType": "Closed List Entity Extractor",
  "subLists": [
    {
      "id": 1,
      "canonicalForm": "new york",
      "list": [
        "ny",
        "new york"
      ]
    },
    {
      "id": 2,
      "canonicalForm": "washington",
      "list": [
        "washington",
        "wa"
      ]
    },
    {
      "id": 3,
      "canonicalForm": "california",
      "list": [
        "california",
        "ca",
        "calif.",
        "cal."
      ]
    }
  ],
  "roles": [
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 1"
    },
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 2"
    }
  ]
}

Definitions

Name	Description
ClosedListEntityExtractor	List Entity Extractor.
EntityRole	Entity extractor role
ErrorResponse	Error response when invoking an operation on the API.
ReadableType	Full name of the entity type.
SubClosedListResponse	Sublist of items for a list entity.

ClosedListEntityExtractor

List 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.
subLists	SubClosedListResponse[]	List of sublists.
typeId	integer	The type ID of the Entity Model.

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

ReadableType

Full name of the entity type.

Name	Type	Description
Child Entity Extractor	string
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

SubClosedListResponse

Sublist of items for a list entity.

Name	Type	Description
canonicalForm	string	The standard form that the list represents.
id	integer	The sublist ID
list	string[]	List of synonym words.

Dela via