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

Interface Features

All Known Implementing Classes:

FeaturesImpl

public interface Features

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Features.FeaturesListDefinition	The entirety of list definition.
static interface	Features.FeaturesListDefinitionStages	Grouping of list definition stages.
static interface	Features.FeaturesListPhraseListsDefinition	The entirety of listPhraseLists definition.
static interface	Features.FeaturesListPhraseListsDefinitionStages	Grouping of listPhraseLists definition stages.
static interface	Features.FeaturesUpdatePhraseListDefinition	The entirety of updatePhraseList definition.
static interface	Features.FeaturesUpdatePhraseListDefinitionStages	Grouping of updatePhraseList definition stages.

Method Summary

Modifier and Type	Method	Description
OperationStatus	addEntityFeature(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationCreateObject)	Adds a new feature relation to be used by the entity in a version of the application.
rx.Observable<OperationStatus>	addEntityFeatureAsync(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationCreateObject)	Adds a new feature relation to be used by the entity in a version of the application.
OperationStatus	addIntentFeature(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationCreateObject)	Adds a new feature relation to be used by the intent in a version of the application.
rx.Observable<OperationStatus>	addIntentFeatureAsync(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationCreateObject)	Adds a new feature relation to be used by the intent in a version of the application.
int	addPhraseList(UUID appId, String versionId, PhraselistCreateObject phraselistCreateObject)	Creates a new phraselist feature in a version of the application.
rx.Observable<Integer>	addPhraseListAsync(UUID appId, String versionId, PhraselistCreateObject phraselistCreateObject)	Creates a new phraselist feature in a version of the application.
OperationStatus	deletePhraseList(UUID appId, String versionId, int phraselistId)	Deletes a phraselist feature from a version of the application.
rx.Observable<OperationStatus>	deletePhraseListAsync(UUID appId, String versionId, int phraselistId)	Deletes a phraselist feature from a version of the application.
PhraseListFeatureInfo	getPhraseList(UUID appId, String versionId, int phraselistId)	Gets phraselist feature info in a version of the application.
rx.Observable<PhraseListFeatureInfo>	getPhraseListAsync(UUID appId, String versionId, int phraselistId)	Gets phraselist feature info in a version of the application.
Features.FeaturesListDefinitionStages.WithAppId	list()	Gets all the extraction phraselist and pattern features in a version of the application.
FeaturesResponseObject	list(UUID appId, String versionId, ListFeaturesOptionalParameter listOptionalParameter)	Gets all the extraction phraselist and pattern features in a version of the application.
rx.Observable<FeaturesResponseObject>	listAsync(UUID appId, String versionId, ListFeaturesOptionalParameter listOptionalParameter)	Gets all the extraction phraselist and pattern features in a version of the application.
Features.FeaturesListPhraseListsDefinitionStages.WithAppId	listPhraseLists()	Gets all the phraselist features in a version of the application.
List<PhraseListFeatureInfo>	listPhraseLists(UUID appId, String versionId, ListPhraseListsOptionalParameter listPhraseListsOptionalParameter)	Gets all the phraselist features in a version of the application.
rx.Observable<List<PhraseListFeatureInfo>>	listPhraseListsAsync(UUID appId, String versionId, ListPhraseListsOptionalParameter listPhraseListsOptionalParameter)	Gets all the phraselist features in a version of the application.
Features.FeaturesUpdatePhraseListDefinitionStages.WithAppId	updatePhraseList()	Updates the phrases, the state and the name of the phraselist feature in a version of the application.
OperationStatus	updatePhraseList(UUID appId, String versionId, int phraselistId, UpdatePhraseListOptionalParameter updatePhraseListOptionalParameter)	Updates the phrases, the state and the name of the phraselist feature in a version of the application.
rx.Observable<OperationStatus>	updatePhraseListAsync(UUID appId, String versionId, int phraselistId, UpdatePhraseListOptionalParameter updatePhraseListOptionalParameter)	Updates the phrases, the state and the name of the phraselist feature in a version of the application.

Method Detail

addPhraseList

int addPhraseList(UUID appId,
                  String versionId,
                  PhraselistCreateObject phraselistCreateObject)

Creates a new phraselist feature in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistCreateObject - A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.

Returns:

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

addPhraseListAsync

rx.Observable<Integer> addPhraseListAsync(UUID appId,
                                          String versionId,
                                          PhraselistCreateObject phraselistCreateObject)

