Apps class

Class representing a Apps.

Constructors

Apps(LUISAuthoringClientContext)

Create a Apps.

Methods

add(ApplicationCreateObject, RequestOptionsBase)

Creates a new LUIS app.

add(ApplicationCreateObject, RequestOptionsBase, ServiceCallback<string>)
add(ApplicationCreateObject, ServiceCallback<string>)
addCustomPrebuiltDomain(PrebuiltDomainCreateObject, RequestOptionsBase)

Adds a prebuilt domain along with its intent and entity models as a new application.

addCustomPrebuiltDomain(PrebuiltDomainCreateObject, RequestOptionsBase, ServiceCallback<string>)
addCustomPrebuiltDomain(PrebuiltDomainCreateObject, ServiceCallback<string>)
deleteMethod(string, AppsDeleteMethodOptionalParams)

Deletes an application.

deleteMethod(string, AppsDeleteMethodOptionalParams, ServiceCallback<OperationStatus>)
deleteMethod(string, ServiceCallback<OperationStatus>)
downloadQueryLogs(string, RequestOptionsBase)

Gets the logs of the past month's endpoint queries for the application.

downloadQueryLogs(string, RequestOptionsBase, ServiceCallback<void>)
downloadQueryLogs(string, ServiceCallback<void>)
get(string, RequestOptionsBase)

Gets the application info.

get(string, RequestOptionsBase, ServiceCallback<ApplicationInfoResponse>)
get(string, ServiceCallback<ApplicationInfoResponse>)
getPublishSettings(string, RequestOptionsBase)

Get the application publish settings including 'UseAllTrainingData'.

getPublishSettings(string, RequestOptionsBase, ServiceCallback<PublishSettings>)
getPublishSettings(string, ServiceCallback<PublishSettings>)
getSettings(string, RequestOptionsBase)

Get the application settings including 'UseAllTrainingData'.

getSettings(string, RequestOptionsBase, ServiceCallback<ApplicationSettings>)
getSettings(string, ServiceCallback<ApplicationSettings>)
importLuFormat(string, AppsImportLuFormatOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

importLuFormat(string, AppsImportLuFormatOptionalParams, ServiceCallback<string>)
importLuFormat(string, ServiceCallback<string>)
importMethod(LuisApp, AppsImportMethodOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

importMethod(LuisApp, AppsImportMethodOptionalParams, ServiceCallback<string>)
importMethod(LuisApp, ServiceCallback<string>)
importV2App(LuisAppV2, AppsImportV2AppOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

importV2App(LuisAppV2, AppsImportV2AppOptionalParams, ServiceCallback<string>)
importV2App(LuisAppV2, ServiceCallback<string>)
list(AppsListOptionalParams)

Lists all of the user's applications.

list(AppsListOptionalParams, ServiceCallback<ApplicationInfoResponse[]>)
list(ServiceCallback<ApplicationInfoResponse[]>)
listAvailableCustomPrebuiltDomains(RequestOptionsBase)

Gets all the available custom prebuilt domains for all cultures.

listAvailableCustomPrebuiltDomains(RequestOptionsBase, ServiceCallback<PrebuiltDomain[]>)
listAvailableCustomPrebuiltDomains(ServiceCallback<PrebuiltDomain[]>)
listAvailableCustomPrebuiltDomainsForCulture(string, RequestOptionsBase)

Gets all the available prebuilt domains for a specific culture.

listAvailableCustomPrebuiltDomainsForCulture(string, RequestOptionsBase, ServiceCallback<PrebuiltDomain[]>)
listAvailableCustomPrebuiltDomainsForCulture(string, ServiceCallback<PrebuiltDomain[]>)
listCortanaEndpoints(RequestOptionsBase)

Gets the endpoint URLs for the prebuilt Cortana applications.

listCortanaEndpoints(RequestOptionsBase, ServiceCallback<PersonalAssistantsResponse>)
listCortanaEndpoints(ServiceCallback<PersonalAssistantsResponse>)
listDomains(RequestOptionsBase)

Gets the available application domains.

listDomains(RequestOptionsBase, ServiceCallback<string[]>)
listDomains(ServiceCallback<string[]>)
listEndpoints(string, RequestOptionsBase)

Returns the available endpoint deployment regions and URLs.

listEndpoints(string, RequestOptionsBase, ServiceCallback<{[propertyName: string]: string}>)
listEndpoints(string, ServiceCallback<{[propertyName: string]: string}>)
listSupportedCultures(RequestOptionsBase)

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.

listSupportedCultures(RequestOptionsBase, ServiceCallback<AvailableCulture[]>)
listSupportedCultures(ServiceCallback<AvailableCulture[]>)
listUsageScenarios(RequestOptionsBase)

Gets the application available usage scenarios.

listUsageScenarios(RequestOptionsBase, ServiceCallback<string[]>)
listUsageScenarios(ServiceCallback<string[]>)
packagePublishedApplicationAsGzip(string, string, RequestOptionsBase)

Packages a published LUIS application as a GZip file to be used in the LUIS container.

packagePublishedApplicationAsGzip(string, string, RequestOptionsBase, ServiceCallback<void>)
packagePublishedApplicationAsGzip(string, string, ServiceCallback<void>)
packageTrainedApplicationAsGzip(string, string, RequestOptionsBase)

Packages trained LUIS application as GZip file to be used in the LUIS container.

packageTrainedApplicationAsGzip(string, string, RequestOptionsBase, ServiceCallback<void>)
packageTrainedApplicationAsGzip(string, string, ServiceCallback<void>)
publish(string, ApplicationPublishObject, RequestOptionsBase)

Publishes a specific version of the application.

publish(string, ApplicationPublishObject, RequestOptionsBase, ServiceCallback<ProductionOrStagingEndpointInfo>)
publish(string, ApplicationPublishObject, ServiceCallback<ProductionOrStagingEndpointInfo>)
update(string, ApplicationUpdateObject, RequestOptionsBase)

Updates the name or description of the application.

update(string, ApplicationUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)
update(string, ApplicationUpdateObject, ServiceCallback<OperationStatus>)
updatePublishSettings(string, PublishSettingUpdateObject, RequestOptionsBase)

Updates the application publish settings including 'UseAllTrainingData'.

updatePublishSettings(string, PublishSettingUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)
updatePublishSettings(string, PublishSettingUpdateObject, ServiceCallback<OperationStatus>)
updateSettings(string, ApplicationSettingUpdateObject, RequestOptionsBase)

Updates the application settings including 'UseAllTrainingData'.

updateSettings(string, ApplicationSettingUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)
updateSettings(string, ApplicationSettingUpdateObject, ServiceCallback<OperationStatus>)

Constructor Details

Apps(LUISAuthoringClientContext)

Create a Apps.

new Apps(client: LUISAuthoringClientContext)

Parameters

client
LUISAuthoringClientContext

Reference to the service client.

Method Details

add(ApplicationCreateObject, RequestOptionsBase)

Creates a new LUIS app.

function add(applicationCreateObject: ApplicationCreateObject, options?: RequestOptionsBase): Promise<AppsAddResponse>

Parameters

applicationCreateObject
ApplicationCreateObject

An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is "0.1". Note: the culture cannot be changed after the app is created.

options
RequestOptionsBase

The optional parameters

Returns

Promise<AppsAddResponse>

Promise<Models.AppsAddResponse>

add(ApplicationCreateObject, RequestOptionsBase, ServiceCallback<string>)

function add(applicationCreateObject: ApplicationCreateObject, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

applicationCreateObject
ApplicationCreateObject

An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is "0.1". Note: the culture cannot be changed after the app is created.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

add(ApplicationCreateObject, ServiceCallback<string>)

function add(applicationCreateObject: ApplicationCreateObject, callback: ServiceCallback<string>)

Parameters

applicationCreateObject
ApplicationCreateObject

An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is "0.1". Note: the culture cannot be changed after the app is created.

callback

ServiceCallback<string>

The callback

addCustomPrebuiltDomain(PrebuiltDomainCreateObject, RequestOptionsBase)

Adds a prebuilt domain along with its intent and entity models as a new application.

function addCustomPrebuiltDomain(prebuiltDomainCreateObject: PrebuiltDomainCreateObject, options?: RequestOptionsBase): Promise<AppsAddCustomPrebuiltDomainResponse>

Parameters

prebuiltDomainCreateObject
PrebuiltDomainCreateObject

A prebuilt domain create object containing the name and culture of the domain.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsAddCustomPrebuiltDomainResponse>

addCustomPrebuiltDomain(PrebuiltDomainCreateObject, RequestOptionsBase, ServiceCallback<string>)

function addCustomPrebuiltDomain(prebuiltDomainCreateObject: PrebuiltDomainCreateObject, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

prebuiltDomainCreateObject
PrebuiltDomainCreateObject

A prebuilt domain create object containing the name and culture of the domain.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

addCustomPrebuiltDomain(PrebuiltDomainCreateObject, ServiceCallback<string>)

function addCustomPrebuiltDomain(prebuiltDomainCreateObject: PrebuiltDomainCreateObject, callback: ServiceCallback<string>)

Parameters

prebuiltDomainCreateObject
PrebuiltDomainCreateObject

A prebuilt domain create object containing the name and culture of the domain.

callback

ServiceCallback<string>

The callback

deleteMethod(string, AppsDeleteMethodOptionalParams)

Deletes an application.

function deleteMethod(appId: string, options?: AppsDeleteMethodOptionalParams): Promise<AppsDeleteMethodResponse>

Parameters

appId

string

The application ID.

options
AppsDeleteMethodOptionalParams

The optional parameters

Returns

Promise<Models.AppsDeleteMethodResponse>

deleteMethod(string, AppsDeleteMethodOptionalParams, ServiceCallback<OperationStatus>)

function deleteMethod(appId: string, options: AppsDeleteMethodOptionalParams, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

options
AppsDeleteMethodOptionalParams

The optional parameters

callback

ServiceCallback<OperationStatus>

The callback

deleteMethod(string, ServiceCallback<OperationStatus>)

function deleteMethod(appId: string, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<OperationStatus>

The callback

downloadQueryLogs(string, RequestOptionsBase)

Gets the logs of the past month's endpoint queries for the application.

function downloadQueryLogs(appId: string, options?: RequestOptionsBase): Promise<AppsDownloadQueryLogsResponse>

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsDownloadQueryLogsResponse>

downloadQueryLogs(string, RequestOptionsBase, ServiceCallback<void>)

function downloadQueryLogs(appId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

downloadQueryLogs(string, ServiceCallback<void>)

function downloadQueryLogs(appId: string, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<void>

The callback

get(string, RequestOptionsBase)

Gets the application info.

function get(appId: string, options?: RequestOptionsBase): Promise<AppsGetResponse>

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<AppsGetResponse>

Promise<Models.AppsGetResponse>

get(string, RequestOptionsBase, ServiceCallback<ApplicationInfoResponse>)

function get(appId: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationInfoResponse>)

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<ApplicationInfoResponse>

The callback

get(string, ServiceCallback<ApplicationInfoResponse>)

function get(appId: string, callback: ServiceCallback<ApplicationInfoResponse>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<ApplicationInfoResponse>

The callback

getPublishSettings(string, RequestOptionsBase)

Get the application publish settings including 'UseAllTrainingData'.

function getPublishSettings(appId: string, options?: RequestOptionsBase): Promise<AppsGetPublishSettingsResponse>

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsGetPublishSettingsResponse>

getPublishSettings(string, RequestOptionsBase, ServiceCallback<PublishSettings>)

function getPublishSettings(appId: string, options: RequestOptionsBase, callback: ServiceCallback<PublishSettings>)

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<PublishSettings>

The callback

getPublishSettings(string, ServiceCallback<PublishSettings>)

function getPublishSettings(appId: string, callback: ServiceCallback<PublishSettings>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<PublishSettings>

The callback

getSettings(string, RequestOptionsBase)

Get the application settings including 'UseAllTrainingData'.

function getSettings(appId: string, options?: RequestOptionsBase): Promise<AppsGetSettingsResponse>

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsGetSettingsResponse>

getSettings(string, RequestOptionsBase, ServiceCallback<ApplicationSettings>)

function getSettings(appId: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationSettings>)

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<ApplicationSettings>

The callback

getSettings(string, ServiceCallback<ApplicationSettings>)

function getSettings(appId: string, callback: ServiceCallback<ApplicationSettings>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<ApplicationSettings>

The callback

importLuFormat(string, AppsImportLuFormatOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

function importLuFormat(luisAppLu: string, options?: AppsImportLuFormatOptionalParams): Promise<AppsImportLuFormatResponse>

Parameters

luisAppLu

string

A LUIS application structure.

options
AppsImportLuFormatOptionalParams

The optional parameters

Returns

Promise<Models.AppsImportLuFormatResponse>

importLuFormat(string, AppsImportLuFormatOptionalParams, ServiceCallback<string>)

function importLuFormat(luisAppLu: string, options: AppsImportLuFormatOptionalParams, callback: ServiceCallback<string>)

Parameters

luisAppLu

string

A LUIS application structure.

options
AppsImportLuFormatOptionalParams

The optional parameters

callback

ServiceCallback<string>

The callback

importLuFormat(string, ServiceCallback<string>)

function importLuFormat(luisAppLu: string, callback: ServiceCallback<string>)

Parameters

luisAppLu

string

A LUIS application structure.

callback

ServiceCallback<string>

The callback

importMethod(LuisApp, AppsImportMethodOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

function importMethod(luisApp: LuisApp, options?: AppsImportMethodOptionalParams): Promise<AppsImportMethodResponse>

Parameters

luisApp
LuisApp

A LUIS application structure.

options
AppsImportMethodOptionalParams

The optional parameters

Returns

Promise<Models.AppsImportMethodResponse>

importMethod(LuisApp, AppsImportMethodOptionalParams, ServiceCallback<string>)

function importMethod(luisApp: LuisApp, options: AppsImportMethodOptionalParams, callback: ServiceCallback<string>)

Parameters

luisApp
LuisApp

A LUIS application structure.

options
AppsImportMethodOptionalParams

The optional parameters

callback

ServiceCallback<string>

The callback

importMethod(LuisApp, ServiceCallback<string>)

function importMethod(luisApp: LuisApp, callback: ServiceCallback<string>)

Parameters

luisApp
LuisApp

A LUIS application structure.

callback

ServiceCallback<string>

The callback

importV2App(LuisAppV2, AppsImportV2AppOptionalParams)

Imports an application to LUIS, the application's structure is included in the request body.

function importV2App(luisAppV2: LuisAppV2, options?: AppsImportV2AppOptionalParams): Promise<AppsImportV2AppResponse>

Parameters

luisAppV2
LuisAppV2

A LUIS application structure.

options
AppsImportV2AppOptionalParams

The optional parameters

Returns

Promise<Models.AppsImportV2AppResponse>

importV2App(LuisAppV2, AppsImportV2AppOptionalParams, ServiceCallback<string>)

function importV2App(luisAppV2: LuisAppV2, options: AppsImportV2AppOptionalParams, callback: ServiceCallback<string>)

Parameters

luisAppV2
LuisAppV2

A LUIS application structure.

options
AppsImportV2AppOptionalParams

The optional parameters

callback

ServiceCallback<string>

The callback

importV2App(LuisAppV2, ServiceCallback<string>)

function importV2App(luisAppV2: LuisAppV2, callback: ServiceCallback<string>)

Parameters

luisAppV2
LuisAppV2

A LUIS application structure.

callback

ServiceCallback<string>

The callback

list(AppsListOptionalParams)

Lists all of the user's applications.

function list(options?: AppsListOptionalParams): Promise<AppsListResponse>

Parameters

options
AppsListOptionalParams

The optional parameters

Returns

Promise<AppsListResponse>

Promise<Models.AppsListResponse>

list(AppsListOptionalParams, ServiceCallback<ApplicationInfoResponse[]>)

function list(options: AppsListOptionalParams, callback: ServiceCallback<ApplicationInfoResponse[]>)

Parameters

options
AppsListOptionalParams

The optional parameters

callback

ServiceCallback<ApplicationInfoResponse[]>

The callback

list(ServiceCallback<ApplicationInfoResponse[]>)

function list(callback: ServiceCallback<ApplicationInfoResponse[]>)

Parameters

callback

ServiceCallback<ApplicationInfoResponse[]>

The callback

listAvailableCustomPrebuiltDomains(RequestOptionsBase)

Gets all the available custom prebuilt domains for all cultures.

function listAvailableCustomPrebuiltDomains(options?: RequestOptionsBase): Promise<AppsListAvailableCustomPrebuiltDomainsResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListAvailableCustomPrebuiltDomainsResponse>

listAvailableCustomPrebuiltDomains(RequestOptionsBase, ServiceCallback<PrebuiltDomain[]>)

function listAvailableCustomPrebuiltDomains(options: RequestOptionsBase, callback: ServiceCallback<PrebuiltDomain[]>)

Parameters

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<PrebuiltDomain[]>

The callback

listAvailableCustomPrebuiltDomains(ServiceCallback<PrebuiltDomain[]>)

function listAvailableCustomPrebuiltDomains(callback: ServiceCallback<PrebuiltDomain[]>)

Parameters

callback

ServiceCallback<PrebuiltDomain[]>

The callback

listAvailableCustomPrebuiltDomainsForCulture(string, RequestOptionsBase)

Gets all the available prebuilt domains for a specific culture.

function listAvailableCustomPrebuiltDomainsForCulture(culture: string, options?: RequestOptionsBase): Promise<AppsListAvailableCustomPrebuiltDomainsForCultureResponse>

Parameters

culture

string

Culture.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListAvailableCustomPrebuiltDomainsForCultureResponse>

listAvailableCustomPrebuiltDomainsForCulture(string, RequestOptionsBase, ServiceCallback<PrebuiltDomain[]>)

function listAvailableCustomPrebuiltDomainsForCulture(culture: string, options: RequestOptionsBase, callback: ServiceCallback<PrebuiltDomain[]>)

Parameters

culture

string

Culture.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<PrebuiltDomain[]>

The callback

listAvailableCustomPrebuiltDomainsForCulture(string, ServiceCallback<PrebuiltDomain[]>)

function listAvailableCustomPrebuiltDomainsForCulture(culture: string, callback: ServiceCallback<PrebuiltDomain[]>)

Parameters

culture

string

Culture.

callback

ServiceCallback<PrebuiltDomain[]>

The callback

listCortanaEndpoints(RequestOptionsBase)

Gets the endpoint URLs for the prebuilt Cortana applications.

function listCortanaEndpoints(options?: RequestOptionsBase): Promise<AppsListCortanaEndpointsResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListCortanaEndpointsResponse>

listCortanaEndpoints(RequestOptionsBase, ServiceCallback<PersonalAssistantsResponse>)

function listCortanaEndpoints(options: RequestOptionsBase, callback: ServiceCallback<PersonalAssistantsResponse>)

Parameters

options
RequestOptionsBase

The optional parameters

listCortanaEndpoints(ServiceCallback<PersonalAssistantsResponse>)

function listCortanaEndpoints(callback: ServiceCallback<PersonalAssistantsResponse>)

Parameters

listDomains(RequestOptionsBase)

Gets the available application domains.

function listDomains(options?: RequestOptionsBase): Promise<AppsListDomainsResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListDomainsResponse>

listDomains(RequestOptionsBase, ServiceCallback<string[]>)

function listDomains(options: RequestOptionsBase, callback: ServiceCallback<string[]>)

Parameters

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string[]>

The callback

listDomains(ServiceCallback<string[]>)

function listDomains(callback: ServiceCallback<string[]>)

Parameters

callback

ServiceCallback<string[]>

The callback

listEndpoints(string, RequestOptionsBase)

Returns the available endpoint deployment regions and URLs.

function listEndpoints(appId: string, options?: RequestOptionsBase): Promise<AppsListEndpointsResponse>

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListEndpointsResponse>

listEndpoints(string, RequestOptionsBase, ServiceCallback<{[propertyName: string]: string}>)

function listEndpoints(appId: string, options: RequestOptionsBase, callback: ServiceCallback<{[propertyName: string]: string}>)

Parameters

appId

string

The application ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<{[propertyName: string]: string}>

The callback

listEndpoints(string, ServiceCallback<{[propertyName: string]: string}>)

function listEndpoints(appId: string, callback: ServiceCallback<{[propertyName: string]: string}>)

Parameters

appId

string

The application ID.

callback

ServiceCallback<{[propertyName: string]: string}>

The callback

listSupportedCultures(RequestOptionsBase)

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,"en-us" represents the U.S. variation of English.

function listSupportedCultures(options?: RequestOptionsBase): Promise<AppsListSupportedCulturesResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListSupportedCulturesResponse>

listSupportedCultures(RequestOptionsBase, ServiceCallback<AvailableCulture[]>)

function listSupportedCultures(options: RequestOptionsBase, callback: ServiceCallback<AvailableCulture[]>)

Parameters

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<AvailableCulture[]>

The callback

listSupportedCultures(ServiceCallback<AvailableCulture[]>)

function listSupportedCultures(callback: ServiceCallback<AvailableCulture[]>)

Parameters

callback

ServiceCallback<AvailableCulture[]>

The callback

listUsageScenarios(RequestOptionsBase)

Gets the application available usage scenarios.

function listUsageScenarios(options?: RequestOptionsBase): Promise<AppsListUsageScenariosResponse>

Parameters

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsListUsageScenariosResponse>

listUsageScenarios(RequestOptionsBase, ServiceCallback<string[]>)

function listUsageScenarios(options: RequestOptionsBase, callback: ServiceCallback<string[]>)

Parameters

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string[]>

The callback

listUsageScenarios(ServiceCallback<string[]>)

function listUsageScenarios(callback: ServiceCallback<string[]>)

Parameters

callback

ServiceCallback<string[]>

The callback

packagePublishedApplicationAsGzip(string, string, RequestOptionsBase)

Packages a published LUIS application as a GZip file to be used in the LUIS container.

function packagePublishedApplicationAsGzip(appId: string, slotName: string, options?: RequestOptionsBase): Promise<AppsPackagePublishedApplicationAsGzipResponse>

Parameters

appId

string

The application ID.

slotName

string

The publishing slot name.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsPackagePublishedApplicationAsGzipResponse>

packagePublishedApplicationAsGzip(string, string, RequestOptionsBase, ServiceCallback<void>)

function packagePublishedApplicationAsGzip(appId: string, slotName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

slotName

string

The publishing slot name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

packagePublishedApplicationAsGzip(string, string, ServiceCallback<void>)

function packagePublishedApplicationAsGzip(appId: string, slotName: string, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

slotName

string

The publishing slot name.

callback

ServiceCallback<void>

The callback

packageTrainedApplicationAsGzip(string, string, RequestOptionsBase)

Packages trained LUIS application as GZip file to be used in the LUIS container.

function packageTrainedApplicationAsGzip(appId: string, versionId: string, options?: RequestOptionsBase): Promise<AppsPackageTrainedApplicationAsGzipResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsPackageTrainedApplicationAsGzipResponse>

packageTrainedApplicationAsGzip(string, string, RequestOptionsBase, ServiceCallback<void>)

function packageTrainedApplicationAsGzip(appId: string, versionId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

packageTrainedApplicationAsGzip(string, string, ServiceCallback<void>)

function packageTrainedApplicationAsGzip(appId: string, versionId: string, callback: ServiceCallback<void>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

callback

ServiceCallback<void>

The callback

publish(string, ApplicationPublishObject, RequestOptionsBase)

Publishes a specific version of the application.

function publish(appId: string, applicationPublishObject: ApplicationPublishObject, options?: RequestOptionsBase): Promise<AppsPublishResponse>

Parameters

appId

string

The application ID.

applicationPublishObject
ApplicationPublishObject

The application publish object. The region is the target region that the application is published to.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsPublishResponse>

publish(string, ApplicationPublishObject, RequestOptionsBase, ServiceCallback<ProductionOrStagingEndpointInfo>)

function publish(appId: string, applicationPublishObject: ApplicationPublishObject, options: RequestOptionsBase, callback: ServiceCallback<ProductionOrStagingEndpointInfo>)

Parameters

appId

string

The application ID.

applicationPublishObject
ApplicationPublishObject

The application publish object. The region is the target region that the application is published to.

options
RequestOptionsBase

The optional parameters

publish(string, ApplicationPublishObject, ServiceCallback<ProductionOrStagingEndpointInfo>)

function publish(appId: string, applicationPublishObject: ApplicationPublishObject, callback: ServiceCallback<ProductionOrStagingEndpointInfo>)

Parameters

appId

string

The application ID.

applicationPublishObject
ApplicationPublishObject

The application publish object. The region is the target region that the application is published to.

update(string, ApplicationUpdateObject, RequestOptionsBase)

Updates the name or description of the application.

function update(appId: string, applicationUpdateObject: ApplicationUpdateObject, options?: RequestOptionsBase): Promise<AppsUpdateResponse>

Parameters

appId

string

The application ID.

applicationUpdateObject
ApplicationUpdateObject

A model containing Name and Description of the application.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsUpdateResponse>

update(string, ApplicationUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)

function update(appId: string, applicationUpdateObject: ApplicationUpdateObject, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

applicationUpdateObject
ApplicationUpdateObject

A model containing Name and Description of the application.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<OperationStatus>

The callback

update(string, ApplicationUpdateObject, ServiceCallback<OperationStatus>)

function update(appId: string, applicationUpdateObject: ApplicationUpdateObject, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

applicationUpdateObject
ApplicationUpdateObject

A model containing Name and Description of the application.

callback

ServiceCallback<OperationStatus>

The callback

updatePublishSettings(string, PublishSettingUpdateObject, RequestOptionsBase)

Updates the application publish settings including 'UseAllTrainingData'.

function updatePublishSettings(appId: string, publishSettingUpdateObject: PublishSettingUpdateObject, options?: RequestOptionsBase): Promise<AppsUpdatePublishSettingsResponse>

Parameters

appId

string

The application ID.

publishSettingUpdateObject
PublishSettingUpdateObject

An object containing the new publish application settings.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsUpdatePublishSettingsResponse>

updatePublishSettings(string, PublishSettingUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)

function updatePublishSettings(appId: string, publishSettingUpdateObject: PublishSettingUpdateObject, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

publishSettingUpdateObject
PublishSettingUpdateObject

An object containing the new publish application settings.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<OperationStatus>

The callback

updatePublishSettings(string, PublishSettingUpdateObject, ServiceCallback<OperationStatus>)

function updatePublishSettings(appId: string, publishSettingUpdateObject: PublishSettingUpdateObject, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

publishSettingUpdateObject
PublishSettingUpdateObject

An object containing the new publish application settings.

callback

ServiceCallback<OperationStatus>

The callback

updateSettings(string, ApplicationSettingUpdateObject, RequestOptionsBase)

Updates the application settings including 'UseAllTrainingData'.

function updateSettings(appId: string, applicationSettingUpdateObject: ApplicationSettingUpdateObject, options?: RequestOptionsBase): Promise<AppsUpdateSettingsResponse>

Parameters

appId

string

The application ID.

applicationSettingUpdateObject
ApplicationSettingUpdateObject

An object containing the new application settings.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.AppsUpdateSettingsResponse>

updateSettings(string, ApplicationSettingUpdateObject, RequestOptionsBase, ServiceCallback<OperationStatus>)

function updateSettings(appId: string, applicationSettingUpdateObject: ApplicationSettingUpdateObject, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

applicationSettingUpdateObject
ApplicationSettingUpdateObject

An object containing the new application settings.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<OperationStatus>

The callback

updateSettings(string, ApplicationSettingUpdateObject, ServiceCallback<OperationStatus>)

function updateSettings(appId: string, applicationSettingUpdateObject: ApplicationSettingUpdateObject, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

applicationSettingUpdateObject
ApplicationSettingUpdateObject

An object containing the new application settings.

callback

ServiceCallback<OperationStatus>

The callback