[text analytics] Add redacted_text #13449
Merged
Conversation
This file contains 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
iscai-msft
requested review from
deyaaeldeen,
maririos,
kristapratico and
mssfang
ghost
added
the
| @@ -6,6 +6,7 @@ | |||
| - We are now targeting the service's v3.1-preview.1 API as the default. If you would like to still use version v3.0 of the service, | |||
| pass in `v3.0` to the kwarg `api_version` when creating your TextAnalyticsClient | |||
| - We have added an API `recognize_pii_entities` which returns entities containing personal information for a batch of documents. Only available for API version v3.1-preview.1 and up. | |||
| - In API version v3.1-preview.2 and up, the redacted text of the document is returned on the top-level result object through property `redacted_text` | |||
There was a problem hiding this comment.
This is only for PII, right? should we specify the top-level result object type?
There was a problem hiding this comment.
I can, I didn't think it was necessary, since this entry is actually showing up indented under the previous entry about the introduction of recognize_pii_entities. I'll add in the top level result object though, since there's one other docstring comment and I might as well fix both
kristapratico
previously approved these changes
Aug 31, 2020
maririos
reviewed
Aug 31, 2020
| @@ -141,6 +141,8 @@ class RecognizePiiEntitiesResult(DictMixin): | |||
| :ivar entities: Recognized PII entities in the document. | |||
| :vartype entities: | |||
| list[~azure.ai.textanalytics.PiiEntity] | |||
| :ivar str redacted_text: Returns the text of the input document with all of the PII information | |||
| redacted out. Only returned for api versions v3.1-preview.2 and up. | |||
There was a problem hiding this comment.
Suggested change
| redacted out. Only returned for api versions v3.1-preview.2 and up. | |
| redacted out. Only returned for API versions v3.1-preview.2 and up. |
maririos
previously approved these changes
Aug 31, 2020
mssfang
reviewed
Sep 1, 2020
sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities.py
Show resolved
Hide resolved
mssfang
previously approved these changes
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
dismissed stale reviews from mssfang, maririos, and kristapratico
via
224caa9
| @@ -52,7 +52,7 @@ class TextAnalyticsClient(TextAnalyticsClientBase): | |||
| https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview | |||
|
|
|||
| :param str endpoint: Supported Cognitive Services or Text Analytics resource | |||
| endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). | |||
| endpoints (protocol and hostname, for example: https://westus2.API.cognitive.microsoft.com). | |||
There was a problem hiding this comment.
probably don't want to capitalize API here
There was a problem hiding this comment.
oh rip, thanks should've been more careful
kristapratico
approved these changes
Sep 1, 2020
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) ...
rakshith91
pushed a commit
to rakshith91/azure-sdk-for-python
that referenced
this pull request
Sep 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #12994