Features - Update Phrase List

Updates the phrases, the state and the name of the phraselist feature in a version of the application.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}

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).

phraselistId
path True

integer

The ID of the feature to be updated.

versionId
path True

string

The version ID.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
isActive

boolean

Indicates if the Phraselist 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 Phraselist name.

phrases

string

List of comma-separated phrases that represent the Phraselist.

Responses

Name Type Description
200 OK

OperationStatus

Successfully updated phraselist.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Phraselist Feature Info request

Sample request

PUT {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/phraselists/178384


{
  "name": "DaysOfWeek",
  "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday",
  "isActive": false,
  "isExchangeable": true
}

Sample response

{
  "code": "Success",
  "message": "Operation Successful"
}

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.

OperationStatus

Response of an Operation status.

OperationStatusType

Status Code.

PhraselistUpdateObject

Object model for updating a Phraselist.

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

OperationStatus

Response of an Operation status.

Name Type Description
code

OperationStatusType

Status Code.

message

string

Status details.

OperationStatusType

Status Code.

Name Type Description
FAILED

string

Failed

string

Success

string

PhraselistUpdateObject

Object model for updating a Phraselist.

Name Type Default value Description
isActive

boolean

True

Indicates if the Phraselist is enabled.

isExchangeable

boolean

True

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 Phraselist name.

phrases

string

List of comma-separated phrases that represent the Phraselist.