azure.cognitiveservices.language.luis.authoring.operations module¶
Bases:
object
FeaturesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Creates a new phraselist feature.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- phraselist_create_object (PhraselistCreateObject) – A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: int or ClientRawResponse if raw=true
Return type: int or ClientRawResponse
Raises:
Deletes a phraselist feature.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- phraselist_id (int) – The ID of the feature to be deleted.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Gets phraselist feature info.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- phraselist_id (int) – The ID of the feature to be retrieved.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PhraseListFeatureInfo or ClientRawResponse if raw=true
Return type: PhraseListFeatureInfo or ClientRawResponse
Raises:
Gets all the extraction features for the specified application version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FeaturesResponseObject or ClientRawResponse if raw=true
Return type: FeaturesResponseObject or ClientRawResponse
Raises:
Gets all the phraselist features.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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.
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 to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- example_label_object (ExampleLabelObject) – An example label with the expected intent and entities.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: LabelExampleResponse or ClientRawResponse if raw=true
Return type: LabelExampleResponse or ClientRawResponse
Raises:
Adds a batch of labeled examples to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- example_label_object_array (list[ExampleLabelObject]) – Array of examples.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[BatchLabelExample] or ClientRawResponse
Raises:
Deletes the labeled example with the specified ID.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- example_id (int) – The example ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Returns examples to be reviewed.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[LabeledUtterance] or ClientRawResponse
Raises:
Bases:
object
ModelOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Adds a closed list model to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- sub_lists (list[WordListObject]) – Sublists for the feature.
- name (str) – Name of the closed list feature.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds a composite entity extractor to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- children (list[str]) – Child entities.
- name (str) – Entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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 models to this application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- domain_name (str) – The domain name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[str] or ClientRawResponse
Raises:
Adds a custom prebuilt entity model to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- domain_name (str) – The domain name.
- model_name (str) – The intent name or entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds a custom prebuilt intent model to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- domain_name (str) – The domain name.
- model_name (str) – The intent name or entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds an entity extractor to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- name (str) – Name of the new entity extractor.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Add a new item to the explicit list for the Pattern.Any entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity extractor ID.
- explicit_list_item (str) – The explicit list item.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: int or ClientRawResponse if raw=true
Return type: int or ClientRawResponse
Raises:
Adds a hierarchical entity extractor to the application version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- children (list[str]) – Child entities.
- name (str) – Entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Creates a single child in an existing hierarchical entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- name (str) –
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds an intent classifier to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- name (str) – Name of the new entity extractor.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises: HttpOperationError
Adds a list of prebuilt entity extractors to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- prebuilt_extractor_names (list[str]) – An array of prebuilt entity extractor names.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PrebuiltEntityExtractor] or ClientRawResponse
Raises:
Adds a list to an existing closed list.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list entity extractor ID.
- canonical_form (str) – The standard form that the list represents.
- list (list[str]) – List of synonym words.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: int or ClientRawResponse if raw=true
Return type: int or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds a pattern.any entity extractor to the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- name (str) – The model name.
- explicit_list (list[str]) – The Pattern.Any explicit list.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds a regex entity model to the application version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- regex_pattern (str) – The regex entity pattern.
- name (str) – The model name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Create an entity role for an entity in the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity model ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Deletes a closed list model from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list model ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a composite entity extractor from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a composite entity extractor child from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- c_child_id (str) – The hierarchical entity extractor child ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a prebuilt domain’s models from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- domain_name (str) – Domain name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes an entity extractor from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete the explicit list item from the Pattern.any explicit list.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The pattern.any entity id.
- item_id (long) – The explicit list item which will be deleted.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a hierarchical entity extractor from the application version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a hierarchical entity extractor child from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- h_child_id (str) – The hierarchical entity extractor child ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes an intent classifier from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- intent_id (str) – The intent classifier ID.
- delete_utterances (bool) – Also delete the intent’s utterances (true). Or move the utterances to the None intent (false - the default value).
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a Pattern.Any entity extractor from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a prebuilt entity extractor from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- prebuilt_id (str) – The prebuilt entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a regex entity model from the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- regex_entity_id (str) – The regex entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Delete an entity role.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Deletes a sublist of a specific closed list model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list entity extractor ID.
- sub_list_id (int) – The sublist ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Gets the utterances for the given model in the given app version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- model_id (str) – The ID (GUID) of the model.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[LabelTextObject] or ClientRawResponse
Raises:
Gets information of a closed list model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list model ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ClosedListEntityExtractor or ClientRawResponse if raw=true
Return type: ClosedListEntityExtractor or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information about the composite entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: CompositeEntityExtractor or ClientRawResponse if raw=true
Return type: CompositeEntityExtractor or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information about the entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityExtractor or ClientRawResponse if raw=true
Return type: EntityExtractor or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Get suggestion examples that would improve the accuracy of the entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The target entity extractor model to enhance.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntitiesSuggestionExample] or ClientRawResponse
Raises:
Get the explicit list of the pattern.any entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[ExplicitListItem] or ClientRawResponse
Raises:
Get the explicit list of the pattern.any entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity Id.
- item_id (long) – The explicit list item Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ExplicitListItem or ClientRawResponse if raw=true
Return type: ExplicitListItem or ClientRawResponse
Raises:
Gets information about the hierarchical entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: HierarchicalEntityExtractor or ClientRawResponse if raw=true
Return type: HierarchicalEntityExtractor or ClientRawResponse
Raises:
Gets information about the hierarchical entity child model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- h_child_id (str) – The hierarchical entity extractor child ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: HierarchicalChildEntity or ClientRawResponse if raw=true
Return type: HierarchicalChildEntity or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information about the intent model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- intent_id (str) – The intent classifier ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: IntentClassifier or ClientRawResponse if raw=true
Return type: IntentClassifier or ClientRawResponse
Raises:
Suggests examples that would improve the accuracy of the intent model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- intent_id (str) – The intent classifier ID.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[IntentsSuggestionExample] or ClientRawResponse
Raises:
Gets information about the application version’s Pattern.Any model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PatternAnyEntityExtractor or ClientRawResponse if raw=true
Return type: PatternAnyEntityExtractor or ClientRawResponse
Raises:
Get information about the Pattern.Any entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PatternAnyEntityExtractor] or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information about the prebuilt entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- prebuilt_id (str) – The prebuilt entity extractor ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PrebuiltEntityExtractor or ClientRawResponse if raw=true
Return type: PrebuiltEntityExtractor or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information of a regex entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- regex_entity_id (str) – The regex entity model ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: RegexEntityExtractor or ClientRawResponse if raw=true
Return type: RegexEntityExtractor or ClientRawResponse
Raises:
Gets information about the regex entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[RegexEntityExtractor] or ClientRawResponse
Raises:
Get one entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity ID.
- role_id (str) – entity role ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: EntityRole or ClientRawResponse if raw=true
Return type: EntityRole or ClientRawResponse
Raises:
Get All Entity Roles for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – entity Id
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityRole] or ClientRawResponse
Raises:
Gets information about the closedlist models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[ClosedListEntityExtractor] or ClientRawResponse
Raises:
Gets information about the composite entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[CompositeEntityExtractor] or ClientRawResponse
Raises:
Gets all custom prebuilt entities information of this application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityExtractor] or ClientRawResponse
Raises:
Gets custom prebuilt intents information of this application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[IntentClassifier] or ClientRawResponse
Raises:
Gets all custom prebuilt models information of this application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[CustomPrebuiltModel] or ClientRawResponse
Raises:
Gets information about the entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[EntityExtractor] or ClientRawResponse
Raises:
Gets information about the hierarchical entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[HierarchicalEntityExtractor] or ClientRawResponse
Raises:
Gets information about the intent models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[IntentClassifier] or ClientRawResponse
Raises:
Gets information about the application version models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[ModelInfoResponse] or ClientRawResponse
Raises:
Gets all the available prebuilt entity extractors for the application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[AvailablePrebuiltEntityModel] or ClientRawResponse
Raises:
Gets information about the prebuilt entity models.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PrebuiltEntityExtractor] or ClientRawResponse
Raises:
Adds a batch of sublists to an existing closedlist.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list model ID.
- sub_lists (list[WordListObject]) – Sublists to add.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the closed list model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list model ID.
- sub_lists (list[WordListObject]) – The new sublists for the feature.
- name (str) – The new name of the closed list feature.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the composite entity extractor.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- children (list[str]) – Child entities.
- name (str) – Entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- c_entity_id (str) – The composite entity extractor ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the name of an entity extractor.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity extractor ID.
- name (str) – The entity’s new name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates an explicit list item for a Pattern.Any entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity extractor ID.
- item_id (long) – The explicit list item ID.
- explicit_list_item (str) – The explicit list item.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the name and children of a hierarchical entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- children (list[str]) – Child entities.
- name (str) – Entity name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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 an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- h_entity_id (str) – The hierarchical entity extractor ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the name of an intent classifier.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- intent_id (str) – The intent classifier ID.
- name (str) – The entity’s new name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the name and explicit list of a Pattern.Any entity model.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The Pattern.Any entity extractor ID.
- name (str) – The model name.
- explicit_list (list[str]) – The Pattern.Any explicit list.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates the regex entity model .
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- regex_entity_id (str) – The regex entity extractor ID.
- regex_pattern (str) – The regex entity pattern.
- name (str) – The model name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Update an entity role for a given entity.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- entity_id (str) – The entity ID.
- role_id (str) – The entity role ID.
- name (str) – The entity role name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Updates one of the closed list’s sublists.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- cl_entity_id (str) – The closed list entity extractor ID.
- sub_list_id (int) – The sublist ID.
- canonical_form (str) – The standard form that the list represents.
- list (list[str]) – List of synonym words.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Bases:
object
AppsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Creates a new LUIS app.
Parameters: - application_create_object (ApplicationCreateObject) – A model containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is 0.1. Note: the culture cannot be changed after the app is created.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Adds a prebuilt domain along with its models as a new application.
Parameters: - domain_name (str) – The domain name.
- culture (str) – The culture of the new domain.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
- custom_headers (dict) – 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 query logs of the past month for the application.
Parameters: - app_id (str) – The application ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_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.
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.
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 should be included in in the request body.
Parameters: - luis_app (LuisApp) – A LUIS application structure.
- app_name (str) – The application name to create. If not specified, the application name will be read from the imported object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
Lists all of the user applications.
Parameters: - skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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 custom prebuilt domains for a specific culture.
Parameters: - culture (str) – Culture.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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 the supported application cultures.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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:
Publishes a specific version of the application.
Parameters: - app_id (str) – The application ID.
- application_publish_object (ApplicationPublishObject) – The application publish object. The region is the target region that the application is published to.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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.
Parameters: - app_id (str) – The application ID.
- public (bool) – Setting your application as public allows other people to use your application’s endpoint using their own keys.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Bases:
object
VersionsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Creates a new version using the current snapshot of the selected application version.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- version (str) – The new version for the cloned model.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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 info.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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 the application versions info.
Parameters: - app_id (str) – The application ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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.
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 users access list with the one sent in the body. If an empty list is sent, all access to other users will be removed.
Parameters: - app_id (str) – The application ID.
- emails (list[str]) – The email address of the users.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Bases:
object
PatternOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Adds one pattern to the specified application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- pattern (str) – The pattern text.
- intent (str) – The intent’s name which the pattern belongs to.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PatternRuleInfo or ClientRawResponse if raw=true
Return type: PatternRuleInfo or ClientRawResponse
Raises:
Adds a batch of patterns to the specified application.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- patterns (list[PatternRuleCreateObject]) – A JSON array containing patterns.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_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.
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 the patterns with the specified IDs.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- pattern_ids (list[str]) – The patterns IDs.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: OperationStatus or ClientRawResponse if raw=true
Return type: OperationStatus or ClientRawResponse
Raises:
Returns patterns to be retrieved for the specific intent.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- intent_id (str) – The intent classifier ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PatternRuleInfo] or ClientRawResponse
Raises:
Returns an application version’s patterns.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- skip (int) – The number of entries to skip. Default value is 0.
- take (int) – The number of entries to return. Maximum page size is 500. Default is 100.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PatternRuleInfo] or ClientRawResponse
Raises:
Updates a pattern.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- pattern_id (str) – The pattern ID.
- pattern (PatternRuleUpdateObject) – An object representing a pattern.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PatternRuleInfo or ClientRawResponse if raw=true
Return type: PatternRuleInfo or ClientRawResponse
Raises:
Updates patterns.
Parameters: - app_id (str) – The application ID.
- version_id (str) – The version ID.
- patterns (list[PatternRuleUpdateObject]) – An array represents the patterns.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[PatternRuleInfo] or ClientRawResponse
Raises: