Apps - Update Publish Settings

Reference

Service:: Azure AI Services

API Version:: 2.0

Updates the application publish settings including 'UseAllTrainingData'.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/publishsettings

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

Request Header

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

Request Body

Name	Type	Description
sentimentAnalysis	boolean	Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response
speech	boolean	Setting speech as public enables speech priming in your app
spellChecker	boolean	Setting spell checker as public enables spell checking the input utterance.

Responses

Name	Type	Description
200 OK	OperationStatus	Successfully updated application settings.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Publish Settings request

Sample request

HTTP

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


{
  "sentimentAnalysis": true,
  "speech": true,
  "spellChecker": true
}

Sample response

Status code:: 200

{
  "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.
PublishSettingUpdateObject	Object model for updating an application's publish settings.

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

PublishSettingUpdateObject

Object model for updating an application's publish settings.

Name	Type	Description
sentimentAnalysis	boolean	Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response
speech	boolean	Setting speech as public enables speech priming in your app
spellChecker	boolean	Setting spell checker as public enables spell checking the input utterance.

Partager via