Features Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.language.luis.authoring

public interface Features

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

Method Summary

Modifier and Type Method and 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.
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.
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.
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.
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.
Observable<PhraseListFeatureInfo> getPhraseListAsync(UUID appId, String versionId, int phraselistId)

Gets phraselist feature info in a version of the application.
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.
Observable<FeaturesResponseObject> listAsync(UUID appId, String versionId, ListFeaturesOptionalParameter listOptionalParameter)

Gets all the extraction phraselist and pattern features in a version of the application.
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.
Observable<List<PhraseListFeatureInfo>> listPhraseListsAsync(UUID appId, String versionId, ListPhraseListsOptionalParameter listPhraseListsOptionalParameter)

Gets all the phraselist features in a version of the application.
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.
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 Details

addEntityFeature

public 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

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

addIntentFeature

public 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

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

addPhraseList

public 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

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

deletePhraseList

public 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

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

getPhraseList

public 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

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

list

public 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

list

public 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

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

listPhraseLists

public FeaturesListPhraseListsDefinitionStages.WithAppId listPhraseLists()

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

Returns:

the first stage of the listPhraseLists call

listPhraseLists

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

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

updatePhraseList

public 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

updatePhraseList

public 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

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

Applies to