Creates a new phraselist feature in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistCreateObject - A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.

Returns:

the observable to the int object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPhraseLists

List<PhraseListFeatureInfo> listPhraseLists(UUID appId,
                                            String versionId,
                                            ListPhraseListsOptionalParameter listPhraseListsOptionalParameter)

Gets all the phraselist features in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

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

listPhraseListsAsync

rx.Observable<List<PhraseListFeatureInfo>> listPhraseListsAsync(UUID appId,
                                                                String versionId,
                                                                ListPhraseListsOptionalParameter listPhraseListsOptionalParameter)

Gets all the phraselist features in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

the observable to the List<PhraseListFeatureInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPhraseLists

Features.FeaturesListPhraseListsDefinitionStages.WithAppId listPhraseLists()

Gets all the phraselist features in a version of the application.

Returns:

the first stage of the listPhraseLists call

list

FeaturesResponseObject list(UUID appId,
                            String versionId,
                            ListFeaturesOptionalParameter listOptionalParameter)

Gets all the extraction phraselist and pattern features in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

the FeaturesResponseObject 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<FeaturesResponseObject> listAsync(UUID appId,
                                                String versionId,
                                                ListFeaturesOptionalParameter listOptionalParameter)

Gets all the extraction phraselist and pattern features in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

the observable to the FeaturesResponseObject object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

Features.FeaturesListDefinitionStages.WithAppId list()

Gets all the extraction phraselist and pattern features in a version of the application.

Returns:

the first stage of the list call

getPhraseList

PhraseListFeatureInfo getPhraseList(UUID appId,
                                    String versionId,
                                    int phraselistId)

Gets phraselist feature info in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be retrieved.

Returns:

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

getPhraseListAsync

rx.Observable<PhraseListFeatureInfo> getPhraseListAsync(UUID appId,
                                                        String versionId,
                                                        int phraselistId)

Gets phraselist feature info in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be retrieved.

Returns:

the observable to the PhraseListFeatureInfo object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePhraseList

OperationStatus updatePhraseList(UUID appId,
                                 String versionId,
                                 int phraselistId,
                                 UpdatePhraseListOptionalParameter updatePhraseListOptionalParameter)

Updates the phrases, the state and the name of the phraselist feature in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be updated.

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

updatePhraseListAsync

rx.Observable<OperationStatus> updatePhraseListAsync(UUID appId,
                                                     String versionId,
                                                     int phraselistId,
                                                     UpdatePhraseListOptionalParameter updatePhraseListOptionalParameter)

Updates the phrases, the state and the name of the phraselist feature in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be updated.

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

updatePhraseList

Features.FeaturesUpdatePhraseListDefinitionStages.WithAppId updatePhraseList()

Updates the phrases, the state and the name of the phraselist feature in a version of the application.

Returns:

the first stage of the updatePhraseList call

deletePhraseList

OperationStatus deletePhraseList(UUID appId,
                                 String versionId,
                                 int phraselistId)

Deletes a phraselist feature from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be deleted.

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

deletePhraseListAsync

rx.Observable<OperationStatus> deletePhraseListAsync(UUID appId,
                                                     String versionId,
                                                     int phraselistId)

Deletes a phraselist feature from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

phraselistId - The ID of the feature to be deleted.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addIntentFeature

OperationStatus addIntentFeature(UUID appId,
                                 String versionId,
                                 UUID intentId,
                                 ModelFeatureInformation featureRelationCreateObject)

Adds a new feature relation to be used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationCreateObject - A Feature relation information object.

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

addIntentFeatureAsync

rx.Observable<OperationStatus> addIntentFeatureAsync(UUID appId,
                                                     String versionId,
                                                     UUID intentId,
                                                     ModelFeatureInformation featureRelationCreateObject)

Adds a new feature relation to be used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationCreateObject - A Feature relation information object.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addEntityFeature

OperationStatus addEntityFeature(UUID appId,
                                 String versionId,
                                 UUID entityId,
                                 ModelFeatureInformation featureRelationCreateObject)

Adds a new feature relation to be used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationCreateObject - A Feature relation information object.

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

addEntityFeatureAsync

rx.Observable<OperationStatus> addEntityFeatureAsync(UUID appId,
                                                     String versionId,
                                                     UUID entityId,
                                                     ModelFeatureInformation featureRelationCreateObject)

Adds a new feature relation to be used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationCreateObject - A Feature relation information object.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation