[text analytics] Add redacted_text#13449
Conversation
| - 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
| :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.
| 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. |
sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities.py
Show resolved
Hide resolved
mssfang
left a comment
There was a problem hiding this comment.
Just one comment about the the explored endpoint. Beside that, LGTM
…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)
224caa9
|
|
||
| :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
…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) ...
fixes #12994