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

Interface Versions

All Known Implementing Classes:

VersionsImpl

public interface Versions

An instance of this class provides access to all the operations defined in Versions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Versions.VersionsCloneDefinition	The entirety of clone definition.
static interface	Versions.VersionsCloneDefinitionStages	Grouping of clone definition stages.
static interface	Versions.VersionsImportLuFormatDefinition	The entirety of importLuFormat definition.
static interface	Versions.VersionsImportLuFormatDefinitionStages	Grouping of importLuFormat definition stages.
static interface	Versions.VersionsImportMethodDefinition	The entirety of importMethod definition.
static interface	Versions.VersionsImportMethodDefinitionStages	Grouping of importMethod definition stages.
static interface	Versions.VersionsImportV2AppDefinition	The entirety of importV2App definition.
static interface	Versions.VersionsImportV2AppDefinitionStages	Grouping of importV2App definition stages.
static interface	Versions.VersionsListDefinition	The entirety of list definition.
static interface	Versions.VersionsListDefinitionStages	Grouping of list definition stages.
static interface	Versions.VersionsUpdateDefinition	The entirety of update definition.
static interface	Versions.VersionsUpdateDefinitionStages	Grouping of update definition stages.

Method Summary

Modifier and Type	Method	Description
Versions.VersionsCloneDefinitionStages.WithAppId	clone()	Creates a new version from the selected version.
String	clone(UUID appId, String versionId, CloneOptionalParameter cloneOptionalParameter)	Creates a new version from the selected version.
rx.Observable<String>	cloneAsync(UUID appId, String versionId, CloneOptionalParameter cloneOptionalParameter)	Creates a new version from the selected version.
OperationStatus	delete(UUID appId, String versionId)	Deletes an application version.
rx.Observable<OperationStatus>	deleteAsync(UUID appId, String versionId)	Deletes an application version.
OperationStatus	deleteUnlabelledUtterance(UUID appId, String versionId, String utterance)	Deleted an unlabelled utterance in a version of the application.
rx.Observable<OperationStatus>	deleteUnlabelledUtteranceAsync(UUID appId, String versionId, String utterance)	Deleted an unlabelled utterance in a version of the application.
LuisApp	export(UUID appId, String versionId)	Exports a LUIS application to JSON format.
rx.Observable<LuisApp>	exportAsync(UUID appId, String versionId)	Exports a LUIS application to JSON format.
InputStream	exportLuFormat(UUID appId, String versionId)	Exports a LUIS application to text format.
rx.Observable<InputStream>	exportLuFormatAsync(UUID appId, String versionId)	Exports a LUIS application to text format.
VersionInfo	get(UUID appId, String versionId)	Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.
rx.Observable<VersionInfo>	getAsync(UUID appId, String versionId)	Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.
Versions.VersionsImportLuFormatDefinitionStages.WithAppId	importLuFormat()	Imports a new version into a LUIS application.
String	importLuFormat(UUID appId, String luisAppLu, ImportLuFormatVersionsOptionalParameter importLuFormatOptionalParameter)	Imports a new version into a LUIS application.
rx.Observable<String>	importLuFormatAsync(UUID appId, String luisAppLu, ImportLuFormatVersionsOptionalParameter importLuFormatOptionalParameter)	Imports a new version into a LUIS application.
Versions.VersionsImportMethodDefinitionStages.WithAppId	importMethod()	Imports a new version into a LUIS application.
String	importMethod(UUID appId, LuisApp luisApp, ImportMethodVersionsOptionalParameter importMethodOptionalParameter)	Imports a new version into a LUIS application.
rx.Observable<String>	importMethodAsync(UUID appId, LuisApp luisApp, ImportMethodVersionsOptionalParameter importMethodOptionalParameter)	Imports a new version into a LUIS application.
Versions.VersionsImportV2AppDefinitionStages.WithAppId	importV2App()	Imports a new version into a LUIS application.
String	importV2App(UUID appId, LuisAppV2 luisAppV2, ImportV2AppVersionsOptionalParameter importV2AppOptionalParameter)	Imports a new version into a LUIS application.
rx.Observable<String>	importV2AppAsync(UUID appId, LuisAppV2 luisAppV2, ImportV2AppVersionsOptionalParameter importV2AppOptionalParameter)	Imports a new version into a LUIS application.
Versions.VersionsListDefinitionStages.WithAppId	list()	Gets a list of versions for this application ID.
List<VersionInfo>	list(UUID appId, ListVersionsOptionalParameter listOptionalParameter)	Gets a list of versions for this application ID.
rx.Observable<List<VersionInfo>>	listAsync(UUID appId, ListVersionsOptionalParameter listOptionalParameter)	Gets a list of versions for this application ID.
Versions.VersionsUpdateDefinitionStages.WithAppId	update()	Updates the name or description of the application version.
OperationStatus	update(UUID appId, String versionId, UpdateVersionsOptionalParameter updateOptionalParameter)	Updates the name or description of the application version.
rx.Observable<OperationStatus>	updateAsync(UUID appId, String versionId, UpdateVersionsOptionalParameter updateOptionalParameter)	Updates the name or description of the application version.

Method Detail

clone

String clone(UUID appId,
             String versionId,
             CloneOptionalParameter cloneOptionalParameter)

Creates a new version from the selected version.

Parameters:

appId - The application ID.

versionId - The version ID.

cloneOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the 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

