Skip to content

Commit

Permalink
update link to pii entity categories (Azure#27646)
Browse files Browse the repository at this point in the history
  • Loading branch information
kristapratico authored Nov 23, 2022
1 parent 4654e35 commit 77757f5
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 7 deletions.
2 changes: 1 addition & 1 deletion sdk/textanalytics/azure-ai-textanalytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[key_phrase_extraction]: https://docs.microsoft.com/azure/cognitive-services/language-service/key-phrase-extraction/overview
[linked_entities_categories]: https://aka.ms/taner
[linked_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/language-service/entity-linking/overview
[pii_entity_categories]: https://aka.ms/tanerpii
[pii_entity_categories]: https://aka.ms/azsdk/language/pii
[named_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/overview
[named_entity_categories]: https://aka.ms/taner
[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ class PiiEntityDomain(str, Enum, metaclass=CaseInsensitiveEnumMeta):
"""The different domains of PII entities that users can filter by"""

PROTECTED_HEALTH_INFORMATION = (
"phi" # See https://aka.ms/tanerpii for more information.
"phi" # See https://aka.ms/azsdk/language/pii for more information.
)


Expand Down Expand Up @@ -2009,7 +2009,7 @@ def _to_generated(self, api_version, task_id):

class RecognizePiiEntitiesAction(DictMixin):
"""RecognizePiiEntitiesAction encapsulates the parameters for starting a long-running PII
Entities Recognition operation.
Entities Recognition operation. See more information in the service docs: https://aka.ms/azsdk/language/pii
If you just want to recognize pii entities in a list of documents, and not perform multiple
long running actions on the input of documents, call method `recognize_pii_entities` instead
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ def recognize_pii_entities(
Returns a list of personal information entities ("SSN",
"Bank Account", etc) in the document. For the list of supported entity types,
check https://aka.ms/tanerpii
check https://aka.ms/azsdk/language/pii
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
Expand All @@ -403,7 +403,7 @@ def recognize_pii_entities(
level statistics in the `statistics` field of the document-level response.
:keyword domain_filter: Filters the response entities to ones only included in the specified domain.
I.e., if set to 'phi', will only return entities in the Protected Healthcare Information domain.
See https://aka.ms/tanerpii for more information.
See https://aka.ms/azsdk/language/pii for more information.
:paramtype domain_filter: str or ~azure.ai.textanalytics.PiiEntityDomain
:keyword categories_filter: Instead of filtering over all PII entity categories, you can pass in a list of
the specific PII entity categories you want to filter out. For example, if you only want to filter out
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ async def recognize_pii_entities(
Returns a list of personal information entities ("SSN",
"Bank Account", etc) in the document. For the list of supported entity types,
check https://aka.ms/tanerpii
check https://aka.ms/azsdk/language/pii
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
Expand All @@ -398,7 +398,7 @@ async def recognize_pii_entities(
level statistics in the `statistics` field of the document-level response.
:keyword domain_filter: Filters the response entities to ones only included in the specified domain.
I.e., if set to 'phi', will only return entities in the Protected Healthcare Information domain.
See https://aka.ms/tanerpii for more information.
See https://aka.ms/azsdk/language/pii for more information.
:paramtype domain_filter: str or ~azure.ai.textanalytics.PiiEntityDomain
:keyword categories_filter: Instead of filtering over all PII entity categories, you can pass in a list of
the specific PII entity categories you want to filter out. For example, if you only want to filter out
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
In this sample, we will be working for a company that handles loan payments. To follow privacy guidelines,
we need to redact all of our information before we make it public.
See more information in the service docs: https://aka.ms/azsdk/language/pii
USAGE:
python sample_recognize_pii_entities_async.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
In this sample, we will be working for a company that handles loan payments. To follow privacy guidelines,
we need to redact all of our information before we make it public.
See more information in the service docs: https://aka.ms/azsdk/language/pii
USAGE:
python sample_recognize_pii_entities.py
Expand Down

0 comments on commit 77757f5

Please sign in to comment.