Apps - Get Publish Settings

Service:

Azure AI Services

API Version:

2.0

Get the application publish settings including 'UseAllTrainingData'.

GET {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

Responses

Name	Type	Description
200 OK	PublishSettings	The application publish settings.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Publish Settings request

Sample request

HTTP

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

Sample response

Status code:

200

{
  "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74",
  "sentimentAnalysis": true,
  "speech": true,
  "spellChecker": true
}

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
PublishSettings	The application publish settings.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

PublishSettings

The application publish settings.

Name	Type	Description
id	string	The application ID.
sentimentAnalysis	boolean	Setting sentiment analysis as true returns the sentiment of the input utterance along with the response
speech	boolean	Enables speech priming in your app
spellChecker	boolean	Enables spell checking of the utterance.