Model - List Models

Reference

Service:: Azure AI Services

API Version:: 3.0-preview

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

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

With optional parameters:

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/models?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	The number of entries to skip. Default value is 0.
take	query		integer	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	ModelInfoResponse[]	A list of application model infos.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Application Version Model Infos request

Sample request

HTTP

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

Sample response

Status code:: 200

[
  {
    "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8",
    "name": "BookFlight",
    "typeId": 0,
    "readableType": "Intent Classifier"
  },
  {
    "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
    "name": "datetime",
    "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"
      }
    ]
  },
  {
    "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": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
    "name": "Location",
    "typeId": 3,
    "readableType": "Hierarchical Entity Extractor",
    "children": [
      {
        "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
        "name": "From"
      },
      {
        "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
        "name": "To"
      }
    ],
    "roles": [
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 1"
      },
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 2"
      }
    ]
  },
  {
    "id": "8285a9ee-6bc0-4409-87f4-82d539f70529",
    "name": "None",
    "typeId": 0,
    "readableType": "Intent Classifier"
  },
  {
    "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"
      }
    ]
  },
  {
    "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"
      }
    ]
  },
  {
    "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"
      }
    ]
  },
  {
    "id": "9500536f-ffec-4fab-93ad-6268abb0f73c",
    "name": "$Camera.CapturePhoto",
    "typeId": 0,
    "readableType": "Intent Classifier",
    "customPrebuiltDomainName": "Camera",
    "customPrebuiltModelName": "CapturePhoto"
  }
]

Definitions

Name	Description
ChildEntity	The base child entity type.
EntityRole	Entity extractor role
ErrorResponse	Error response when invoking an operation on the API.
ExplicitListItem	Explicit (exception) list item
ModelInfoResponse	An application model info.
ReadableType	Full name of the entity type.
SubClosedListResponse	Sublist of items for a list entity.

ChildEntity

The base child entity type.

Name	Type	Description
children	ChildEntity[]	List of children
id	string	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

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

ExplicitListItem

Explicit (exception) list item

Name	Type	Description
explicitListItem	string	The explicit list item value.
id	integer	The explicit list item ID.

ModelInfoResponse

An application model info.

Name	Type	Description
children	ChildEntity[]	List of child entities.
customPrebuiltDomainName	string	The domain name.
customPrebuiltModelName	string	The intent name or entity name.
explicitList	ExplicitListItem[]	List of explicit (exception) list items
id	string	The ID of the Entity Model.
name	string	Name of the Entity Model.
readableType	ReadableType	Full name of the entity type.
regexPattern	string	The Regular Expression entity pattern.
roles	EntityRole[]	List of Pattern.Any Entity Extractors.
subLists	SubClosedListResponse[]	List of sublists.
typeId	integer	The type ID of the Entity Model.

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