PatternOperations Class

PatternOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Inheritance

builtins.object

PatternOperations

Constructor

PatternOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Methods

add_pattern	Adds a pattern to a version of the application.
batch_add_patterns	Adds a batch of patterns in a version of the application.
delete_pattern	Deletes the pattern with the specified ID from a version of the application..
delete_patterns	Deletes a list of patterns in a version of the application.
list_intent_patterns	Returns patterns for the specific intent in a version of the application.
list_patterns	Gets patterns in a version of the application.
update_pattern	Updates a pattern in a version of the application.
update_patterns	Updates patterns in a version of the application.

add_pattern

Adds a pattern to a version of the application.

add_pattern(app_id, version_id, pattern=None, intent=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
pattern	str The pattern text. Default value: None
intent	str The intent's name which the pattern belongs to. Default value: None
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
PatternRuleInfo, <xref:msrest.pipeline.ClientRawResponse>	PatternRuleInfo or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

batch_add_patterns

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

batch_add_patterns(app_id, version_id, patterns, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
patterns Required	list[PatternRuleCreateObject] A JSON array containing patterns.
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
list[PatternRuleInfo], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

delete_pattern

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

delete_pattern(app_id, version_id, pattern_id, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
pattern_id Required	str The pattern ID.
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
OperationStatus, <xref:msrest.pipeline.ClientRawResponse>	OperationStatus or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

delete_patterns

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

delete_patterns(app_id, version_id, pattern_ids, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
pattern_ids Required	list[str] The patterns IDs.
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
OperationStatus, <xref:msrest.pipeline.ClientRawResponse>	OperationStatus or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

list_intent_patterns

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

list_intent_patterns(app_id, version_id, intent_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
intent_id Required	str The intent classifier ID.
skip	int The number of entries to skip. Default value is 0. Default value: 0
take	int The number of entries to return. Maximum page size is 500. Default is 100. Default value: 100
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
list[PatternRuleInfo], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

list_patterns

Gets patterns in a version of the application.

list_patterns(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
skip	int The number of entries to skip. Default value is 0. Default value: 0
take	int The number of entries to return. Maximum page size is 500. Default is 100. Default value: 100
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
list[PatternRuleInfo], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

update_pattern

Updates a pattern in a version of the application.

update_pattern(app_id, version_id, pattern_id, pattern, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
pattern_id Required	str The pattern ID.
pattern Required	PatternRuleUpdateObject An object representing a pattern.
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
PatternRuleInfo, <xref:msrest.pipeline.ClientRawResponse>	PatternRuleInfo or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

update_patterns

Updates patterns in a version of the application.

update_patterns(app_id, version_id, patterns, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
patterns Required	list[PatternRuleUpdateObject] An array represents the patterns.
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
list[PatternRuleInfo], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

Attributes

models

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\language\\luis\\authoring\\models\\__init__.py'>