Features - Add Phrase List
Creates a new phraselist feature in a version of the application.
POST {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/phraselists
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
app
|
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). |
version
|
path | True |
string |
The version ID. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Request Body
Name | Type | Description |
---|---|---|
isExchangeable |
boolean |
An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. 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. Default value is true. |
name |
string |
The Phraselist name. |
phrases |
string |
List of comma-separated phrases that represent the Phraselist. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
integer |
The ID of the created feature. |
Other Status Codes |
Error Response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
Successful Create Phraselist Feature request
Sample request
POST {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/phraselists
{
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday",
"isExchangeable": true
}
Sample response
1823
Definitions
Name | Description |
---|---|
Error |
Error response when invoking an operation on the API. |
Phraselist |
Object model for creating a phraselist model. |
ErrorResponse
Error response when invoking an operation on the API.
Name | Type | Description |
---|---|---|
errorType |
string |
PhraselistCreateObject
Object model for creating a phraselist model.
Name | Type | Default value | Description |
---|---|---|---|
isExchangeable |
boolean |
True |
An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. 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. Default value is true. |
name |
string |
The Phraselist name. |
|
phrases |
string |
List of comma-separated phrases that represent the Phraselist. |