Skip to content

Commit 632b4d8

Browse files
maririosmaririos
authored
[TA] Add None to PiiEntityDomainType and rename (Azure#21355)
* Add None to PiiEntityDomainType * remove type
1 parent 2143412 commit 632b4d8

File tree

8 files changed

+27
-16
lines changed

8 files changed

+27
-16
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Release History
22

33
## 5.1.0-beta.8 (Unreleased)
4+
### New features
5+
- Added value `None` to enum `PiiEntityDomainType` to allow user to specify no domain.
6+
47
### Breaking changes
58
- Renamed `StartAnalyzeBatchActions` to `StartAnalyzeActions`.
69
- Renamed `AnalyzeBatchActionsOperation` to `AnalyzeActionsOperation`.
@@ -13,6 +16,8 @@
1316
- `RecognizeLinkedEntitiesOptions` changed to new type `RecognizeLinkedEntitiesActions`.
1417
- `AnalyzeSentimentOptions` changed to new type `AnalyzeSentimentActions`.
1518
- Renamed type `TextAnalyticsActionDetails` to `TextAnalyticsActionResult`.
19+
- Changed type `RecognizePiiEntitiesOptions.DomainFilter` from `PiiEntityDomainType?` to `PiiEntityDomainType`.
20+
- Renamed type `PiiEntityDomainType` to `PiiEntityDomain`.
1621

1722
## 5.1.0-beta.7 (2021-05-18)
1823
### New features

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -557,9 +557,10 @@ internal PiiEntityCollection() : base (default(System.Collections.Generic.IList<
557557
public string RedactedText { get { throw null; } }
558558
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.TextAnalyticsWarning> Warnings { get { throw null; } }
559559
}
560-
public enum PiiEntityDomainType
560+
public enum PiiEntityDomain
561561
{
562-
ProtectedHealthInformation = 0,
562+
None = 0,
563+
ProtectedHealthInformation = 1,
563564
}
564565
public partial class RecognizeEntitiesAction : Azure.AI.TextAnalytics.RecognizeEntitiesOptions
565566
{
@@ -622,7 +623,7 @@ public partial class RecognizePiiEntitiesOptions : Azure.AI.TextAnalytics.TextAn
622623
{
623624
public RecognizePiiEntitiesOptions() { }
624625
public System.Collections.Generic.IList<Azure.AI.TextAnalytics.PiiEntityCategory> CategoriesFilter { get { throw null; } }
625-
public Azure.AI.TextAnalytics.PiiEntityDomainType? DomainFilter { get { throw null; } set { } }
626+
public Azure.AI.TextAnalytics.PiiEntityDomain DomainFilter { get { throw null; } set { } }
626627
}
627628
public partial class RecognizePiiEntitiesResult : Azure.AI.TextAnalytics.TextAnalyticsResult
628629
{

sdk/textanalytics/Azure.AI.TextAnalytics/src/PiiEntityDomainType.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/PiiEntityDomain.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ namespace Azure.AI.TextAnalytics
66
/// <summary>
77
/// The different domains of PII entities that users can filter requests by.
88
/// </summary>
9-
public enum PiiEntityDomainType
9+
public enum PiiEntityDomain
1010
{
11+
/// <summary>
12+
/// Don't apply any domain filter. This is the default value.
13+
/// </summary>
14+
None,
1115
/// <summary>
1216
/// Protected Health Information entities.
1317
/// For more information see <see href="https://aka.ms/tanerpii"/>.
@@ -16,13 +20,14 @@ public enum PiiEntityDomainType
1620
}
1721

1822
[System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:File name should match first type name", Justification = "Small extensions, good to keep here.")]
19-
internal static class PiiEntityDomainTypeExtensions
23+
internal static class PiiEntityDomainExtensions
2024
{
21-
internal static string GetString(this PiiEntityDomainType type)
25+
internal static string GetString(this PiiEntityDomain type)
2226
{
2327
return type switch
2428
{
25-
PiiEntityDomainType.ProtectedHealthInformation => "phi",
29+
PiiEntityDomain.None => null,
30+
PiiEntityDomain.ProtectedHealthInformation => "phi",
2631
_ => null,
2732
};
2833
}

‎sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizePiiEntitiesOptions.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public RecognizePiiEntitiesOptions()
2626
/// Filters the response entities to ones only included in the specified domain.
2727
/// For more information see <see href="https://aka.ms/tanerpii"/>.
2828
/// </summary>
29-
public PiiEntityDomainType? DomainFilter { get; set; }
29+
public PiiEntityDomain DomainFilter { get; set; }
3030

3131
/// <summary>
3232
/// Filters the response entities to entities that match the <see cref="PiiEntityCategory"/> specified.

‎sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ public virtual async Task<Response<PiiEntityCollection>> RecognizePiiEntitiesAsy
910910
options.ModelVersion,
911911
options.IncludeStatistics,
912912
options.DisableServiceLogs,
913-
options.DomainFilter.HasValue ? options.DomainFilter.Value.GetString() : null,
913+
options.DomainFilter.GetString(),
914914
options.StringIndexType,
915915
options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
916916
cancellationToken: cancellationToken).ConfigureAwait(false);
@@ -977,7 +977,7 @@ public virtual Response<PiiEntityCollection> RecognizePiiEntities(string documen
977977
options.ModelVersion,
978978
options.IncludeStatistics,
979979
options.DisableServiceLogs,
980-
options.DomainFilter.HasValue ? options.DomainFilter.Value.GetString() : null,
980+
options.DomainFilter.GetString(),
981981
options.StringIndexType,
982982
options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
983983
cancellationToken: cancellationToken);
@@ -1145,7 +1145,7 @@ private async Task<Response<RecognizePiiEntitiesResultCollection>> RecognizePiiE
11451145
options.ModelVersion,
11461146
options.IncludeStatistics,
11471147
options.DisableServiceLogs,
1148-
options.DomainFilter.HasValue ? options.DomainFilter.Value.GetString() : null,
1148+
options.DomainFilter.GetString(),
11491149
options.StringIndexType,
11501150
options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
11511151
cancellationToken).ConfigureAwait(false);
@@ -1174,7 +1174,7 @@ private Response<RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch
11741174
options.ModelVersion,
11751175
options.IncludeStatistics,
11761176
options.DisableServiceLogs,
1177-
options.DomainFilter.HasValue ? options.DomainFilter.Value.GetString() : null,
1177+
options.DomainFilter.GetString(),
11781178
options.StringIndexType,
11791179
options.CategoriesFilter.Count == 0 ? null : options.CategoriesFilter,
11801180
cancellationToken);

‎sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ internal static PiiTask ConvertToPiiTask(RecognizePiiEntitiesAction action)
326326
{
327327
Parameters = new PiiTaskParameters()
328328
{
329-
Domain = action.DomainFilter.HasValue ? action.DomainFilter.Value.GetString() : (PiiTaskParametersDomain?)null,
329+
Domain = action.DomainFilter.GetString() ?? (PiiTaskParametersDomain?)null,
330330
ModelVersion = action.ModelVersion,
331331
StringIndexType = action.StringIndexType,
332332
LoggingOptOut = action.DisableServiceLogs

‎sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ public async Task AnalyzeOperationWithPHIDomain()
415415

416416
TextAnalyticsActions batchActions = new TextAnalyticsActions()
417417
{
418-
RecognizePiiEntitiesActions = new List<RecognizePiiEntitiesAction>() { new RecognizePiiEntitiesAction() { DomainFilter = PiiEntityDomainType.ProtectedHealthInformation } },
418+
RecognizePiiEntitiesActions = new List<RecognizePiiEntitiesAction>() { new RecognizePiiEntitiesAction() { DomainFilter = PiiEntityDomain.ProtectedHealthInformation } },
419419
DisplayName = "AnalyzeOperationWithPHIDomain",
420420
};
421421

‎sdk/textanalytics/Azure.AI.TextAnalytics/tests/RecognizePiiEntitiesTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public async Task RecognizePiiEntitiesWithDomainTest()
8181
TextAnalyticsClient client = GetClient();
8282
string document = "I work at Microsoft and my email is atest@microsoft.com";
8383

84-
PiiEntityCollection entities = await client.RecognizePiiEntitiesAsync(document, "en", new RecognizePiiEntitiesOptions() { DomainFilter = PiiEntityDomainType.ProtectedHealthInformation } );
84+
PiiEntityCollection entities = await client.RecognizePiiEntitiesAsync(document, "en", new RecognizePiiEntitiesOptions() { DomainFilter = PiiEntityDomain.ProtectedHealthInformation } );
8585

8686
ValidateInDocumenResult(entities, new List<string>() { "atest@microsoft.com", "Microsoft" });
8787
}
@@ -206,7 +206,7 @@ public async Task RecognizePiiEntitiesBatchWithDomainTest()
206206
{
207207
TextAnalyticsClient client = GetClient();
208208

209-
RecognizePiiEntitiesResultCollection results = await client.RecognizePiiEntitiesBatchAsync(s_batchDocuments, new RecognizePiiEntitiesOptions() { DomainFilter = PiiEntityDomainType.ProtectedHealthInformation });
209+
RecognizePiiEntitiesResultCollection results = await client.RecognizePiiEntitiesBatchAsync(s_batchDocuments, new RecognizePiiEntitiesOptions() { DomainFilter = PiiEntityDomain.ProtectedHealthInformation });
210210

211211
var expectedOutput = new Dictionary<string, List<string>>()
212212
{

0 commit comments

Comments
 (0)