ModelOperations Class
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.
- Inheritance
-
builtins.objectModelOperations
Constructor
ModelOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Methods
| add_closed_list |
Adds a list entity model to a version of the application. |
| add_composite_entity_child |
Creates a single child in an existing composite entity model in a version of the application. |
| add_custom_prebuilt_domain |
Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application. |
| add_custom_prebuilt_entity |
Adds a prebuilt entity model to a version of the application. |
| add_custom_prebuilt_intent |
Adds a customizable prebuilt intent model to a version of the application. |
| add_entity |
Adds an entity extractor to a version of the application. |
| add_entity_child |
Creates a single child in an existing entity model hierarchy in a version of the application. |
| add_explicit_list_item |
Add a new exception to the explicit list for the Pattern.Any entity in a version of the application. |
| add_intent |
Adds an intent to a version of the application. |
| add_prebuilt |
Adds a list of prebuilt entities to a version of the application. |
| add_sub_list |
Adds a sublist to an existing list entity in a version of the application. |
| create_closed_list_entity_role |
Create a role for a list entity in a version of the application. |
| create_composite_entity_role |
Create a role for a composite entity in a version of the application. |
| create_custom_prebuilt_entity_role |
Create a role for a prebuilt entity in a version of the application. |
| create_entity_role |
Create an entity role in a version of the application. |
| create_hierarchical_entity_role |
Create a role for an hierarchical entity in a version of the application. |
| create_pattern_any_entity_model |
Adds a pattern.any entity extractor to a version of the application. |
| create_pattern_any_entity_role |
Create a role for an Pattern.any entity in a version of the application. |
| create_prebuilt_entity_role |
Create a role for a prebuilt entity in a version of the application. |
| create_regex_entity_model |
Adds a regular expression entity model to a version of the application. |
| create_regex_entity_role |
Create a role for an regular expression entity in a version of the application. |
| delete_closed_list |
Deletes a list entity model from a version of the application. |
| delete_closed_list_entity_role |
Delete a role for a given list entity in a version of the application. |
| delete_composite_entity |
Deletes a composite entity from a version of the application. |
| delete_composite_entity_child |
Deletes a composite entity extractor child from a version of the application. |
| delete_composite_entity_role |
Delete a role for a given composite entity in a version of the application. |
| delete_custom_entity_role |
Delete a role for a given prebuilt entity in a version of the application. |
| delete_custom_prebuilt_domain |
Deletes a prebuilt domain's models in a version of the application. |
| delete_entity |
Deletes an entity or a child from a version of the application. |
| delete_entity_feature |
Deletes a relation from the feature relations used by the entity in a version of the application. |
| delete_entity_role |
Delete an entity role in a version of the application. |
| delete_explicit_list_item |
Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application. |
| delete_hierarchical_entity |
Deletes a hierarchical entity from a version of the application. |
| delete_hierarchical_entity_child |
Deletes a hierarchical entity extractor child in a version of the application. |
| delete_hierarchical_entity_role |
Delete a role for a given hierarchical role in a version of the application. |
| delete_intent |
Deletes an intent from a version of the application. |
| delete_intent_feature |
Deletes a relation from the feature relations used by the intent in a version of the application. |
| delete_pattern_any_entity_model |
Deletes a Pattern.Any entity extractor from a version of the application. |
| delete_pattern_any_entity_role |
Delete a role for a given Pattern.any entity in a version of the application. |
| delete_prebuilt |
Deletes a prebuilt entity extractor from a version of the application. |
| delete_prebuilt_entity_role |
Delete a role in a prebuilt entity in a version of the application. |
| delete_regex_entity_model |
Deletes a regular expression entity from a version of the application. |
| delete_regex_entity_role |
Delete a role for a given regular expression in a version of the application. |
| delete_sub_list |
Deletes a sublist of a specific list entity model from a version of the application. |
| examples_method |
Gets the example utterances for the given intent or entity model in a version of the application. |
| get_closed_list |
Gets information about a list entity in a version of the application. |
| get_closed_list_entity_role |
Get one role for a given list entity in a version of the application. |
| get_composite_entity |
Gets information about a composite entity in a version of the application. |
| get_composite_entity_role |
Get one role for a given composite entity in a version of the application. |
| get_custom_entity_role |
Get one role for a given prebuilt entity in a version of the application. |
| get_entity |
Gets information about an entity model in a version of the application. |
| get_entity_features |
Gets the information of the features used by the entity in a version of the application. |
| get_entity_role |
Get one role for a given entity in a version of the application. |
| get_explicit_list |
Get the explicit (exception) list of the pattern.any entity in a version of the application. |
| get_explicit_list_item |
Get the explicit (exception) list of the pattern.any entity in a version of the application. |
| get_hierarchical_entity |
Gets information about a hierarchical entity in a version of the application. |
| get_hierarchical_entity_child |
Gets information about the child's model contained in an hierarchical entity child model in a version of the application. |
| get_hierarchical_entity_role |
Get one role for a given hierarchical entity in a version of the application. |
| get_intent |
Gets information about the intent model in a version of the application. |
| get_intent_features |
Gets the information of the features used by the intent in a version of the application. |
| get_pattern_any_entity_info |
Gets information about the Pattern.Any model in a version of the application. |
| get_pattern_any_entity_role |
Get one role for a given Pattern.any entity in a version of the application. |
| get_prebuilt |
Gets information about a prebuilt entity model in a version of the application. |
| get_prebuilt_entity_role |
Get one role for a given prebuilt entity in a version of the application. |
| get_regex_entity_entity_info |
Gets information about a regular expression entity in a version of the application. |
| get_regex_entity_role |
Get one role for a given regular expression entity in a version of the application. |
| list_closed_list_entity_roles |
Get all roles for a list entity in a version of the application. |
| list_closed_lists |
Gets information about all the list entity models in a version of the application. |
| list_composite_entities |
Gets information about all the composite entity models in a version of the application. |
| list_composite_entity_roles |
Get all roles for a composite entity in a version of the application. |
| list_custom_prebuilt_entities |
Gets all prebuilt entities used in a version of the application. |
| list_custom_prebuilt_entity_roles |
Get all roles for a prebuilt entity in a version of the application. |
| list_custom_prebuilt_intents |
Gets information about customizable prebuilt intents added to a version of the application. |
| list_custom_prebuilt_models |
Gets all prebuilt intent and entity model information used in a version of this application. |
| list_entities |
Gets information about all the simple entity models in a version of the application. |
| list_entity_roles |
Get all roles for an entity in a version of the application. |
| list_entity_suggestions |
Get suggested example utterances that would improve the accuracy of the entity model in a version of the application. |
| list_hierarchical_entities |
Gets information about all the hierarchical entity models in a version of the application. |
| list_hierarchical_entity_roles |
Get all roles for a hierarchical entity in a version of the application. |
| list_intent_suggestions |
Suggests example utterances that would improve the accuracy of the intent model in a version of the application. |
| list_intents |
Gets information about the intent models in a version of the application. |
| list_models |
Gets information about all the intent and entity models in a version of the application. |
| list_pattern_any_entity_infos |
Get information about the Pattern.Any entity models in a version of the application. |
| list_pattern_any_entity_roles |
Get all roles for a Pattern.any entity in a version of the application. |
| list_prebuilt_entities |
Gets all the available prebuilt entities in a version of the application. |
| list_prebuilt_entity_roles |
Get a prebuilt entity's roles in a version of the application. |
| list_prebuilts |
Gets information about all the prebuilt entities in a version of the application. |
| list_regex_entity_infos |
Gets information about the regular expression entity models in a version of the application. |
| list_regex_entity_roles |
Get all roles for a regular expression entity in a version of the application. |
| patch_closed_list |
Adds a batch of sublists to an existing list entity in a version of the application. |
| replace_entity_features |
Updates the information of the features used by the entity in a version of the application. |
| replace_intent_features |
Updates the information of the features used by the intent in a version of the application. |
| update_closed_list |
Updates the list entity in a version of the application. |
| update_closed_list_entity_role |
Update a role for a given list entity in a version of the application. |
| update_composite_entity |
Updates a composite entity in a version of the application. |
| update_composite_entity_role |
Update a role for a given composite entity in a version of the application. |
| update_custom_prebuilt_entity_role |
Update a role for a given prebuilt entity in a version of the application. |
| update_entity_child |
Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor. |
| update_entity_role |
Update a role for a given entity in a version of the application. |
| update_explicit_list_item |
Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application. |
| update_hierarchical_entity |
Updates the name of a hierarchical entity model in a version of the application. |
| update_hierarchical_entity_child |
Renames a single child in an existing hierarchical entity model in a version of the application. |
| update_hierarchical_entity_role |
Update a role for a given hierarchical entity in a version of the application. |
| update_intent |
Updates the name of an intent in a version of the application. |
| update_pattern_any_entity_model |
Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application. |
| update_pattern_any_entity_role |
Update a role for a given Pattern.any entity in a version of the application. |
| update_prebuilt_entity_role |
Update a role for a given prebuilt entity in a version of the application. |
| update_regex_entity_model |
Updates the regular expression entity in a version of the application. |
| update_regex_entity_role |
Update a role for a given regular expression entity in a version of the application. |
| update_sub_list |
Updates one of the list entity's sublists in a version of the application. |
add_closed_list
Adds a list entity model to a version of the application.
add_closed_list(app_id, version_id, sub_lists=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_composite_entity_child
Creates a single child in an existing composite entity model in a version of the application.
add_composite_entity_child(app_id, version_id, c_entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- name
- str
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_custom_prebuilt_domain
Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.
add_custom_prebuilt_domain(app_id, version_id, domain_name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
add_custom_prebuilt_entity
Adds a prebuilt entity model to a version of the application.
add_custom_prebuilt_entity(app_id, version_id, domain_name=None, model_name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_custom_prebuilt_intent
Adds a customizable prebuilt intent model to a version of the application.
add_custom_prebuilt_intent(app_id, version_id, domain_name=None, model_name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_entity
Adds an entity extractor to a version of the application.
add_entity(app_id, version_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_entity_child
Creates a single child in an existing entity model hierarchy in a version of the application.
add_entity_child(app_id, version_id, entity_id, child_entity_model_create_object, custom_headers=None, raw=False, **operation_config)Parameters
- child_entity_model_create_object
- ChildEntityModelCreateObject
A model object containing the name of the new child model and its children.
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_explicit_list_item
Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.
add_explicit_list_item(app_id, version_id, entity_id, explicit_list_item=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
int or ClientRawResponse if raw=true
Return type
Exceptions
add_intent
Adds an intent to a version of the application.
add_intent(app_id, version_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
add_prebuilt
Adds a list of prebuilt entities to a version of the application.
add_prebuilt(app_id, version_id, prebuilt_extractor_names, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
add_sub_list
Adds a sublist to an existing list entity in a version of the application.
add_sub_list(app_id, version_id, cl_entity_id, canonical_form=None, list=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
long or ClientRawResponse if raw=true
Return type
Exceptions
create_closed_list_entity_role
Create a role for a list entity in a version of the application.
create_closed_list_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_composite_entity_role
Create a role for a composite entity in a version of the application.
create_composite_entity_role(app_id, version_id, c_entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_custom_prebuilt_entity_role
Create a role for a prebuilt entity in a version of the application.
create_custom_prebuilt_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_entity_role
Create an entity role in a version of the application.
create_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_hierarchical_entity_role
Create a role for an hierarchical entity in a version of the application.
create_hierarchical_entity_role(app_id, version_id, h_entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_pattern_any_entity_model
Adds a pattern.any entity extractor to a version of the application.
create_pattern_any_entity_model(app_id, version_id, name=None, explicit_list=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_pattern_any_entity_role
Create a role for an Pattern.any entity in a version of the application.
create_pattern_any_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_prebuilt_entity_role
Create a role for a prebuilt entity in a version of the application.
create_prebuilt_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_regex_entity_model
Adds a regular expression entity model to a version of the application.
create_regex_entity_model(app_id, version_id, regex_pattern=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
create_regex_entity_role
Create a role for an regular expression entity in a version of the application.
create_regex_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
str or ClientRawResponse if raw=true
Return type
Exceptions
delete_closed_list
Deletes a list entity model from a version of the application.
delete_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_closed_list_entity_role
Delete a role for a given list entity in a version of the application.
delete_closed_list_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_composite_entity
Deletes a composite entity from a version of the application.
delete_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_composite_entity_child
Deletes a composite entity extractor child from a version of the application.
delete_composite_entity_child(app_id, version_id, c_entity_id, c_child_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_composite_entity_role
Delete a role for a given composite entity in a version of the application.
delete_composite_entity_role(app_id, version_id, c_entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_custom_entity_role
Delete a role for a given prebuilt entity in a version of the application.
delete_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_custom_prebuilt_domain
Deletes a prebuilt domain's models in a version of the application.
delete_custom_prebuilt_domain(app_id, version_id, domain_name, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_entity
Deletes an entity or a child from a version of the application.
delete_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_entity_feature
Deletes a relation from the feature relations used by the entity in a version of the application.
delete_entity_feature(app_id, version_id, entity_id, feature_relation_delete_object, custom_headers=None, raw=False, **operation_config)Parameters
- feature_relation_delete_object
- ModelFeatureInformation
A feature information object containing the feature relation to delete.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_entity_role
Delete an entity role in a version of the application.
delete_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_explicit_list_item
Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.
delete_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, raw=False, **operation_config)Parameters
- item_id
- <xref:long>
The explicit list item which will be deleted.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_hierarchical_entity
Deletes a hierarchical entity from a version of the application.
delete_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_hierarchical_entity_child
Deletes a hierarchical entity extractor child in a version of the application.
delete_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_hierarchical_entity_role
Delete a role for a given hierarchical role in a version of the application.
delete_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_intent
Deletes an intent from a version of the application.
delete_intent(app_id, version_id, intent_id, delete_utterances=False, custom_headers=None, raw=False, **operation_config)Parameters
- 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.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_intent_feature
Deletes a relation from the feature relations used by the intent in a version of the application.
delete_intent_feature(app_id, version_id, intent_id, feature_relation_delete_object, custom_headers=None, raw=False, **operation_config)Parameters
- feature_relation_delete_object
- ModelFeatureInformation
A feature information object containing the feature relation to delete.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_pattern_any_entity_model
Deletes a Pattern.Any entity extractor from a version of the application.
delete_pattern_any_entity_model(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_pattern_any_entity_role
Delete a role for a given Pattern.any entity in a version of the application.
delete_pattern_any_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_prebuilt
Deletes a prebuilt entity extractor from a version of the application.
delete_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_prebuilt_entity_role
Delete a role in a prebuilt entity in a version of the application.
delete_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_regex_entity_model
Deletes a regular expression entity from a version of the application.
delete_regex_entity_model(app_id, version_id, regex_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_regex_entity_role
Delete a role for a given regular expression in a version of the application.
delete_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
delete_sub_list
Deletes a sublist of a specific list entity model from a version of the application.
delete_sub_list(app_id, version_id, cl_entity_id, sub_list_id, custom_headers=None, raw=False, **operation_config)Parameters
- sub_list_id
- <xref:long>
The sublist ID.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
examples_method
Gets the example utterances for the given intent or entity model in a version of the application.
examples_method(app_id, version_id, model_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
get_closed_list
Gets information about a list entity in a version of the application.
get_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
ClosedListEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_closed_list_entity_role
Get one role for a given list entity in a version of the application.
get_closed_list_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_composite_entity
Gets information about a composite entity in a version of the application.
get_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
CompositeEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_composite_entity_role
Get one role for a given composite entity in a version of the application.
get_composite_entity_role(app_id, version_id, c_entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_custom_entity_role
Get one role for a given prebuilt entity in a version of the application.
get_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_entity
Gets information about an entity model in a version of the application.
get_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
NDepthEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_entity_features
Gets the information of the features used by the entity in a version of the application.
get_entity_features(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
get_entity_role
Get one role for a given entity in a version of the application.
get_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_explicit_list
Get the explicit (exception) list of the pattern.any entity in a version of the application.
get_explicit_list(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
get_explicit_list_item
Get the explicit (exception) list of the pattern.any entity in a version of the application.
get_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, raw=False, **operation_config)Parameters
- item_id
- <xref:long>
The explicit list item Id.
- operation_config
Operation configuration overrides.
Returns
ExplicitListItem or ClientRawResponse if raw=true
Return type
Exceptions
get_hierarchical_entity
Gets information about a hierarchical entity in a version of the application.
get_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
HierarchicalEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_hierarchical_entity_child
Gets information about the child's model contained in an hierarchical entity child model in a version of the application.
get_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
HierarchicalChildEntity or ClientRawResponse if raw=true
Return type
Exceptions
get_hierarchical_entity_role
Get one role for a given hierarchical entity in a version of the application.
get_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_intent
Gets information about the intent model in a version of the application.
get_intent(app_id, version_id, intent_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
IntentClassifier or ClientRawResponse if raw=true
Return type
Exceptions
get_intent_features
Gets the information of the features used by the intent in a version of the application.
get_intent_features(app_id, version_id, intent_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
get_pattern_any_entity_info
Gets information about the Pattern.Any model in a version of the application.
get_pattern_any_entity_info(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
PatternAnyEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_pattern_any_entity_role
Get one role for a given Pattern.any entity in a version of the application.
get_pattern_any_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_prebuilt
Gets information about a prebuilt entity model in a version of the application.
get_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
PrebuiltEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_prebuilt_entity_role
Get one role for a given prebuilt entity in a version of the application.
get_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
get_regex_entity_entity_info
Gets information about a regular expression entity in a version of the application.
get_regex_entity_entity_info(app_id, version_id, regex_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
RegexEntityExtractor or ClientRawResponse if raw=true
Return type
Exceptions
get_regex_entity_role
Get one role for a given regular expression entity in a version of the application.
get_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
EntityRole or ClientRawResponse if raw=true
Return type
Exceptions
list_closed_list_entity_roles
Get all roles for a list entity in a version of the application.
list_closed_list_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_closed_lists
Gets information about all the list entity models in a version of the application.
list_closed_lists(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_composite_entities
Gets information about all the composite entity models in a version of the application.
list_composite_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_composite_entity_roles
Get all roles for a composite entity in a version of the application.
list_composite_entity_roles(app_id, version_id, c_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_custom_prebuilt_entities
Gets all prebuilt entities used in a version of the application.
list_custom_prebuilt_entities(app_id, version_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_custom_prebuilt_entity_roles
Get all roles for a prebuilt entity in a version of the application.
list_custom_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_custom_prebuilt_intents
Gets information about customizable prebuilt intents added to a version of the application.
list_custom_prebuilt_intents(app_id, version_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_custom_prebuilt_models
Gets all prebuilt intent and entity model information used in a version of this application.
list_custom_prebuilt_models(app_id, version_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_entities
Gets information about all the simple entity models in a version of the application.
list_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_entity_roles
Get all roles for an entity in a version of the application.
list_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_entity_suggestions
Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.
list_entity_suggestions(app_id, version_id, entity_id, take=100, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_hierarchical_entities
Gets information about all the hierarchical entity models in a version of the application.
list_hierarchical_entities(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_hierarchical_entity_roles
Get all roles for a hierarchical entity in a version of the application.
list_hierarchical_entity_roles(app_id, version_id, h_entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_intent_suggestions
Suggests example utterances that would improve the accuracy of the intent model in a version of the application.
list_intent_suggestions(app_id, version_id, intent_id, take=100, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_intents
Gets information about the intent models in a version of the application.
list_intents(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_models
Gets information about all the intent and entity models in a version of the application.
list_models(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_pattern_any_entity_infos
Get information about the Pattern.Any entity models in a version of the application.
list_pattern_any_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_pattern_any_entity_roles
Get all roles for a Pattern.any entity in a version of the application.
list_pattern_any_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_prebuilt_entities
Gets all the available prebuilt entities in a version of the application.
list_prebuilt_entities(app_id, version_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_prebuilt_entity_roles
Get a prebuilt entity's roles in a version of the application.
list_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_prebuilts
Gets information about all the prebuilt entities in a version of the application.
list_prebuilts(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_regex_entity_infos
Gets information about the regular expression entity models in a version of the application.
list_regex_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config)Parameters
- take
- int
The number of entries to return. Maximum page size is 500. Default is 100.
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
list_regex_entity_roles
Get all roles for a regular expression entity in a version of the application.
list_regex_entity_roles(app_id, version_id, entity_id, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
list or ClientRawResponse if raw=true
Return type
Exceptions
patch_closed_list
Adds a batch of sublists to an existing list entity in a version of the application.
patch_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
replace_entity_features
Updates the information of the features used by the entity in a version of the application.
replace_entity_features(app_id, version_id, entity_id, feature_relations_update_object, custom_headers=None, raw=False, **operation_config)Parameters
- feature_relations_update_object
- list[ModelFeatureInformation]
A list of feature information objects containing the new feature relations.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
replace_intent_features
Updates the information of the features used by the intent in a version of the application.
replace_intent_features(app_id, version_id, intent_id, feature_relations_update_object, custom_headers=None, raw=False, **operation_config)Parameters
- feature_relations_update_object
- list[ModelFeatureInformation]
A list of feature information objects containing the new feature relations.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_closed_list
Updates the list entity in a version of the application.
update_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_closed_list_entity_role
Update a role for a given list entity in a version of the application.
update_closed_list_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_composite_entity
Updates a composite entity in a version of the application.
update_composite_entity(app_id, version_id, c_entity_id, children=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_composite_entity_role
Update a role for a given composite entity in a version of the application.
update_composite_entity_role(app_id, version_id, c_entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_custom_prebuilt_entity_role
Update a role for a given prebuilt entity in a version of the application.
update_custom_prebuilt_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_entity_child
Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.
update_entity_child(app_id, version_id, entity_id, name=None, instance_of=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_entity_role
Update a role for a given entity in a version of the application.
update_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_explicit_list_item
Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.
update_explicit_list_item(app_id, version_id, entity_id, item_id, explicit_list_item=None, custom_headers=None, raw=False, **operation_config)Parameters
- item_id
- <xref:long>
The explicit list item ID.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_hierarchical_entity
Updates the name of a hierarchical entity model in a version of the application.
update_hierarchical_entity(app_id, version_id, h_entity_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_hierarchical_entity_child
Renames a single child in an existing hierarchical entity model in a version of the application.
update_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- name
- str
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_hierarchical_entity_role
Update a role for a given hierarchical entity in a version of the application.
update_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_intent
Updates the name of an intent in a version of the application.
update_intent(app_id, version_id, intent_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_pattern_any_entity_model
Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.
update_pattern_any_entity_model(app_id, version_id, entity_id, name=None, explicit_list=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_pattern_any_entity_role
Update a role for a given Pattern.any entity in a version of the application.
update_pattern_any_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_prebuilt_entity_role
Update a role for a given prebuilt entity in a version of the application.
update_prebuilt_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_regex_entity_model
Updates the regular expression entity in a version of the application.
update_regex_entity_model(app_id, version_id, regex_entity_id, regex_pattern=None, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_regex_entity_role
Update a role for a given regular expression entity in a version of the application.
update_regex_entity_role(app_id, version_id, entity_id, role_id, name=None, custom_headers=None, raw=False, **operation_config)Parameters
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
update_sub_list
Updates one of the list entity's sublists in a version of the application.
update_sub_list(app_id, version_id, cl_entity_id, sub_list_id, canonical_form=None, list=None, custom_headers=None, raw=False, **operation_config)Parameters
- sub_list_id
- <xref:long>
The sublist ID.
- operation_config
Operation configuration overrides.
Returns
OperationStatus or ClientRawResponse if raw=true
Return type
Exceptions
Attributes
models
models = <module 'azure.cognitiveservices.language.luis.authoring.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.12\\x64\\lib\\site-packages\\azure\\cognitiveservices\\language\\luis\\authoring\\models\\__init__.py'>الملاحظات
إرسال الملاحظات وعرضها المتعلقة بـ