Package com.microsoft.azure.cognitiveservices.language.luis.authoring

Interface Apps

  • All Known Implementing Classes:
    AppsImpl
    public interface Apps
    An instance of this class provides access to all the operations defined in Apps.

    • Method Detail

      • add

        UUID add​(ApplicationCreateObject applicationCreateObject)
        Creates a new LUIS app.
        Parameters:
        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.
        Returns:
        the UUID object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • addAsync

        rx.Observable<UUID> addAsync​(ApplicationCreateObject applicationCreateObject)
        Creates a new LUIS app.
        Parameters:
        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.
        Returns:
        the observable to the UUID object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listAsync

        rx.Observable<List<ApplicationInfoResponse>> listAsync​(ListAppsOptionalParameter listOptionalParameter)
        Lists all of the user's applications.
        Parameters:
        listOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<ApplicationInfoResponse> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • importMethod

        UUID importMethod​(LuisApp luisApp,
                  ImportMethodAppsOptionalParameter importMethodOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisApp - A LUIS application structure.
        importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the UUID object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • importMethodAsync

        rx.Observable<UUID> importMethodAsync​(LuisApp luisApp,
                                      ImportMethodAppsOptionalParameter importMethodOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisApp - A LUIS application structure.
        importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the UUID object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listCortanaEndpointsAsync

        rx.Observable<PersonalAssistantsResponse> listCortanaEndpointsAsync()
        Gets the endpoint URLs for the prebuilt Cortana applications.
        Returns:
        the observable to the PersonalAssistantsResponse object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listDomains

        List<String> listDomains()
        Gets the available application domains.
        Returns:
        the List<String> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listDomainsAsync

        rx.Observable<List<String>> listDomainsAsync()
        Gets the available application domains.
        Returns:
        the observable to the List<String> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listUsageScenarios

        List<String> listUsageScenarios()
        Gets the application available usage scenarios.
        Returns:
        the List<String> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listUsageScenariosAsync

        rx.Observable<List<String>> listUsageScenariosAsync()
        Gets the application available usage scenarios.
        Returns:
        the observable to the List<String> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listSupportedCultures

        List<AvailableCulture> listSupportedCultures()
        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.
        Returns:
        the List<AvailableCulture> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listSupportedCulturesAsync

        rx.Observable<List<AvailableCulture>> listSupportedCulturesAsync()
        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.
        Returns:
        the observable to the List<AvailableCulture> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • downloadQueryLogs

        InputStream downloadQueryLogs​(UUID appId)
        Gets the logs of the past month's endpoint queries for the application.
        Parameters:
        appId - The application ID.
        Returns:
        the InputStream object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.azure.CloudException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • downloadQueryLogsAsync

        rx.Observable<InputStream> downloadQueryLogsAsync​(UUID appId)
        Gets the logs of the past month's endpoint queries for the application.
        Parameters:
        appId - The application ID.
        Returns:
        the observable to the InputStream object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getAsync

        rx.Observable<ApplicationInfoResponse> getAsync​(UUID appId)
        Gets the application info.
        Parameters:
        appId - The application ID.
        Returns:
        the observable to the ApplicationInfoResponse object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • update

        OperationStatus update​(UUID appId,
                       ApplicationUpdateObject applicationUpdateObject)
        Updates the name or description of the application.
        Parameters:
        appId - The application ID.
        applicationUpdateObject - A model containing Name and Description of the application.
        Returns:
        the OperationStatus object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updateAsync

        rx.Observable<OperationStatus> updateAsync​(UUID appId,
                                           ApplicationUpdateObject applicationUpdateObject)
        Updates the name or description of the application.
        Parameters:
        appId - The application ID.
        applicationUpdateObject - A model containing Name and Description of the application.
        Returns:
        the observable to the OperationStatus object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • delete

        OperationStatus delete​(UUID appId,
                       DeleteAppsOptionalParameter deleteOptionalParameter)
        Deletes an application.
        Parameters:
        appId - The application ID.
        deleteOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the OperationStatus object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteAsync

        rx.Observable<OperationStatus> deleteAsync​(UUID appId,
                                           DeleteAppsOptionalParameter deleteOptionalParameter)
        Deletes an application.
        Parameters:
        appId - The application ID.
        deleteOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the OperationStatus object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • publish

        ProductionOrStagingEndpointInfo publish​(UUID appId,
                                        ApplicationPublishObject applicationPublishObject)
        Publishes a specific version of the application.
        Parameters:
        appId - The application ID.
        applicationPublishObject - The application publish object. The region is the target region that the application is published to.
        Returns:
        the ProductionOrStagingEndpointInfo object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • publishAsync

        rx.Observable<ProductionOrStagingEndpointInfo> publishAsync​(UUID appId,
                                                            ApplicationPublishObject applicationPublishObject)
        Publishes a specific version of the application.
        Parameters:
        appId - The application ID.
        applicationPublishObject - The application publish object. The region is the target region that the application is published to.
        Returns:
        the observable to the ProductionOrStagingEndpointInfo object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getSettings

        ApplicationSettings getSettings​(UUID appId)
        Get the application settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        Returns:
        the ApplicationSettings object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getSettingsAsync

        rx.Observable<ApplicationSettings> getSettingsAsync​(UUID appId)
        Get the application settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        Returns:
        the observable to the ApplicationSettings object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • updateSettings

        OperationStatus updateSettings​(UUID appId,
                               UpdateSettingsOptionalParameter updateSettingsOptionalParameter)
        Updates the application settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        updateSettingsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the OperationStatus object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updateSettingsAsync

        rx.Observable<OperationStatus> updateSettingsAsync​(UUID appId,
                                                   UpdateSettingsOptionalParameter updateSettingsOptionalParameter)
        Updates the application settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        updateSettingsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the OperationStatus object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getPublishSettings

        PublishSettings getPublishSettings​(UUID appId)
        Get the application publish settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        Returns:
        the PublishSettings object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getPublishSettingsAsync

        rx.Observable<PublishSettings> getPublishSettingsAsync​(UUID appId)
        Get the application publish settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        Returns:
        the observable to the PublishSettings object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • updatePublishSettings

        OperationStatus updatePublishSettings​(UUID appId,
                                      PublishSettingUpdateObject publishSettingUpdateObject)
        Updates the application publish settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        publishSettingUpdateObject - An object containing the new publish application settings.
        Returns:
        the OperationStatus object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updatePublishSettingsAsync

        rx.Observable<OperationStatus> updatePublishSettingsAsync​(UUID appId,
                                                          PublishSettingUpdateObject publishSettingUpdateObject)
        Updates the application publish settings including 'UseAllTrainingData'.
        Parameters:
        appId - The application ID.
        publishSettingUpdateObject - An object containing the new publish application settings.
        Returns:
        the observable to the OperationStatus object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listEndpoints

        Map<String,​String> listEndpoints​(UUID appId)
        Returns the available endpoint deployment regions and URLs.
        Parameters:
        appId - The application ID.
        Returns:
        the Map<String, String> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listEndpointsAsync

        rx.Observable<Map<String,​String>> listEndpointsAsync​(UUID appId)
        Returns the available endpoint deployment regions and URLs.
        Parameters:
        appId - The application ID.
        Returns:
        the observable to the Map<String, String> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listAvailableCustomPrebuiltDomains

        List<PrebuiltDomain> listAvailableCustomPrebuiltDomains()
        Gets all the available custom prebuilt domains for all cultures.
        Returns:
        the List<PrebuiltDomain> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listAvailableCustomPrebuiltDomainsAsync

        rx.Observable<List<PrebuiltDomain>> listAvailableCustomPrebuiltDomainsAsync()
        Gets all the available custom prebuilt domains for all cultures.
        Returns:
        the observable to the List<PrebuiltDomain> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • addCustomPrebuiltDomain

        UUID addCustomPrebuiltDomain​(PrebuiltDomainCreateObject prebuiltDomainCreateObject)
        Adds a prebuilt domain along with its intent and entity models as a new application.
        Parameters:
        prebuiltDomainCreateObject - A prebuilt domain create object containing the name and culture of the domain.
        Returns:
        the UUID object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • addCustomPrebuiltDomainAsync

        rx.Observable<UUID> addCustomPrebuiltDomainAsync​(PrebuiltDomainCreateObject prebuiltDomainCreateObject)
        Adds a prebuilt domain along with its intent and entity models as a new application.
        Parameters:
        prebuiltDomainCreateObject - A prebuilt domain create object containing the name and culture of the domain.
        Returns:
        the observable to the UUID object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listAvailableCustomPrebuiltDomainsForCulture

        List<PrebuiltDomain> listAvailableCustomPrebuiltDomainsForCulture​(String culture)
        Gets all the available prebuilt domains for a specific culture.
        Parameters:
        culture - Culture.
        Returns:
        the List<PrebuiltDomain> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • listAvailableCustomPrebuiltDomainsForCultureAsync

        rx.Observable<List<PrebuiltDomain>> listAvailableCustomPrebuiltDomainsForCultureAsync​(String culture)
        Gets all the available prebuilt domains for a specific culture.
        Parameters:
        culture - Culture.
        Returns:
        the observable to the List<PrebuiltDomain> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • packagePublishedApplicationAsGzip

        InputStream packagePublishedApplicationAsGzip​(UUID appId,
                                              String slotName)
        package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.
        Parameters:
        appId - The application ID.
        slotName - The publishing slot name.
        Returns:
        the InputStream object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • packagePublishedApplicationAsGzipAsync

        rx.Observable<InputStream> packagePublishedApplicationAsGzipAsync​(UUID appId,
                                                                  String slotName)
        package - Gets published LUIS application package in binary stream GZip format. Packages a published LUIS application as a GZip file to be used in the LUIS container.
        Parameters:
        appId - The application ID.
        slotName - The publishing slot name.
        Returns:
        the observable to the InputStream object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • packageTrainedApplicationAsGzip

        InputStream packageTrainedApplicationAsGzip​(UUID appId,
                                            String versionId)
        package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.
        Parameters:
        appId - The application ID.
        versionId - The version ID.
        Returns:
        the InputStream object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • packageTrainedApplicationAsGzipAsync

        rx.Observable<InputStream> packageTrainedApplicationAsGzipAsync​(UUID appId,
                                                                String versionId)
        package - Gets trained LUIS application package in binary stream GZip format. Packages trained LUIS application as GZip file to be used in the LUIS container.
        Parameters:
        appId - The application ID.
        versionId - The version ID.
        Returns:
        the observable to the InputStream object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • importV2App

        UUID importV2App​(LuisAppV2 luisAppV2,
                 ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisAppV2 - A LUIS application structure.
        importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the UUID object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • importV2AppAsync

        rx.Observable<UUID> importV2AppAsync​(LuisAppV2 luisAppV2,
                                     ImportV2AppAppsOptionalParameter importV2AppOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisAppV2 - A LUIS application structure.
        importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the UUID object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • importLuFormat

        UUID importLuFormat​(String luisAppLu,
                    ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisAppLu - A LUIS application structure.
        importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the UUID object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        ErrorResponseException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • importLuFormatAsync

        rx.Observable<UUID> importLuFormatAsync​(String luisAppLu,
                                        ImportLuFormatAppsOptionalParameter importLuFormatOptionalParameter)
        Imports an application to LUIS, the application's structure is included in the request body.
        Parameters:
        luisAppLu - A LUIS application structure.
        importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the UUID object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation