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

Interface Patterns

All Known Implementing Classes:

PatternsImpl

public interface Patterns

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Patterns.PatternsListIntentPatternsDefinition	The entirety of listIntentPatterns definition.
static interface	Patterns.PatternsListIntentPatternsDefinitionStages	Grouping of listIntentPatterns definition stages.
static interface	Patterns.PatternsListPatternsDefinition	The entirety of listPatterns definition.
static interface	Patterns.PatternsListPatternsDefinitionStages	Grouping of listPatterns definition stages.

Method Summary

Modifier and Type	Method	Description
PatternRuleInfo	addPattern(UUID appId, String versionId, PatternRuleCreateObject pattern)	Adds a pattern to a version of the application.
rx.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.
rx.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..
rx.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.
rx.Observable<OperationStatus>	deletePatternsAsync(UUID appId, String versionId, List<UUID> patternIds)	Deletes a list of patterns in a version of the application.
Patterns.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.
rx.Observable<List<PatternRuleInfo>>	listIntentPatternsAsync(UUID appId, String versionId, UUID intentId, ListIntentPatternsOptionalParameter listIntentPatternsOptionalParameter)	Returns patterns for the specific intent in a version of the application.
Patterns.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.
rx.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.
rx.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.
rx.Observable<List<PatternRuleInfo>>	updatePatternsAsync(UUID appId, String versionId, List<PatternRuleUpdateObject> patterns)	Updates patterns in a version of the application.

Method Detail

addPattern

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

rx.Observable<PatternRuleInfo> 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

listPatterns

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

rx.Observable<List<PatternRuleInfo>> 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

listPatterns

Patterns.PatternsListPatternsDefinitionStages.WithAppId listPatterns()

Gets patterns in a version of the application.

Returns:

the first stage of the listPatterns call

updatePatterns

List<PatternRuleInfo> updatePatterns(UUID appId,
                                     String versionId,
                                     List<PatternRuleUpdateObject> 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

rx.Observable<List<PatternRuleInfo>> updatePatternsAsync(UUID appId,
                                                         String versionId,
                                                         List<PatternRuleUpdateObject> 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

batchAddPatterns

List<PatternRuleInfo> batchAddPatterns(UUID appId,
                                       String versionId,
                                       List<PatternRuleCreateObject> 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

rx.Observable<List<PatternRuleInfo>> batchAddPatternsAsync(UUID appId,
                                                           String versionId,
                                                           List<PatternRuleCreateObject> 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

deletePatterns

OperationStatus deletePatterns(UUID appId,
                               String versionId,
                               List<UUID> 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

rx.Observable<OperationStatus> deletePatternsAsync(UUID appId,
                                                   String versionId,
                                                   List<UUID> 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

updatePattern

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

rx.Observable<PatternRuleInfo> 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

deletePattern

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

rx.Observable<OperationStatus> 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

listIntentPatterns

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

rx.Observable<List<PatternRuleInfo>> 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

listIntentPatterns

Patterns.PatternsListIntentPatternsDefinitionStages.WithAppId listIntentPatterns()

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

Returns:

the first stage of the listIntentPatterns call