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

class azure.cognitiveservices.language.luis.authoring.operations.AppsOperations(client, config, serializer, deserializer)

Bases: object

AppsOperations operations.

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

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)

Creates a new LUIS app.

Parameters

• application_create_object (ApplicationCreateObject) – An application 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_config – Operation 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)

Adds a prebuilt domain along with its intent and entity 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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

delete(app_id, force=False, custom_headers=None, raw=False, **operation_config)

Deletes an application.

Parameters

• app_id (str) – The application ID.

• force (bool) – A flag to indicate whether to force an operation.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Gets the logs of the past month’s endpoint queries 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_config – Operation 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)

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_config – Operation 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)

Get the application publish settings including ‘UseAllTrainingData’.

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_config – Operation 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)

Get the application settings including ‘UseAllTrainingData’.

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_config – Operation configuration overrides.

Returns

ApplicationSettings or ClientRawResponse if raw=true

Return type

ApplicationSettings or ClientRawResponse

Raises

ErrorResponseException

import_lu_format(luis_app_lu, app_name=None, custom_headers=None, raw=False, **operation_config)

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

Parameters

• luis_app_lu (str) – 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. If the application name already exists, an error is returned.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

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

Imports an application to LUIS, the application’s structure is included 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. If the application name already exists, an error is returned.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

import_v2_app(luis_app_v2, app_name=None, custom_headers=None, raw=False, **operation_config)

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

Parameters

• luis_app_v2 (LuisAppV2) – 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. If the application name already exists, an error is returned.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Lists all of the user’s 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_config – Operation 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)

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_config – Operation 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)

Gets all the available 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_config – Operation 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)

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_config – Operation 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)

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_config – Operation 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)

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_config – Operation 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)

Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,”en-us” represents the U.S. variation of English.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[str] or ClientRawResponse

Raises

ErrorResponseException

package_published_application_as_gzip(app_id, slot_name, custom_headers=None, raw=False, callback=None, **operation_config)

package - Gets published LUIS application package in binary stream GZip format.

Packages a published LUIS application as a GZip file to be used in the LUIS container.

Parameters

• app_id (str) – The application ID.

• slot_name (str) – The publishing slot name.

• 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_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

ErrorResponseException

package_trained_application_as_gzip(app_id, version_id, custom_headers=None, raw=False, callback=None, **operation_config)

package - Gets trained LUIS application package in binary stream GZip format.

Packages trained LUIS application as GZip file to be used in the LUIS container.

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

• 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_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

ErrorResponseException

publish(app_id, version_id=None, is_staging=False, custom_headers=None, raw=False, **operation_config)

Publishes a specific version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID to publish.

• is_staging (bool) – Indicates if the staging slot should be used, instead of the Production one.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

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_config – Operation 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)

Updates the application publish settings including ‘UseAllTrainingData’.

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_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

update_settings(app_id, is_public=None, custom_headers=None, raw=False, **operation_config)

Updates the application settings including ‘UseAllTrainingData’.

Parameters

• app_id (str) – The application ID.

• is_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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations(client, config, serializer, deserializer)

Bases: object

AzureAccountsOperations operations.

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

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

assign_to_app(app_id, arm_token=None, azure_account_info_object=None, custom_headers=None, raw=False, **operation_config)

apps - Assign a LUIS Azure account to an application.

Assigns an Azure account to the application.

Parameters

• app_id (str) – The application ID.

• arm_token (str) – The custom arm token header to use; containing the user’s ARM token used to validate azure accounts information.

• azure_account_info_object (AzureAccountInfoObject) – The Azure account information object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

get_assigned(app_id, arm_token=None, custom_headers=None, raw=False, **operation_config)

apps - Get LUIS Azure accounts assigned to the application.

Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.

Parameters

• app_id (str) – The application ID.

• arm_token (str) – The custom arm token header to use; containing the user’s ARM token used to validate azure accounts information.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[AzureAccountInfoObject] or ClientRawResponse

Raises

ErrorResponseException

list_user_luis_accounts(arm_token=None, custom_headers=None, raw=False, **operation_config)

user - Get LUIS Azure accounts.

Gets the LUIS Azure accounts for the user using his ARM token.

Parameters

• arm_token (str) – The custom arm token header to use; containing the user’s ARM token used to validate azure accounts information.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[AzureAccountInfoObject] or ClientRawResponse

Raises

ErrorResponseException

remove_from_app(app_id, arm_token=None, azure_account_info_object=None, custom_headers=None, raw=False, **operation_config)

apps - Removes an assigned LUIS Azure account from an application.

Removes assigned Azure account from the application.

Parameters

• app_id (str) – The application ID.

• arm_token (str) – The custom arm token header to use; containing the user’s ARM token used to validate azure accounts information.

• azure_account_info_object (AzureAccountInfoObject) – The Azure account information object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations(client, config, serializer, deserializer)

Bases: object

ExamplesOperations operations.

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

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, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Adds a labeled example utterance in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• example_label_object (ExampleLabelObject) – A labeled example utterance with the expected intent and entities.

• enable_nested_children (bool) – Toggles nested/flat format

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Adds a batch of labeled example utterances to a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• example_label_object_array (list[ExampleLabelObject]) – Array of example utterances.

• enable_nested_children (bool) – Toggles nested/flat format

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Deletes the labeled example utterances with the specified ID from a version of the application.

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_config – Operation 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, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Returns example utterances to be reviewed from a version of the application.

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.

• enable_nested_children (bool) – Toggles nested/flat format

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

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

Bases: object

FeaturesOperations operations.

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

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

add_entity_feature(app_id, version_id, entity_id, feature_relation_create_object, custom_headers=None, raw=False, **operation_config)

Adds a new feature relation to be used by the entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor ID.

• feature_relation_create_object (ModelFeatureInformation) – A Feature relation information object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

add_intent_feature(app_id, version_id, intent_id, feature_relation_create_object, custom_headers=None, raw=False, **operation_config)

Adds a new feature relation to be used by the intent in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• intent_id (str) – The intent classifier ID.

• feature_relation_create_object (ModelFeatureInformation) – A Feature relation information object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

add_phrase_list(app_id, version_id, phraselist_create_object, custom_headers=None, raw=False, **operation_config)

Creates a new phraselist feature in a version of the application.

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_config – Operation 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)

Deletes a phraselist feature from a version of the application.

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_config – Operation 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)

Gets phraselist feature info in a version of the application.

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_config – Operation 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)

Gets all the extraction phraselist and pattern features in a version of the application.

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_config – Operation 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)

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

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_config – Operation 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)

Updates the phrases, the state and the name of the phraselist feature in a version of the application.

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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.ModelOperations(client, config, serializer, deserializer)

Bases: object

ModelOperations operations.

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

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)

Adds a list entity model to a version of 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 list entity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Creates a single child in an existing composite entity model in a version of 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) –

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the 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_config – Operation 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)

Adds a prebuilt entity model to a version of 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_config – Operation 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)

Adds a customizable prebuilt intent model to a version of 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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

add_entity(app_id, version_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)

Adds an entity extractor to a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• children (list[ChildEntityModelCreateObject]) – 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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

add_entity_child(app_id, version_id, entity_id, child_entity_model_create_object, custom_headers=None, raw=False, **operation_config)

Creates a single child in an existing entity model hierarchy in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor ID.

• child_entity_model_create_object (ChildEntityModelCreateObject) – A model object containing the name of the new child model and its children.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.

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_config – Operation configuration overrides.

Returns

int or ClientRawResponse if raw=true

Return type

int or ClientRawResponse

Raises

ErrorResponseException

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

Adds an intent to a version of 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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

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

Adds a list of prebuilt entities to a version of 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_config – Operation 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)

Adds a sublist to an existing list entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The 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_config – Operation configuration overrides.

Returns

long or ClientRawResponse if raw=true

Return type

long or ClientRawResponse

Raises

ErrorResponseException

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

Create a role for a list entity in a version of 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_config – Operation 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)

Create a role for a composite entity in a version of 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_config – Operation 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)

Create a role for a prebuilt entity in a version of 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_config – Operation 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)

Create an entity role in a version of 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_config – Operation 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)

Create a role for an hierarchical entity in a version of 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_config – Operation 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)

Adds a pattern.any entity extractor to a version of 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_config – Operation 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)

Create a role for an Pattern.any entity in a version of 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_config – Operation 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)

Create a role for a prebuilt entity in a version of 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_config – Operation 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)

Adds a regular expression entity model to a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• regex_pattern (str) – The regular expression 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_config – Operation 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)

Create a role for an regular expression entity in a version of 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_config – Operation 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)

Deletes a list entity model from a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The list 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_config – Operation 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)

Delete a role for a given list entity in a version of the application.

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_config – Operation 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)

Deletes a composite entity from a version of 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_config – Operation 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)

Deletes a composite entity extractor child from a version of 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_config – Operation 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)

Delete a role for a given composite entity in a version of the application.

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_config – Operation 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)

Delete a role for a given prebuilt entity in a version of the application.

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_config – Operation 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)

Deletes a prebuilt domain’s models in a version of 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_config – Operation 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)

Deletes an entity or a child from a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor or the child 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_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

delete_entity_feature(app_id, version_id, entity_id, feature_relation_delete_object, custom_headers=None, raw=False, **operation_config)

Deletes a relation from the feature relations used by the entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor ID.

• feature_relation_delete_object (ModelFeatureInformation) – A feature information object containing the feature relation to delete.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Delete an entity role in a version of the application.

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_config – Operation 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)

Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.

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_config – Operation 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)

Deletes a hierarchical entity from a version of the application.

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_config – Operation 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)

Deletes a hierarchical entity extractor child in a version of 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_config – Operation 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)

Delete a role for a given hierarchical role in a version of the application.

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_config – Operation 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)

Deletes an intent from a version of 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) – If true, deletes the intent’s example utterances. If false, moves the example utterances to the None intent. The default value is false.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

delete_intent_feature(app_id, version_id, intent_id, feature_relation_delete_object, custom_headers=None, raw=False, **operation_config)

Deletes a relation from the feature relations used by the intent in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• intent_id (str) – The intent classifier ID.

• feature_relation_delete_object (ModelFeatureInformation) – A feature information object containing the feature relation to delete.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Deletes a Pattern.Any entity extractor from a version of 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_config – Operation 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)

Delete a role for a given Pattern.any entity in a version of the application.

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_config – Operation 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)

Deletes a prebuilt entity extractor from a version of 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_config – Operation 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)

Delete a role in a prebuilt entity in a version of the application.

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_config – Operation 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)

Deletes a regular expression entity from a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• regex_entity_id (str) – The regular expression 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_config – Operation 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)

Delete a role for a given regular expression in a version of the application.

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_config – Operation 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)

Deletes a sublist of a specific list entity model from a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The list entity extractor ID.

• sub_list_id (long) – 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_config – Operation 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)

Gets the example utterances for the given intent or entity model in a version of the application.

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_config – Operation 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)

Gets information about a list entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The 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_config – Operation 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)

Get one role for a given list entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about a composite entity in a version of 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_config – Operation 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)

Get one role for a given composite entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Get one role for a given prebuilt entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about an entity model in a version of 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_config – Operation configuration overrides.

Returns

NDepthEntityExtractor or ClientRawResponse if raw=true

Return type

NDepthEntityExtractor or ClientRawResponse

Raises

ErrorResponseException

get_entity_features(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Gets the information of the features used by the entity in a version of 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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ModelFeatureInformation] or ClientRawResponse

Raises

ErrorResponseException

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

Get one role for a given entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Get the explicit (exception) list of the pattern.any entity in a version of the application.

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_config – Operation 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)

Get the explicit (exception) list of the pattern.any entity in a version of the application.

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_config – Operation 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)

Gets information about a hierarchical entity in a version of the application.

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_config – Operation 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)

Gets information about the child’s model contained in an hierarchical entity child model in a version of 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_config – Operation 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)

Get one role for a given hierarchical entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about the intent model in a version of the application.

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_config – Operation configuration overrides.

Returns

IntentClassifier or ClientRawResponse if raw=true

Return type

IntentClassifier or ClientRawResponse

Raises

ErrorResponseException

get_intent_features(app_id, version_id, intent_id, custom_headers=None, raw=False, **operation_config)

Gets the information of the features used by the intent in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ModelFeatureInformation] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about the Pattern.Any model in a version of 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_config – Operation configuration overrides.

Returns

PatternAnyEntityExtractor or ClientRawResponse if raw=true

Return type

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)

Get one role for a given Pattern.any entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about a prebuilt entity model in a version of 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_config – Operation 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)

Get one role for a given prebuilt entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about a regular expression entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• regex_entity_id (str) – The regular expression 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_config – Operation configuration overrides.

Returns

RegexEntityExtractor or ClientRawResponse if raw=true

Return type

RegexEntityExtractor or ClientRawResponse

Raises

ErrorResponseException

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

Get one role for a given regular expression entity in a version of the application.

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_config – Operation configuration overrides.

Returns

EntityRole or ClientRawResponse if raw=true

Return type

EntityRole or ClientRawResponse

Raises

ErrorResponseException

list_closed_list_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a list entity in a version of the application.

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_config – Operation 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)

Gets information about all the list entity models in a version of the application.

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_config – Operation 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)

Gets information about all the composite entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[CompositeEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_composite_entity_roles(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a composite entity in a version of 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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

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

Gets all prebuilt entities used in a version of 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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_custom_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a prebuilt entity in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about customizable prebuilt intents added to a version of 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_config – Operation 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)

Gets all prebuilt intent and entity model information used in a version 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_config – Operation 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)

Gets information about all the simple entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[NDepthEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for an entity in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

list_entity_suggestions(app_id, version_id, entity_id, take=100, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.

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.

• enable_nested_children (bool) – Toggles nested/flat format

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntitiesSuggestionExample] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about all the hierarchical entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[HierarchicalEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_hierarchical_entity_roles(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a hierarchical entity in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

list_intent_suggestions(app_id, version_id, intent_id, take=100, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Suggests example utterances that would improve the accuracy of the intent model in a version of the application.

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.

• enable_nested_children (bool) – Toggles nested/flat format

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[IntentsSuggestionExample] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about the intent models in a version of the application.

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_config – Operation 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)

Gets information about all the intent and entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ModelInfoResponse] or ClientRawResponse

Raises

ErrorResponseException

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

Get information about the Pattern.Any entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[PatternAnyEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_pattern_any_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a Pattern.any entity in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

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

Gets all the available prebuilt entities in a version of 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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[AvailablePrebuiltEntityModel] or ClientRawResponse

Raises

ErrorResponseException

list_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get a prebuilt entity’s roles in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about all the prebuilt entities in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[PrebuiltEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

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

Gets information about the regular expression entity models in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[RegexEntityExtractor] or ClientRawResponse

Raises

ErrorResponseException

list_regex_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)

Get all roles for a regular expression entity in a version of the application.

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[EntityRole] or ClientRawResponse

Raises

ErrorResponseException

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

Adds a batch of sublists to an existing list entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The list entity 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_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

replace_entity_features(app_id, version_id, entity_id, feature_relations_update_object, custom_headers=None, raw=False, **operation_config)

Updates the information of the features used by the entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor ID.

• feature_relations_update_object (list[ModelFeatureInformation]) – A list of feature information objects containing the new feature relations.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

replace_intent_features(app_id, version_id, intent_id, feature_relations_update_object, custom_headers=None, raw=False, **operation_config)

Updates the information of the features used by the intent in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• intent_id (str) – The intent classifier ID.

• feature_relations_update_object (list[ModelFeatureInformation]) – A list of feature information objects containing the new feature relations.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Updates the list entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The list model ID.

• sub_lists (list[WordListObject]) – The new sublists for the feature.

• name (str) – The new name of the list entity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Update a role for a given list entity in a version of the application.

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_config – Operation 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)

Updates a composite entity in a version of the application.

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_config – Operation 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)

Update a role for a given composite entity in a version of the application.

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_config – Operation 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)

Update a role for a given prebuilt entity in a version of the application.

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_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

update_entity_child(app_id, version_id, entity_id, name=None, instance_of=None, custom_headers=None, raw=False, **operation_config)

Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• entity_id (str) – The entity extractor or the child entity extractor ID.

• name (str) – Entity name.

• instance_of (str) – The instance of model name

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Update a role for a given entity in a version of the application.

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_config – Operation 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)

Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.

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_config – Operation 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, name=None, custom_headers=None, raw=False, **operation_config)

Updates the name of a hierarchical entity model in a version of 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’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_config – Operation 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)

Renames a single child in an existing hierarchical entity model in a version of 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.

• name (str) –

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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)

Update a role for a given hierarchical entity in a version of the application.

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_config – Operation 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)

Updates the name of an intent in a version of the application.

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_config – Operation 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)

Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.

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_config – Operation 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)

Update a role for a given Pattern.any entity in a version of the application.

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_config – Operation 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)

Update a role for a given prebuilt entity in a version of the application.

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_config – Operation 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)

Updates the regular expression entity in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• regex_entity_id (str) – The regular expression entity extractor ID.

• regex_pattern (str) – The regular expression 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_config – Operation 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)

Update a role for a given regular expression entity in a version of the application.

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_config – Operation 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)

Updates one of the list entity’s sublists in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• cl_entity_id (str) – The list entity extractor ID.

• sub_list_id (long) – 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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.PatternOperations(client, config, serializer, deserializer)

Bases: object

PatternOperations operations.

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

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)

Adds a pattern to a version of the 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_config – Operation 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)

Adds a batch of patterns in a version of the 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_config – Operation 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)

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

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_config – Operation 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)

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

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_config – Operation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

ErrorResponseException

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

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

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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[PatternRuleInfo] or ClientRawResponse

Raises

ErrorResponseException

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

Gets patterns in a version of the application.

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_config – Operation 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)

Updates a pattern in a version of the application.

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_config – Operation 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)

Updates patterns in a version of the application.

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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations(client, config, serializer, deserializer)

Bases: object

SettingsOperations operations.

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

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Gets the settings in a version of 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_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[AppVersionSettingObject] or ClientRawResponse

Raises

ErrorResponseException

update(app_id, version_id, list_of_app_version_setting_object, custom_headers=None, raw=False, **operation_config)

Updates the settings in a version of the application.

Parameters

• app_id (str) – The application ID.

• version_id (str) – The version ID.

• list_of_app_version_setting_object (list[AppVersionSettingObject]) – A list of the updated application version settings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.TrainOperations(client, config, serializer, deserializer)

Bases: object

TrainOperations operations.

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

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)

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_config – Operation 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)

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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>

class azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations(client, config, serializer, deserializer)

Bases: object

VersionsOperations operations.

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

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

format – Lu format extension. Constant value: “lu”.

clone(app_id, version_id, version=None, custom_headers=None, raw=False, **operation_config)

Creates a new version from the selected 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_config – Operation 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)

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_config – Operation 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)

Deleted an unlabelled utterance in a version of the application.

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_config – Operation 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)

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_config – Operation configuration overrides.

Returns

LuisApp or ClientRawResponse if raw=true

Return type

LuisApp or ClientRawResponse

Raises

ErrorResponseException

export_lu_format(app_id, version_id, custom_headers=None, raw=False, callback=None, **operation_config)

Exports a LUIS application to text 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

• 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_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

HttpOperationError

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

Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.

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_config – Operation configuration overrides.

Returns

VersionInfo or ClientRawResponse if raw=true

Return type

VersionInfo or ClientRawResponse

Raises

ErrorResponseException

import_lu_format(app_id, luis_app_lu, version_id=None, custom_headers=None, raw=False, **operation_config)

Imports a new version into a LUIS application.

Parameters

• app_id (str) – The application ID.

• luis_app_lu (str) – An LU representing the 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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

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

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_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

ErrorResponseException

import_v2_app(app_id, luis_app_v2, version_id=None, custom_headers=None, raw=False, **operation_config)

Imports a new version into a LUIS application.

Parameters

• app_id (str) – The application ID.

• luis_app_v2 (LuisAppV2) – 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_config – Operation 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)

Gets a list of versions for this application ID.

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_config – Operation 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)

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_config – Operation 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 '/home/vsts/work/1/s/sdk/cognitiveservices/azure-cognitiveservices-language-luis/.tox/sphinx/lib/python3.6/site-packages/azure/cognitiveservices/language/luis/authoring/models/__init__.py'>