cloneAsync

rx.Observable<String> cloneAsync(UUID appId,
                                 String versionId,
                                 CloneOptionalParameter cloneOptionalParameter)

Creates a new version from the selected version.

Parameters:

appId - The application ID.

versionId - The version ID.

cloneOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

clone

Versions.VersionsCloneDefinitionStages.WithAppId clone()

Creates a new version from the selected version.

Returns:

the first stage of the clone call

list

List<VersionInfo> list(UUID appId,
                       ListVersionsOptionalParameter listOptionalParameter)

Gets a list of versions for this application ID.

Parameters:

appId - The application ID.

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<VersionInfo> 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

listAsync

rx.Observable<List<VersionInfo>> listAsync(UUID appId,
                                           ListVersionsOptionalParameter listOptionalParameter)

Gets a list of versions for this application ID.

Parameters:

appId - The application ID.

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<VersionInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

Versions.VersionsListDefinitionStages.WithAppId list()

Gets a list of versions for this application ID.

Returns:

the first stage of the list call

get

VersionInfo get(UUID appId,
                String versionId)

Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the VersionInfo 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

getAsync

rx.Observable<VersionInfo> getAsync(UUID appId,
                                    String versionId)

Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the VersionInfo object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

OperationStatus update(UUID appId,
                       String versionId,
                       UpdateVersionsOptionalParameter updateOptionalParameter)

Updates the name or description of the application version.

Parameters:

appId - The application ID.

versionId - The version ID.

updateOptionalParameter - 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

updateAsync

rx.Observable<OperationStatus> updateAsync(UUID appId,
                                           String versionId,
                                           UpdateVersionsOptionalParameter updateOptionalParameter)

Updates the name or description of the application version.

Parameters:

appId - The application ID.

versionId - The version ID.

updateOptionalParameter - 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

update

Versions.VersionsUpdateDefinitionStages.WithAppId update()

Updates the name or description of the application version.

Returns:

the first stage of the update call

delete

OperationStatus delete(UUID appId,
                       String versionId)

Deletes an application version.

Parameters:

appId - The application ID.

versionId - The version ID.

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,
                                           String versionId)

Deletes an application version.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

export

LuisApp export(UUID appId,
               String versionId)

Exports a LUIS application to JSON format.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the LuisApp 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

exportAsync

rx.Observable<LuisApp> exportAsync(UUID appId,
                                   String versionId)

Exports a LUIS application to JSON format.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the LuisApp object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importMethod

String importMethod(UUID appId,
                    LuisApp luisApp,
                    ImportMethodVersionsOptionalParameter importMethodOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisApp - A LUIS application structure.

importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the 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

importMethodAsync

rx.Observable<String> importMethodAsync(UUID appId,
                                        LuisApp luisApp,
                                        ImportMethodVersionsOptionalParameter importMethodOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisApp - A LUIS application structure.

importMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importMethod

Versions.VersionsImportMethodDefinitionStages.WithAppId importMethod()

Imports a new version into a LUIS application.

Returns:

the first stage of the importMethod call

deleteUnlabelledUtterance

OperationStatus deleteUnlabelledUtterance(UUID appId,
                                          String versionId,
                                          String utterance)

Deleted an unlabelled utterance in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

utterance - The utterance text to delete.

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

deleteUnlabelledUtteranceAsync

rx.Observable<OperationStatus> deleteUnlabelledUtteranceAsync(UUID appId,
                                                              String versionId,
                                                              String utterance)

Deleted an unlabelled utterance in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

utterance - The utterance text to delete.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importV2App

String importV2App(UUID appId,
                   LuisAppV2 luisAppV2,
                   ImportV2AppVersionsOptionalParameter importV2AppOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisAppV2 - A LUIS application structure.

importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the 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

importV2AppAsync

rx.Observable<String> importV2AppAsync(UUID appId,
                                       LuisAppV2 luisAppV2,
                                       ImportV2AppVersionsOptionalParameter importV2AppOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisAppV2 - A LUIS application structure.

importV2AppOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importV2App

Versions.VersionsImportV2AppDefinitionStages.WithAppId importV2App()

Imports a new version into a LUIS application.

Returns:

the first stage of the importV2App call

importLuFormat

String importLuFormat(UUID appId,
                      String luisAppLu,
                      ImportLuFormatVersionsOptionalParameter importLuFormatOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisAppLu - An LU representing the LUIS application structure.

importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the 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

importLuFormatAsync

rx.Observable<String> importLuFormatAsync(UUID appId,
                                          String luisAppLu,
                                          ImportLuFormatVersionsOptionalParameter importLuFormatOptionalParameter)

Imports a new version into a LUIS application.

Parameters:

appId - The application ID.

luisAppLu - An LU representing the LUIS application structure.

importLuFormatOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

importLuFormat

Versions.VersionsImportLuFormatDefinitionStages.WithAppId importLuFormat()

Imports a new version into a LUIS application.

Returns:

the first stage of the importLuFormat call

exportLuFormat

InputStream exportLuFormat(UUID appId,
                           String versionId)

Exports a LUIS application to text format.

Parameters:

appId - The application ID.

versionId - The version 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

exportLuFormatAsync

rx.Observable<InputStream> exportLuFormatAsync(UUID appId,
                                               String versionId)

Exports a LUIS application to text format.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the InputStream object

Throws:

IllegalArgumentException - thrown if parameters fail the validation