Versions Interface

Package:

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

public interface Versions

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

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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.
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.
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.
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.
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.
Observable<String>	importLuFormatAsync(UUID appId, String luisAppLu, ImportLuFormatVersionsOptionalParameter importLuFormatOptionalParameter) Imports a new version into a LUIS application.
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.
Observable<String>	importMethodAsync(UUID appId, LuisApp luisApp, ImportMethodVersionsOptionalParameter importMethodOptionalParameter) Imports a new version into a LUIS application.
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.
Observable<String>	importV2AppAsync(UUID appId, LuisAppV2 luisAppV2, ImportV2AppVersionsOptionalParameter importV2AppOptionalParameter) Imports a new version into a LUIS application.
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.
Observable<List<VersionInfo>>	listAsync(UUID appId, ListVersionsOptionalParameter listOptionalParameter) Gets a list of versions for this application ID.
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.
Observable<OperationStatus>	updateAsync(UUID appId, String versionId, UpdateVersionsOptionalParameter updateOptionalParameter) Updates the name or description of the application version.

Method Details

clone

public VersionsCloneDefinitionStages.WithAppId clone()

Creates a new version from the selected version.

Returns:

the first stage of the clone call

clone

public 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

public Observable 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

delete

public 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

public Observable 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

deleteUnlabelledUtterance

public 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

public Observable 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

export

public 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

public Observable 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

exportLuFormat

public 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

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

exportLuFormatAsync

public Observable 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

get

public 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

public Observable 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

importLuFormat

public VersionsImportLuFormatDefinitionStages.WithAppId importLuFormat()

Imports a new version into a LUIS application.

Returns:

the first stage of the importLuFormat call

importLuFormat

public 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

public Observable 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

importMethod

public VersionsImportMethodDefinitionStages.WithAppId importMethod()

Imports a new version into a LUIS application.

Returns:

the first stage of the importMethod call

importMethod

public 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

public Observable 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

importV2App

public VersionsImportV2AppDefinitionStages.WithAppId importV2App()

Imports a new version into a LUIS application.

Returns:

the first stage of the importV2App call

importV2App

public 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

public Observable 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

list

public VersionsListDefinitionStages.WithAppId list()

Gets a list of versions for this application ID.

Returns:

the first stage of the list call

list

public List 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

public Observable> 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

update

public VersionsUpdateDefinitionStages.WithAppId update()

Updates the name or description of the application version.

Returns:

the first stage of the update call

update

public 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

public Observable 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