[TA] Add pii category to simple api (Azure#19087)

* add pii category to simple api

* add changelog

* pr feedback

Author: maririos

sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md

@@ -1,10 +1,14 @@
 # Release History
 
 ## 5.1.0-beta.5 (Unreleased)
+### New features
+- Added ability to filter the categories returned in a Personally Identifiable Information recognition with the optional parameter `CategoriesFilter` in `RecognizePiiEntitiesOptions`.
+
 ### Breaking changes
 - Renamed `AspectSentiment` to `TargetSentiment`.
 - Renamed `MinedOpinion` to `SentenceOpinion`.
 - Renamed `OpinionSentiment` to `AssessmentSentiment`.
+- For `PiiEntity.Category` the type of the property is now `PiiEntityCategory` instead of `EntityCategory`.
 
 ## 5.1.0-beta.4 (2021-02-10)
 ### New features

sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs

@@ -191,6 +191,7 @@ Console.WriteLine("");
 To see the full example source files, see:
 * [Synchronous RecognizePiiEntities](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntities.cs)
 * [Asynchronous RecognizePiiEntities](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntitiesAsync.cs)
+* [Recognize PII Entities with specific categories](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntitiesWithCategoriesFilter.cs)
 * [Synchronous RecognizePiiEntitiesBatch](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntitiesBatch.cs)
 * [Asynchronous RecognizePiiEntitiesBatch](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntitiesBatchAsync.cs)
 * [Synchronous RecognizePiiEntitiesBatchConvenience](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample5_RecognizePiiEntitiesBatchConvenience.cs)

sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample5_RecognizePiiEntities.md

@@ -29,13 +29,13 @@ internal PiiEntity(Entity entity)
         public string Text { get; }
 
         /// <summary>
-        /// Gets the entity category inferred by the Text Analytics service's
+        /// Gets the PII entity category inferred by the Text Analytics service's
         /// named entity recognition model, such as Financial Account
         /// Identification/Social Security Number/Phone Number, etc.
         /// The list of available categories is described at
         /// <a href="https://aka.ms/tanerpii"/>.
         /// </summary>
-        public EntityCategory Category { get; }
+        public PiiEntityCategory Category { get; }
 
         /// <summary>
         /// Gets the sub category of the entity inferred by the Text Analytics service's

…tics/src/Generated/Models/PiiCategory.cs …rc/Generated/Models/PiiEntityCategory.cssdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/Models/PiiCategory.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/Models/PiiEntityCategory.cs sdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/Models/PiiCategory.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/Models/PiiEntityCategory.cs

@@ -3,10 +3,10 @@
 
 using Azure.Core;
 
-namespace Azure.AI.TextAnalytics.Models
+namespace Azure.AI.TextAnalytics
 {
     [CodeGenModel("PiiCategory")]
-    internal readonly partial struct PiiCategory
+    public readonly partial struct PiiEntityCategory
     {
     }
 }

sdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/Models/PiiTaskParameters.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System.Collections.Generic;
+
 namespace Azure.AI.TextAnalytics
 {
     /// <summary>
@@ -25,5 +27,10 @@ public RecognizePiiEntitiesOptions()
         /// For more information see <a href="https://aka.ms/tanerpii"/>.
         /// </summary>
         public PiiEntityDomainType DomainFilter { get; set; }
+
+        /// <summary>
+        /// Filters the response entities to entities that match the <see cref="PiiEntityCategory"/> specified.
+        /// </summary>
+        public IList<PiiEntityCategory> CategoriesFilter { get; internal set; } = new List<PiiEntityCategory>();
     }
 }

sdk/textanalytics/Azure.AI.TextAnalytics/src/Generated/TextAnalyticsRestClient.cs

@@ -737,6 +737,7 @@ public virtual async Task<Response<PiiEntityCollection>> RecognizePiiEntitiesAsy
                     options.IncludeStatistics,
                     options.DomainFilter.GetString(),
                     options.StringIndexType,
+                    options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
                     cancellationToken: cancellationToken).ConfigureAwait(false);
                 Response response = result.GetRawResponse();
 
@@ -802,6 +803,7 @@ public virtual Response<PiiEntityCollection> RecognizePiiEntities(string documen
                     options.IncludeStatistics,
                     options.DomainFilter.GetString(),
                     options.StringIndexType,
+                    options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
                     cancellationToken: cancellationToken);
                 Response response = result.GetRawResponse();
 
@@ -968,7 +970,7 @@ private async Task<Response<RecognizePiiEntitiesResultCollection>> RecognizePiiE
                     options.IncludeStatistics,
                     options.DomainFilter.GetString(),
                     options.StringIndexType,
-                    default, // TODO: Implement PIICategory for Preview.4 https://github.com/Azure/azure-sdk-for-net/issues/18985
+                    options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
                     cancellationToken).ConfigureAwait(false);
                 var response = result.GetRawResponse();
 
@@ -996,7 +998,7 @@ private Response<RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch
                     options.IncludeStatistics,
                     options.DomainFilter.GetString(),
                     options.StringIndexType,
-                    default, // TODO: Implement PIICategory for Preview.4 https://github.com/Azure/azure-sdk-for-net/issues/18985
+                    options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
                     cancellationToken);
                 var response = result.GetRawResponse();