[text analytics] add domain_filter param#13451
Merged
iscai-msft merged 5 commits intoAzure:masterfrom Sep 1, 2020
Merged
Conversation
iscai-msft
requested review from
deyaaeldeen,
kristapratico,
maririos and
mssfang
ghost
added
the
|
|
||
| class PiiEntityDomainType(str, Enum): | ||
| """The different domains of PII entities that users can filter by""" | ||
| PHI = "PHI" |
Contributor
There was a problem hiding this comment.
can we include a comment for PHI about what it stands for?
Member
There was a problem hiding this comment.
According to the Framework Design Guidance:
"Do not use abbreviations or acronyms in identifies. [...] It is more important for names to be readable than it is for them to be brief. I t is equally important not to use abbreviations and acronyms that are not generally understood"
Because of that, we should rename PHI to ProtectedHealthInformation
Contributor
Author
There was a problem hiding this comment.
I feel like PHI fits better in this case though, since we're abbreviating PII
Member
There was a problem hiding this comment.
Even between us we've asked multiple times what PHI is. Pii is more common, so I strongly recommend changing it.
For .NET I will use the complete name
Contributor
Author
There was a problem hiding this comment.
ok, since .NET is using the full name, I'll make the change
sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py
Outdated
Show resolved
Hide resolved
| :keyword domain_filter: Filters the response entities to ones only included in your specified domain. | ||
| I.e., if set to 'PHI', will only return entities in the Personal Healthcare Information domain. | ||
| Currently only supports 'PHI'. See https://aka.ms/tanerpii for more information. | ||
| :paramtype domain_filter: str or ~azure.ai.textanalytics.PiiEntityDomainType |
Contributor
There was a problem hiding this comment.
Do we need the same :versionadded: directive here?
Contributor
Author
There was a problem hiding this comment.
No, they had it on v3.1-preview.1, just never supported it
maririos
reviewed
Aug 31, 2020
sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py
Outdated
Show resolved
Hide resolved
maririos
reviewed
Aug 31, 2020
sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py
Outdated
Show resolved
Hide resolved
maririos
approved these changes
Aug 31, 2020
mssfang
approved these changes
Sep 1, 2020
iscai-msft
added a commit
to iscai-msft/azure-sdk-for-python
that referenced
this pull request
Sep 1, 2020
…into add_redacted_text * 'master' of https://github.com/Azure/azure-sdk-for-python: [text analytics] add bing_id property to LinkedEntity class (Azure#13446) fix typing for paging methods (Azure#13410) [text analytics] add domain_filter param (Azure#13451) fix issue Azure#11658 for is_valid_resource_id (Azure#11709) added create_table_if_not_exists method to table service client (Azure#13385) [ServiceBus] Test and failure improvements (Azure#13345) Proper encoding and decoding of source URLs - Fixes special characters in source URL issue (Azure#13275) Switch retry (Azure#13264) [ServiceBus] ServiceBusClient close spawned children (Azure#13077) fixing version issue by not overwriting the version with the semantic… (Azure#13411)
iscai-msft
added a commit
to iscai-msft/azure-sdk-for-python
that referenced
this pull request
Sep 1, 2020
…into expose_parse_vault_id * 'master' of https://github.com/Azure/azure-sdk-for-python: (37 commits) [text analytics] add versionadded sphinx documentation (Azure#13450) [text analytics] add bing_id property to LinkedEntity class (Azure#13446) fix typing for paging methods (Azure#13410) [text analytics] add domain_filter param (Azure#13451) fix issue Azure#11658 for is_valid_resource_id (Azure#11709) added create_table_if_not_exists method to table service client (Azure#13385) [ServiceBus] Test and failure improvements (Azure#13345) Proper encoding and decoding of source URLs - Fixes special characters in source URL issue (Azure#13275) Switch retry (Azure#13264) [ServiceBus] ServiceBusClient close spawned children (Azure#13077) fixing version issue by not overwriting the version with the semantic… (Azure#13411) clean up reference and tests (Azure#13412) Consistent returns (Azure#13245) [text analytics] return None for offset and length for v3.0 (Azure#13382) edit all authentication files and add a test (Azure#13355) Add managed_identity_client_id argument to DefaultAzureCredential (Azure#13218) [text analytics] add string-index-type support (Azure#13378) [text analytics] fix error response if pii entities is called from v3.0 client (Azure#13383) Send spec (Azure#13143) Anomaly Detector 3.0.0b2 release (Azure#13351) ...
iscai-msft
added a commit
to iscai-msft/azure-sdk-for-python
that referenced
this pull request
Sep 2, 2020
…into link_om_sample * 'master' of https://github.com/Azure/azure-sdk-for-python: (23 commits) Int32 serialization (Azure#13452) add output to opinion mining sample (Azure#13494) Add Document w/ Eng Sys Checks (Azure#13492) update version (Azure#13495) Remove resources post test (Azure#13379) bing_id -> bing_entity_search_api_id (Azure#13491) [EventGrid] Read me + improve docstrings (Azure#13484) Build AuthenticationRecords from ADFS identity tokens (Azure#13341) Support Subject Name/Issuer authentication (Azure#13350) Add KeyVaultAccessControlClient for data plane RBAC (Azure#13372) [text analytics] Add redacted_text (Azure#13449) add python sdk sample (Azure#13338) [text analytics] add versionadded sphinx documentation (Azure#13450) [text analytics] add bing_id property to LinkedEntity class (Azure#13446) fix typing for paging methods (Azure#13410) [text analytics] add domain_filter param (Azure#13451) fix issue Azure#11658 for is_valid_resource_id (Azure#11709) added create_table_if_not_exists method to table service client (Azure#13385) [ServiceBus] Test and failure improvements (Azure#13345) Proper encoding and decoding of source URLs - Fixes special characters in source URL issue (Azure#13275) ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #13409