Patterns Interface

Package:

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

public interface Patterns

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

Method Summary

Modifier and Type	Method and Description
PatternRuleInfo	addPattern(UUID appId, String versionId, PatternRuleCreateObject pattern) Adds a pattern to a version of the application.
Observable<PatternRuleInfo>	addPatternAsync(UUID appId, String versionId, PatternRuleCreateObject pattern) Adds a pattern to a version of the application.
List<PatternRuleInfo>	batchAddPatterns(UUID appId, String versionId, List<PatternRuleCreateObject> patterns) Adds a batch of patterns in a version of the application.
Observable<List<PatternRuleInfo>>	batchAddPatternsAsync(UUID appId, String versionId, List<PatternRuleCreateObject> patterns) Adds a batch of patterns in a version of the application.
OperationStatus	deletePattern(UUID appId, String versionId, UUID patternId) Deletes the pattern with the specified ID from a version of the application..
Observable<OperationStatus>	deletePatternAsync(UUID appId, String versionId, UUID patternId) Deletes the pattern with the specified ID from a version of the application..
OperationStatus	deletePatterns(UUID appId, String versionId, List<UUID> patternIds) Deletes a list of patterns in a version of the application.
Observable<OperationStatus>	deletePatternsAsync(UUID appId, String versionId, List<UUID> patternIds) Deletes a list of patterns in a version of the application.
PatternsListIntentPatternsDefinitionStages.WithAppId	listIntentPatterns() Returns patterns for the specific intent in a version of the application.
List<PatternRuleInfo>	listIntentPatterns(UUID appId, String versionId, UUID intentId, ListIntentPatternsOptionalParameter listIntentPatternsOptionalParameter) Returns patterns for the specific intent in a version of the application.
Observable<List<PatternRuleInfo>>	listIntentPatternsAsync(UUID appId, String versionId, UUID intentId, ListIntentPatternsOptionalParameter listIntentPatternsOptionalParameter) Returns patterns for the specific intent in a version of the application.
PatternsListPatternsDefinitionStages.WithAppId	listPatterns() Gets patterns in a version of the application.
List<PatternRuleInfo>	listPatterns(UUID appId, String versionId, ListPatternsOptionalParameter listPatternsOptionalParameter) Gets patterns in a version of the application.
Observable<List<PatternRuleInfo>>	listPatternsAsync(UUID appId, String versionId, ListPatternsOptionalParameter listPatternsOptionalParameter) Gets patterns in a version of the application.
PatternRuleInfo	updatePattern(UUID appId, String versionId, UUID patternId, PatternRuleUpdateObject pattern) Updates a pattern in a version of the application.
Observable<PatternRuleInfo>	updatePatternAsync(UUID appId, String versionId, UUID patternId, PatternRuleUpdateObject pattern) Updates a pattern in a version of the application.
List<PatternRuleInfo>	updatePatterns(UUID appId, String versionId, List<PatternRuleUpdateObject> patterns) Updates patterns in a version of the application.
Observable<List<PatternRuleInfo>>	updatePatternsAsync(UUID appId, String versionId, List<PatternRuleUpdateObject> patterns) Updates patterns in a version of the application.

Method Details

addPattern

public PatternRuleInfo addPattern(UUID appId, String versionId, PatternRuleCreateObject pattern)

Adds a pattern to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

pattern - The input pattern.

Returns:

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

addPatternAsync

public Observable addPatternAsync(UUID appId, String versionId, PatternRuleCreateObject pattern)

Adds a pattern to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

pattern - The input pattern.

Returns:

the observable to the PatternRuleInfo object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

batchAddPatterns

public List batchAddPatterns(UUID appId, String versionId, List patterns)

Adds a batch of patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patterns - A JSON array containing patterns.

Returns:

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

batchAddPatternsAsync

public Observable> batchAddPatternsAsync(UUID appId, String versionId, List patterns)

Adds a batch of patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patterns - A JSON array containing patterns.

Returns:

the observable to the List<PatternRuleInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePattern

public OperationStatus deletePattern(UUID appId, String versionId, UUID patternId)

Deletes the pattern with the specified ID from a version of the application..

Parameters:

appId - The application ID.

versionId - The version ID.

patternId - The pattern 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

deletePatternAsync

public Observable deletePatternAsync(UUID appId, String versionId, UUID patternId)

Deletes the pattern with the specified ID from a version of the application..

Parameters:

appId - The application ID.

versionId - The version ID.

patternId - The pattern ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePatterns

public OperationStatus deletePatterns(UUID appId, String versionId, List patternIds)

Deletes a list of patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patternIds - The patterns IDs.

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

deletePatternsAsync

public Observable deletePatternsAsync(UUID appId, String versionId, List patternIds)

Deletes a list of patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patternIds - The patterns IDs.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listIntentPatterns

public PatternsListIntentPatternsDefinitionStages.WithAppId listIntentPatterns()

Returns patterns for the specific intent in a version of the application.

Returns:

the first stage of the listIntentPatterns call

listIntentPatterns

public List listIntentPatterns(UUID appId, String versionId, UUID intentId, ListIntentPatternsOptionalParameter listIntentPatternsOptionalParameter)

Returns patterns for the specific intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

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

Returns:

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

listIntentPatternsAsync

public Observable> listIntentPatternsAsync(UUID appId, String versionId, UUID intentId, ListIntentPatternsOptionalParameter listIntentPatternsOptionalParameter)

Returns patterns for the specific intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

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

Returns:

the observable to the List<PatternRuleInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPatterns

public PatternsListPatternsDefinitionStages.WithAppId listPatterns()

Gets patterns in a version of the application.

Returns:

the first stage of the listPatterns call

listPatterns

public List listPatterns(UUID appId, String versionId, ListPatternsOptionalParameter listPatternsOptionalParameter)

Gets patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

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

listPatternsAsync

public Observable> listPatternsAsync(UUID appId, String versionId, ListPatternsOptionalParameter listPatternsOptionalParameter)

Gets patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

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

Returns:

the observable to the List<PatternRuleInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePattern

public PatternRuleInfo updatePattern(UUID appId, String versionId, UUID patternId, PatternRuleUpdateObject pattern)

Updates a pattern in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patternId - The pattern ID.

pattern - An object representing a pattern.

Returns:

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

updatePatternAsync

public Observable updatePatternAsync(UUID appId, String versionId, UUID patternId, PatternRuleUpdateObject pattern)

Updates a pattern in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patternId - The pattern ID.

pattern - An object representing a pattern.

Returns:

the observable to the PatternRuleInfo object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePatterns

public List updatePatterns(UUID appId, String versionId, List patterns)

Updates patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patterns - An array represents the patterns.

Returns:

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

updatePatternsAsync

public Observable> updatePatternsAsync(UUID appId, String versionId, List patterns)

Updates patterns in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

patterns - An array represents the patterns.

Returns:

the observable to the List<PatternRuleInfo> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation