azure.cognitiveservices.language.luis.authoring.operations module¶
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.
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.
- model_name (str) – The name of the model used.
- feature_name (str) – The name of the feature used.
- 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:
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.
- model_name (str) – The name of the model used.
- feature_name (str) – The name of the feature used.
- 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:
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:
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:
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:
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:
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:
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:
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.
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.
- 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:
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.
- 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:
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:
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.
- 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:
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.
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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.
- model_name (str) – The name of the model used.
- feature_name (str) – The name of the feature used.
- 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:
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:
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:
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:
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:
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:
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:
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.
- model_name (str) – The name of the model used.
- feature_name (str) – The name of the feature used.
- 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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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.
- 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:
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:
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:
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.
- 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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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.
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:
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:
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:
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
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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.
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:
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:
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:
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:
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:
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:
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:
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:
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.
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:
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:
Bases:
object
PermissionsOperations 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.
Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.
Parameters: - app_id (str) – The application ID.
- email (str) – The email address of the user.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.
Parameters: - app_id (str) – The application ID.
- email (str) – The email address of the user.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Gets the list of user emails that have permissions to access your application.
Parameters: - app_id (str) – The application ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: UserAccessList or ClientRawResponse if raw=true
Return type: UserAccessList or ClientRawResponse
Raises:
Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.
Parameters: - app_id (str) – The application ID.
- emails (list[str]) – The email address of the users.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
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.
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:
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:
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:
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:
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:
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:
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:
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:
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.
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:
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:
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.
apps - Assign a LUIS Azure account to an application.
Assigns an Azure account to the application.
Parameters: - app_id (str) – The application ID.
- 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:
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.
- 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:
user - Get LUIS Azure accounts.
Gets the LUIS Azure accounts for the user using his ARM token.
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[AzureAccountInfoObject] or ClientRawResponse
Raises:
apps - Removes an assigned LUIS Azure account from an application.
Removes assigned Azure account from the application.
Parameters: - app_id (str) – The application ID.
- 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: