Features - List

Reference

Service:: Cognitive Services - LUIS

API Version:: 3.0-preview

Gets all the extraction phraselist and pattern features in a version of the application.

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

With optional parameters:

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/features?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	FeaturesResponseObject	A list of all phraselist features and a list of all pattern features.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Application Version Features request

Sample Request

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/features

Sample Response

Status code:: 200

{
  "phraselistFeatures": [
    {
      "id": 5341,
      "name": "Cities",
      "phrases": "Seattle,New York,Paris,Moscow,Beijin",
      "isExchangeable": true,
      "isActive": true,
      "enabledForAllModels": true
    },
    {
      "id": 74598,
      "name": "DaysOfWeek",
      "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday",
      "isExchangeable": true,
      "isActive": true,
      "enabledForAllModels": true
    }
  ],
  "patternFeatures": [
    {
      "id": 81231,
      "name": "EmailPattern",
      "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b",
      "isActive": true,
      "enabledForAllModels": true
    }
  ]
}

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
FeaturesResponseObject	Model Features, including Patterns and Phraselists.
PatternFeatureInfo	Pattern feature.
PhraseListFeatureInfo	Phraselist Feature.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

FeaturesResponseObject

Model Features, including Patterns and Phraselists.

Name	Type	Description
patternFeatures	PatternFeatureInfo[]	List of Pattern features.
phraselistFeatures	PhraseListFeatureInfo[]	List of Phraselist Features.

PatternFeatureInfo

Pattern feature.

Name	Type	Description
enabledForAllModels	boolean	Indicates if the feature is enabled for all models in the application.
id	integer	A six-digit ID used for Features.
isActive	boolean	Indicates if the feature is enabled.
name	string	The name of the Feature.
pattern	string	The Regular Expression to match.

PhraseListFeatureInfo

Phraselist Feature.

Name	Type	Description
enabledForAllModels	boolean	Indicates if the feature is enabled for all models in the application.
id	integer	A six-digit ID used for Features.
isActive	boolean	Indicates if the feature is enabled.
isExchangeable	boolean	An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.
name	string	The name of the Feature.
phrases	string	A list of comma-separated values.

Share via