azure.cognitiveservices.language.luis.authoring.operations module

class azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations(client, config, serializer, deserializer)[source]

Bases: object

FeaturesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add_phrase_list(app_id, version_id, phraselist_create_object, custom_headers=None, raw=False, **operation_config)[source]

Creates a new phraselist feature.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • phraselist_create_object (PhraselistCreateObject) – A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

int or ClientRawResponse if raw=true

Return type:

int or ClientRawResponse

Raises:

ErrorResponseException

delete_phrase_list(app_id, version_id, phraselist_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a phraselist feature.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • phraselist_id (int) – The ID of the feature to be deleted.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

get_phrase_list(app_id, version_id, phraselist_id, custom_headers=None, raw=False, **operation_config)[source]

Gets phraselist feature info.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • phraselist_id (int) – The ID of the feature to be retrieved.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PhraseListFeatureInfo or ClientRawResponse if raw=true

Return type:

PhraseListFeatureInfo or ClientRawResponse

Raises:

ErrorResponseException

list(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets all the extraction features for the specified application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

FeaturesResponseObject or ClientRawResponse if raw=true

Return type:

FeaturesResponseObject or ClientRawResponse

Raises:

ErrorResponseException

list_phrase_lists(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets all the phraselist features.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PhraseListFeatureInfo] or ClientRawResponse

Raises:

ErrorResponseException

update_phrase_list(app_id, version_id, phraselist_id, phraselist_update_object=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the phrases, the state and the name of the phraselist feature.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • phraselist_id (int) – The ID of the feature to be updated.
  • phraselist_update_object (PhraselistUpdateObject) – The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations(client, config, serializer, deserializer)[source]

Bases: object

ExamplesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add(app_id, version_id, example_label_object, custom_headers=None, raw=False, **operation_config)[source]

Adds a labeled example to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • example_label_object (ExampleLabelObject) – An example label with the expected intent and entities.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

LabelExampleResponse or ClientRawResponse if raw=true

Return type:

LabelExampleResponse or ClientRawResponse

Raises:

ErrorResponseException

batch(app_id, version_id, example_label_object_array, custom_headers=None, raw=False, **operation_config)[source]

Adds a batch of labeled examples to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • example_label_object_array (list[ExampleLabelObject]) – Array of examples.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[BatchLabelExample] or ClientRawResponse

Raises:

ErrorResponseException

delete(app_id, version_id, example_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes the labeled example with the specified ID.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • example_id (int) – The example ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

list(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Returns examples to be reviewed.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[LabeledUtterance] or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.ModelOperations(client, config, serializer, deserializer)[source]

Bases: object

ModelOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add_closed_list(app_id, version_id, sub_lists=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a closed list model to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • sub_lists (list[WordListObject]) – Sublists for the feature.
  • name (str) – Name of the closed list feature.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_composite_entity(app_id, version_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a composite entity extractor to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_composite_entity_child(app_id, version_id, c_entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Creates a single child in an existing composite entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • name (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_custom_prebuilt_domain(app_id, version_id, domain_name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a customizable prebuilt domain along with all of its models to this application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • domain_name (str) – The domain name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[str] or ClientRawResponse

Raises:

ErrorResponseException

add_custom_prebuilt_entity(app_id, version_id, domain_name=None, model_name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a custom prebuilt entity model to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • domain_name (str) – The domain name.
  • model_name (str) – The intent name or entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_custom_prebuilt_intent(app_id, version_id, domain_name=None, model_name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a custom prebuilt intent model to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • domain_name (str) – The domain name.
  • model_name (str) – The intent name or entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_entity(app_id, version_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds an entity extractor to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • name (str) – Name of the new entity extractor.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_explicit_list_item(app_id, version_id, entity_id, explicit_list_item=None, custom_headers=None, raw=False, **operation_config)[source]

Add a new item to the explicit list for the Pattern.Any entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity extractor ID.
  • explicit_list_item (str) – The explicit list item.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

int or ClientRawResponse if raw=true

Return type:

int or ClientRawResponse

Raises:

ErrorResponseException

add_hierarchical_entity(app_id, version_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a hierarchical entity extractor to the application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_hierarchical_entity_child(app_id, version_id, h_entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Creates a single child in an existing hierarchical entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • name (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_intent(app_id, version_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds an intent classifier to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • name (str) – Name of the new entity extractor.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

HttpOperationError

add_prebuilt(app_id, version_id, prebuilt_extractor_names, custom_headers=None, raw=False, **operation_config)[source]

Adds a list of prebuilt entity extractors to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • prebuilt_extractor_names (list[str]) – An array of prebuilt entity extractor names.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PrebuiltEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

add_sub_list(app_id, version_id, cl_entity_id, canonical_form=None, list=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a list to an existing closed list.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list entity extractor ID.
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

int or ClientRawResponse if raw=true

Return type:

int or ClientRawResponse

Raises:

ErrorResponseException

create_closed_list_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_composite_entity_role(app_id, version_id, c_entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_custom_prebuilt_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_hierarchical_entity_role(app_id, version_id, h_entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_pattern_any_entity_model(app_id, version_id, name=None, explicit_list=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a pattern.any entity extractor to the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • name (str) – The model name.
  • explicit_list (list[str]) – The Pattern.Any explicit list.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_pattern_any_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_prebuilt_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_regex_entity_model(app_id, version_id, regex_pattern=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a regex entity model to the application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • regex_pattern (str) – The regex entity pattern.
  • name (str) – The model name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

create_regex_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Create an entity role for an entity in the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity model ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

delete_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a closed list model from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list model ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_closed_list_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a composite entity extractor from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_composite_entity_child(app_id, version_id, c_entity_id, c_child_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a composite entity extractor child from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • c_child_id (str) – The hierarchical entity extractor child ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_composite_entity_role(app_id, version_id, c_entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_custom_prebuilt_domain(app_id, version_id, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a prebuilt domain’s models from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • domain_name (str) – Domain name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes an entity extractor from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, raw=False, **operation_config)[source]

Delete the explicit list item from the Pattern.any explicit list.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The pattern.any entity id.
  • item_id (long) – The explicit list item which will be deleted.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a hierarchical entity extractor from the application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a hierarchical entity extractor child from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • h_child_id (str) – The hierarchical entity extractor child ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_intent(app_id, version_id, intent_id, delete_utterances=False, custom_headers=None, raw=False, **operation_config)[source]

Deletes an intent classifier from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • intent_id (str) – The intent classifier ID.
  • delete_utterances (bool) – Also delete the intent’s utterances (true). Or move the utterances to the None intent (false - the default value).
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_pattern_any_entity_model(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Pattern.Any entity extractor from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_pattern_any_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a prebuilt entity extractor from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • prebuilt_id (str) – The prebuilt entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_regex_entity_model(app_id, version_id, regex_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a regex entity model from the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • regex_entity_id (str) – The regex entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Delete an entity role.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_sub_list(app_id, version_id, cl_entity_id, sub_list_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes a sublist of a specific closed list model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list entity extractor ID.
  • sub_list_id (int) – The sublist ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

examples_method(app_id, version_id, model_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets the utterances for the given model in the given app version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • model_id (str) – The ID (GUID) of the model.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[LabelTextObject] or ClientRawResponse

Raises:

ErrorResponseException

get_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information of a closed list model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list model ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

ClosedListEntityExtractor or ClientRawResponse if raw=true

Return type:

ClosedListEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_closed_list_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_closed_list_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the composite entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

CompositeEntityExtractor or ClientRawResponse if raw=true

Return type:

CompositeEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_composite_entity_role(app_id, version_id, c_entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_composite_entity_roles(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_custom_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityExtractor or ClientRawResponse if raw=true

Return type:

EntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_entity_suggestions(app_id, version_id, entity_id, take=100, custom_headers=None, raw=False, **operation_config)[source]

Get suggestion examples that would improve the accuracy of the entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The target entity extractor model to enhance.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntitiesSuggestionExample] or ClientRawResponse

Raises:

ErrorResponseException

get_explicit_list(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get the explicit list of the pattern.any entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[ExplicitListItem] or ClientRawResponse

Raises:

ErrorResponseException

get_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, raw=False, **operation_config)[source]

Get the explicit list of the pattern.any entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity Id.
  • item_id (long) – The explicit list item Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

ExplicitListItem or ClientRawResponse if raw=true

Return type:

ExplicitListItem or ClientRawResponse

Raises:

ErrorResponseException

get_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the hierarchical entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

HierarchicalEntityExtractor or ClientRawResponse if raw=true

Return type:

HierarchicalEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the hierarchical entity child model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • h_child_id (str) – The hierarchical entity extractor child ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

HierarchicalChildEntity or ClientRawResponse if raw=true

Return type:

HierarchicalChildEntity or ClientRawResponse

Raises:

ErrorResponseException

get_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_hierarchical_entity_roles(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_intent(app_id, version_id, intent_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the intent model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • intent_id (str) – The intent classifier ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

IntentClassifier or ClientRawResponse if raw=true

Return type:

IntentClassifier or ClientRawResponse

Raises:

ErrorResponseException

get_intent_suggestions(app_id, version_id, intent_id, take=100, custom_headers=None, raw=False, **operation_config)[source]

Suggests examples that would improve the accuracy of the intent model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • intent_id (str) – The intent classifier ID.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[IntentsSuggestionExample] or ClientRawResponse

Raises:

ErrorResponseException

get_pattern_any_entity_info(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the application version’s Pattern.Any model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PatternAnyEntityExtractor or ClientRawResponse if raw=true

Return type:

PatternAnyEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_pattern_any_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Get information about the Pattern.Any entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PatternAnyEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

get_pattern_any_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_pattern_any_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the prebuilt entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • prebuilt_id (str) – The prebuilt entity extractor ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PrebuiltEntityExtractor or ClientRawResponse if raw=true

Return type:

PrebuiltEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

get_regex_entity_entity_info(app_id, version_id, regex_entity_id, custom_headers=None, raw=False, **operation_config)[source]

Gets information of a regex entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • regex_entity_id (str) – The regex entity model ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

RegexEntityExtractor or ClientRawResponse if raw=true

Return type:

RegexEntityExtractor or ClientRawResponse

Raises:

ErrorResponseException

get_regex_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the regex entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[RegexEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

get_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)[source]

Get one entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity ID.
  • role_id (str) – entity role ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EntityRole or ClientRawResponse if raw=true

Return type:

EntityRole or ClientRawResponse

Raises:

ErrorResponseException

get_regex_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)[source]

Get All Entity Roles for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – entity Id
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityRole] or ClientRawResponse

Raises:

ErrorResponseException

list_closed_lists(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the closedlist models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[ClosedListEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

list_composite_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the composite entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[CompositeEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

list_custom_prebuilt_entities(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets all custom prebuilt entities information of this application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

list_custom_prebuilt_intents(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets custom prebuilt intents information of this application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[IntentClassifier] or ClientRawResponse

Raises:

ErrorResponseException

list_custom_prebuilt_models(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets all custom prebuilt models information of this application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[CustomPrebuiltModel] or ClientRawResponse

Raises:

ErrorResponseException

list_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[EntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

list_hierarchical_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the hierarchical entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[HierarchicalEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

list_intents(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the intent models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[IntentClassifier] or ClientRawResponse

Raises:

ErrorResponseException

list_models(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the application version models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[ModelInfoResponse] or ClientRawResponse

Raises:

ErrorResponseException

list_prebuilt_entities(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets all the available prebuilt entity extractors for the application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[AvailablePrebuiltEntityModel] or ClientRawResponse

Raises:

ErrorResponseException

list_prebuilts(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets information about the prebuilt entity models.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PrebuiltEntityExtractor] or ClientRawResponse

Raises:

ErrorResponseException

patch_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a batch of sublists to an existing closedlist.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list model ID.
  • sub_lists (list[WordListObject]) – Sublists to add.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the closed list model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list model ID.
  • sub_lists (list[WordListObject]) – The new sublists for the feature.
  • name (str) – The new name of the closed list feature.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_closed_list_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_composite_entity(app_id, version_id, c_entity_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the composite entity extractor.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_composite_entity_role(app_id, version_id, c_entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • c_entity_id (str) – The composite entity extractor ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_custom_prebuilt_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_entity(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name of an entity extractor.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity extractor ID.
  • name (str) – The entity’s new name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_explicit_list_item(app_id, version_id, entity_id, item_id, explicit_list_item=None, custom_headers=None, raw=False, **operation_config)[source]

Updates an explicit list item for a Pattern.Any entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity extractor ID.
  • item_id (long) – The explicit list item ID.
  • explicit_list_item (str) – The explicit list item.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_hierarchical_entity(app_id, version_id, h_entity_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name and children of a hierarchical entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Renames a single child in an existing hierarchical entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • h_child_id (str) – The hierarchical entity extractor child ID.
  • name (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • h_entity_id (str) – The hierarchical entity extractor ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_intent(app_id, version_id, intent_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name of an intent classifier.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • intent_id (str) – The intent classifier ID.
  • name (str) – The entity’s new name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_pattern_any_entity_model(app_id, version_id, entity_id, name=None, explicit_list=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name and explicit list of a Pattern.Any entity model.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The Pattern.Any entity extractor ID.
  • name (str) – The model name.
  • explicit_list (list[str]) – The Pattern.Any explicit list.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_pattern_any_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_prebuilt_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_regex_entity_model(app_id, version_id, regex_entity_id, regex_pattern=None, name=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the regex entity model .

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • regex_entity_id (str) – The regex entity extractor ID.
  • regex_pattern (str) – The regex entity pattern.
  • name (str) – The model name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_regex_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)[source]

Update an entity role for a given entity.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • entity_id (str) – The entity ID.
  • role_id (str) – The entity role ID.
  • name (str) – The entity role name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_sub_list(app_id, version_id, cl_entity_id, sub_list_id, canonical_form=None, list=None, custom_headers=None, raw=False, **operation_config)[source]

Updates one of the closed list’s sublists.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • cl_entity_id (str) – The closed list entity extractor ID.
  • sub_list_id (int) – The sublist ID.
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.AppsOperations(client, config, serializer, deserializer)[source]

Bases: object

AppsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add(application_create_object, custom_headers=None, raw=False, **operation_config)[source]

Creates a new LUIS app.

Parameters:
  • application_create_object (ApplicationCreateObject) – A model containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is 0.1. Note: the culture cannot be changed after the app is created.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

add_custom_prebuilt_domain(domain_name=None, culture=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a prebuilt domain along with its models as a new application.

Parameters:
  • domain_name (str) – The domain name.
  • culture (str) – The culture of the new domain.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

delete(app_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes an application.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

download_query_logs(app_id, custom_headers=None, raw=False, callback=None, **operation_config)[source]

Gets the query logs of the past month for the application.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
  • operation_configOperation configuration overrides.
Returns:

object or ClientRawResponse if raw=true

Return type:

Generator or ClientRawResponse

Raises:

HttpOperationError

get(app_id, custom_headers=None, raw=False, **operation_config)[source]

Gets the application info.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

ApplicationInfoResponse or ClientRawResponse if raw=true

Return type:

ApplicationInfoResponse or ClientRawResponse

Raises:

ErrorResponseException

get_publish_settings(app_id, custom_headers=None, raw=False, **operation_config)[source]

Get the application publish settings.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PublishSettings or ClientRawResponse if raw=true

Return type:

PublishSettings or ClientRawResponse

Raises:

ErrorResponseException

get_settings(app_id, custom_headers=None, raw=False, **operation_config)[source]

Get the application settings.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

ApplicationSettings or ClientRawResponse if raw=true

Return type:

ApplicationSettings or ClientRawResponse

Raises:

ErrorResponseException

import_method(luis_app, app_name=None, custom_headers=None, raw=False, **operation_config)[source]

Imports an application to LUIS, the application’s structure should be included in in the request body.

Parameters:
  • luis_app (LuisApp) – A LUIS application structure.
  • app_name (str) – The application name to create. If not specified, the application name will be read from the imported object.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

list(skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the user applications.

Parameters:
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[ApplicationInfoResponse] or ClientRawResponse

Raises:

ErrorResponseException

list_available_custom_prebuilt_domains(custom_headers=None, raw=False, **operation_config)[source]

Gets all the available custom prebuilt domains for all cultures.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PrebuiltDomain] or ClientRawResponse

Raises:

ErrorResponseException

list_available_custom_prebuilt_domains_for_culture(culture, custom_headers=None, raw=False, **operation_config)[source]

Gets all the available custom prebuilt domains for a specific culture.

Parameters:
  • culture (str) – Culture.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PrebuiltDomain] or ClientRawResponse

Raises:

ErrorResponseException

list_cortana_endpoints(custom_headers=None, raw=False, **operation_config)[source]

Gets the endpoint URLs for the prebuilt Cortana applications.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PersonalAssistantsResponse or ClientRawResponse if raw=true

Return type:

PersonalAssistantsResponse or ClientRawResponse

Raises:

ErrorResponseException

list_domains(custom_headers=None, raw=False, **operation_config)[source]

Gets the available application domains.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[str] or ClientRawResponse

Raises:

ErrorResponseException

list_endpoints(app_id, custom_headers=None, raw=False, **operation_config)[source]

Returns the available endpoint deployment regions and URLs.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

dict or ClientRawResponse if raw=true

Return type:

dict[str, str] or ClientRawResponse

Raises:

ErrorResponseException

list_supported_cultures(custom_headers=None, raw=False, **operation_config)[source]

Gets the supported application cultures.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[AvailableCulture] or ClientRawResponse

Raises:

ErrorResponseException

list_usage_scenarios(custom_headers=None, raw=False, **operation_config)[source]

Gets the application available usage scenarios.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[str] or ClientRawResponse

Raises:

ErrorResponseException

publish(app_id, application_publish_object, custom_headers=None, raw=False, **operation_config)[source]

Publishes a specific version of the application.

Parameters:
  • app_id (str) – The application ID.
  • application_publish_object (ApplicationPublishObject) – The application publish object. The region is the target region that the application is published to.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

ProductionOrStagingEndpointInfo or ClientRawResponse if raw=true

Return type:

ProductionOrStagingEndpointInfo or ClientRawResponse

Raises:

ErrorResponseException

update(app_id, name=None, description=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name or description of the application.

Parameters:
  • app_id (str) – The application ID.
  • name (str) – The application’s new name.
  • description (str) – The application’s new description.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_publish_settings(app_id, publish_setting_update_object, custom_headers=None, raw=False, **operation_config)[source]

Updates the application publish settings.

Parameters:
  • app_id (str) – The application ID.
  • publish_setting_update_object (PublishSettingUpdateObject) – An object containing the new publish application settings.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

update_settings(app_id, public=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the application settings.

Parameters:
  • app_id (str) – The application ID.
  • public (bool) – Setting your application as public allows other people to use your application’s endpoint using their own keys.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations(client, config, serializer, deserializer)[source]

Bases: object

VersionsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
clone(app_id, version_id, version=None, custom_headers=None, raw=False, **operation_config)[source]

Creates a new version using the current snapshot of the selected application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • version (str) – The new version for the cloned model.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

delete(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Deletes an application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete_unlabelled_utterance(app_id, version_id, utterance, custom_headers=None, raw=False, **operation_config)[source]

Deleted an unlabelled utterance.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • utterance (str) – The utterance text to delete.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

export(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Exports a LUIS application to JSON format.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

LuisApp or ClientRawResponse if raw=true

Return type:

LuisApp or ClientRawResponse

Raises:

ErrorResponseException

get(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets the version info.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

VersionInfo or ClientRawResponse if raw=true

Return type:

VersionInfo or ClientRawResponse

Raises:

ErrorResponseException

import_method(app_id, luis_app, version_id=None, custom_headers=None, raw=False, **operation_config)[source]

Imports a new version into a LUIS application.

Parameters:
  • app_id (str) – The application ID.
  • luis_app (LuisApp) – A LUIS application structure.
  • version_id (str) – The new versionId to import. If not specified, the versionId will be read from the imported object.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

str or ClientRawResponse if raw=true

Return type:

str or ClientRawResponse

Raises:

ErrorResponseException

list(app_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Gets the application versions info.

Parameters:
  • app_id (str) – The application ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[VersionInfo] or ClientRawResponse

Raises:

ErrorResponseException

update(app_id, version_id, version=None, custom_headers=None, raw=False, **operation_config)[source]

Updates the name or description of the application version.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • version (str) – The new version for the cloned model.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.TrainOperations(client, config, serializer, deserializer)[source]

Bases: object

TrainOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
get_status(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. “appID” specifies the LUIS app ID. “versionId” specifies the version number of the LUIS app. For example, “0.1”.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[ModelTrainingInfo] or ClientRawResponse

Raises:

ErrorResponseException

train_version(app_id, version_id, custom_headers=None, raw=False, **operation_config)[source]

Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

EnqueueTrainingResponse or ClientRawResponse if raw=true

Return type:

EnqueueTrainingResponse or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.PermissionsOperations(client, config, serializer, deserializer)[source]

Bases: object

PermissionsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add(app_id, email=None, custom_headers=None, raw=False, **operation_config)[source]

Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.

Parameters:
  • app_id (str) – The application ID.
  • email (str) – The email address of the user.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

delete(app_id, email=None, custom_headers=None, raw=False, **operation_config)[source]

Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.

Parameters:
  • app_id (str) – The application ID.
  • email (str) – The email address of the user.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

list(app_id, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of user emails that have permissions to access your application.

Parameters:
  • app_id (str) – The application ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

UserAccessList or ClientRawResponse if raw=true

Return type:

UserAccessList or ClientRawResponse

Raises:

ErrorResponseException

update(app_id, emails=None, custom_headers=None, raw=False, **operation_config)[source]

Replaces the current users access list with the one sent in the body. If an empty list is sent, all access to other users will be removed.

Parameters:
  • app_id (str) – The application ID.
  • emails (list[str]) – The email address of the users.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>
class azure.cognitiveservices.language.luis.authoring.operations.PatternOperations(client, config, serializer, deserializer)[source]

Bases: object

PatternOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
add_pattern(app_id, version_id, pattern=None, intent=None, custom_headers=None, raw=False, **operation_config)[source]

Adds one pattern to the specified application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • pattern (str) – The pattern text.
  • intent (str) – The intent’s name which the pattern belongs to.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PatternRuleInfo or ClientRawResponse if raw=true

Return type:

PatternRuleInfo or ClientRawResponse

Raises:

ErrorResponseException

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

Adds a batch of patterns to the specified application.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • patterns (list[PatternRuleCreateObject]) – A JSON array containing patterns.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PatternRuleInfo] or ClientRawResponse

Raises:

ErrorResponseException

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

Deletes the pattern with the specified ID.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • pattern_id (str) – The pattern ID.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

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

Deletes the patterns with the specified IDs.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • pattern_ids (list[str]) – The patterns IDs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

OperationStatus or ClientRawResponse if raw=true

Return type:

OperationStatus or ClientRawResponse

Raises:

ErrorResponseException

get_intent_patterns(app_id, version_id, intent_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Returns patterns to be retrieved for the specific intent.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • intent_id (str) – The intent classifier ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PatternRuleInfo] or ClientRawResponse

Raises:

ErrorResponseException

get_patterns(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)[source]

Returns an application version’s patterns.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • skip (int) – The number of entries to skip. Default value is 0.
  • take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PatternRuleInfo] or ClientRawResponse

Raises:

ErrorResponseException

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

Updates a pattern.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • pattern_id (str) – The pattern ID.
  • pattern (PatternRuleUpdateObject) – An object representing a pattern.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

PatternRuleInfo or ClientRawResponse if raw=true

Return type:

PatternRuleInfo or ClientRawResponse

Raises:

ErrorResponseException

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

Updates patterns.

Parameters:
  • app_id (str) – The application ID.
  • version_id (str) – The version ID.
  • patterns (list[PatternRuleUpdateObject]) – An array represents the patterns.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

list or ClientRawResponse if raw=true

Return type:

list[PatternRuleInfo] or ClientRawResponse

Raises:

ErrorResponseException

models = <module 'azure.cognitiveservices.language.luis.authoring.models' from '/usr/lib/python3/dist-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>