Skip to content

Commit 825a081

Browse files
authored
disable ActionName (Azure#22311)
1 parent a9a6679 commit 825a081

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1098
-49630
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
### New features
55
- Added support for service version `3.0`. This can be specified in the `TextAnalyticsClientOptions` object under the `ServiceVersion` enum. By default the SDK targets latest supported service version.
66
- Added value `None` to enum `PiiEntityDomainType` to allow user to specify no domain.
7-
- Added property `ActionName` to all `xxActions` input types so user can specify a name per action. If not provided, service will generate a name.
8-
- Added property `ActionName` to all `xxActionResult` output types that displays the name of each action.
97
- Added new overload methods to all `xxActions` types that take a `xxOptions` object to facilitate a transition from a singular method to an actions method.
108
- The parameter `CategoriesFilter` in `RecognizePiiEntitiesActions` has been enabled for `StartAnalyzeActions` methods.
119

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -604,7 +604,6 @@ This functionality allows running multiple actions in one or more documents. Act
604604
int docNumber = 1;
605605
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
606606
{
607-
Console.WriteLine($" Action name: {entitiesActionResults.ActionName}");
608607
foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
609608
{
610609
Console.WriteLine($" Document #{docNumber++}");
@@ -627,7 +626,6 @@ This functionality allows running multiple actions in one or more documents. Act
627626
docNumber = 1;
628627
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
629628
{
630-
Console.WriteLine($" Action name: {piiActionResults.ActionName}");
631629
foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
632630
{
633631
Console.WriteLine($" Document #{docNumber++}");
@@ -650,7 +648,6 @@ This functionality allows running multiple actions in one or more documents. Act
650648
docNumber = 1;
651649
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
652650
{
653-
Console.WriteLine($" Action name: {keyPhrasesActionResult.ActionName}");
654651
foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
655652
{
656653
Console.WriteLine($" Document #{docNumber++}");
@@ -668,7 +665,6 @@ This functionality allows running multiple actions in one or more documents. Act
668665
docNumber = 1;
669666
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingResults)
670667
{
671-
Console.WriteLine($" Action name: {linkedEntitiesActionResults.ActionName}");
672668
foreach (RecognizeLinkedEntitiesResult documentResults in linkedEntitiesActionResults.DocumentsResults)
673669
{
674670
Console.WriteLine($" Document #{docNumber++}");
@@ -700,7 +696,6 @@ This functionality allows running multiple actions in one or more documents. Act
700696
docNumber = 1;
701697
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
702698
{
703-
Console.WriteLine($" Action name: {analyzeSentimentActionsResult.ActionName}");
704699
foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
705700
{
706701
Console.WriteLine($" Document #{docNumber++}");

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

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ public partial class AnalyzeSentimentAction
8484
{
8585
public AnalyzeSentimentAction() { }
8686
public AnalyzeSentimentAction(Azure.AI.TextAnalytics.AnalyzeSentimentOptions options) { }
87-
public string ActionName { get { throw null; } set { } }
8887
public bool? DisableServiceLogs { get { throw null; } set { } }
8988
public bool? IncludeOpinionMining { get { throw null; } set { } }
9089
public string ModelVersion { get { throw null; } set { } }
@@ -232,7 +231,6 @@ public partial class ExtractKeyPhrasesAction
232231
{
233232
public ExtractKeyPhrasesAction() { }
234233
public ExtractKeyPhrasesAction(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) { }
235-
public string ActionName { get { throw null; } set { } }
236234
public bool? DisableServiceLogs { get { throw null; } set { } }
237235
public string ModelVersion { get { throw null; } set { } }
238236
}
@@ -613,7 +611,6 @@ public partial class RecognizeEntitiesAction
613611
{
614612
public RecognizeEntitiesAction() { }
615613
public RecognizeEntitiesAction(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) { }
616-
public string ActionName { get { throw null; } set { } }
617614
public bool? DisableServiceLogs { get { throw null; } set { } }
618615
public string ModelVersion { get { throw null; } set { } }
619616
}
@@ -637,7 +634,6 @@ public partial class RecognizeLinkedEntitiesAction
637634
{
638635
public RecognizeLinkedEntitiesAction() { }
639636
public RecognizeLinkedEntitiesAction(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) { }
640-
public string ActionName { get { throw null; } set { } }
641637
public bool? DisableServiceLogs { get { throw null; } set { } }
642638
public string ModelVersion { get { throw null; } set { } }
643639
}
@@ -661,7 +657,6 @@ public partial class RecognizePiiEntitiesAction
661657
{
662658
public RecognizePiiEntitiesAction() { }
663659
public RecognizePiiEntitiesAction(Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options) { }
664-
public string ActionName { get { throw null; } set { } }
665660
public System.Collections.Generic.IList<Azure.AI.TextAnalytics.PiiEntityCategory> CategoriesFilter { get { throw null; } }
666661
public bool? DisableServiceLogs { get { throw null; } set { } }
667662
public Azure.AI.TextAnalytics.PiiEntityDomain DomainFilter { get { throw null; } set { } }
@@ -730,7 +725,6 @@ public readonly partial struct TargetSentiment
730725
public partial class TextAnalyticsActionResult
731726
{
732727
internal TextAnalyticsActionResult() { }
733-
public string ActionName { get { throw null; } }
734728
public System.DateTimeOffset CompletedOn { get { throw null; } }
735729
public Azure.AI.TextAnalytics.TextAnalyticsError Error { get { throw null; } }
736730
public bool HasError { get { throw null; } }
@@ -877,8 +871,8 @@ public static partial class TextAnalyticsModelFactory
877871
public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResult AnalyzeHealthcareEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.HealthcareEntity> healthcareEntities, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.HealthcareEntityRelation> entityRelations, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextAnalyticsWarning> warnings) { throw null; }
878872
public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResult AnalyzeHealthcareEntitiesResult(string id, string code, string message) { throw null; }
879873
public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResultCollection AnalyzeHealthcareEntitiesResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
880-
public static Azure.AI.TextAnalytics.AnalyzeSentimentActionResult AnalyzeSentimentActionResult(Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; }
881-
public static Azure.AI.TextAnalytics.AnalyzeSentimentActionResult AnalyzeSentimentActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; }
874+
public static Azure.AI.TextAnalytics.AnalyzeSentimentActionResult AnalyzeSentimentActionResult(Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection result, System.DateTimeOffset completedOn) { throw null; }
875+
public static Azure.AI.TextAnalytics.AnalyzeSentimentActionResult AnalyzeSentimentActionResult(System.DateTimeOffset completedOn, string code, string message) { throw null; }
882876
public static Azure.AI.TextAnalytics.AnalyzeSentimentResult AnalyzeSentimentResult(string id, Azure.AI.TextAnalytics.TextAnalyticsError error) { throw null; }
883877
public static Azure.AI.TextAnalytics.AnalyzeSentimentResult AnalyzeSentimentResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.DocumentSentiment documentSentiment) { throw null; }
884878
public static Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection AnalyzeSentimentResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.AnalyzeSentimentResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
@@ -893,8 +887,8 @@ public static partial class TextAnalyticsModelFactory
893887
public static Azure.AI.TextAnalytics.DetectLanguageResultCollection DetectLanguageResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
894888
public static Azure.AI.TextAnalytics.DocumentSentiment DocumentSentiment(Azure.AI.TextAnalytics.TextSentiment sentiment, double positiveScore, double neutralScore, double negativeScore, System.Collections.Generic.List<Azure.AI.TextAnalytics.SentenceSentiment> sentenceSentiments, System.Collections.Generic.IList<Azure.AI.TextAnalytics.TextAnalyticsWarning> warnings = null) { throw null; }
895889
public static Azure.AI.TextAnalytics.EntityDataSource EntityDataSource(string name = null, string entityId = null) { throw null; }
896-
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; }
897-
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; }
890+
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection result, System.DateTimeOffset completedOn) { throw null; }
891+
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(System.DateTimeOffset completedOn, string code, string message) { throw null; }
898892
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResult ExtractKeyPhrasesResult(string id, Azure.AI.TextAnalytics.TextAnalyticsError error) { throw null; }
899893
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResult ExtractKeyPhrasesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.KeyPhraseCollection keyPhrases) { throw null; }
900894
public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection ExtractKeyPhrasesResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.ExtractKeyPhrasesResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
@@ -912,18 +906,18 @@ public static partial class TextAnalyticsModelFactory
912906
public static Azure.AI.TextAnalytics.LinkedEntityMatch LinkedEntityMatch(string text, double score, int offset, int length) { throw null; }
913907
public static Azure.AI.TextAnalytics.PiiEntity PiiEntity(string text, string category, string subCategory, double score, int offset, int length) { throw null; }
914908
public static Azure.AI.TextAnalytics.PiiEntityCollection PiiEntityCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.PiiEntity> entities, string redactedText, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextAnalyticsWarning> warnings = null) { throw null; }
915-
public static Azure.AI.TextAnalytics.RecognizeEntitiesActionResult RecognizeEntitiesActionResult(Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; }
916-
public static Azure.AI.TextAnalytics.RecognizeEntitiesActionResult RecognizeEntitiesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; }
909+
public static Azure.AI.TextAnalytics.RecognizeEntitiesActionResult RecognizeEntitiesActionResult(Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection result, System.DateTimeOffset completedOn) { throw null; }
910+
public static Azure.AI.TextAnalytics.RecognizeEntitiesActionResult RecognizeEntitiesActionResult(System.DateTimeOffset completedOn, string code, string message) { throw null; }
917911
public static Azure.AI.TextAnalytics.RecognizeEntitiesResult RecognizeEntitiesResult(string id, Azure.AI.TextAnalytics.TextAnalyticsError error) { throw null; }
918912
public static Azure.AI.TextAnalytics.RecognizeEntitiesResult RecognizeEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.CategorizedEntityCollection entities) { throw null; }
919913
public static Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection RecognizeEntitiesResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.RecognizeEntitiesResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
920-
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult RecognizeLinkedEntitiesActionResult(Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; }
921-
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult RecognizeLinkedEntitiesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; }
914+
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult RecognizeLinkedEntitiesActionResult(Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection result, System.DateTimeOffset completedOn) { throw null; }
915+
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult RecognizeLinkedEntitiesActionResult(System.DateTimeOffset completedOn, string code, string message) { throw null; }
922916
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResult RecognizeLinkedEntitiesResult(string id, Azure.AI.TextAnalytics.TextAnalyticsError error) { throw null; }
923917
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResult RecognizeLinkedEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.LinkedEntityCollection linkedEntities) { throw null; }
924918
public static Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection RecognizeLinkedEntitiesResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }
925-
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult RecognizePiiEntitiesActionResult(Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; }
926-
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult RecognizePiiEntitiesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; }
919+
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult RecognizePiiEntitiesActionResult(Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection result, System.DateTimeOffset completedOn) { throw null; }
920+
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult RecognizePiiEntitiesActionResult(System.DateTimeOffset completedOn, string code, string message) { throw null; }
927921
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesResult RecognizePiiEntitiesResult(string id, Azure.AI.TextAnalytics.TextAnalyticsError error) { throw null; }
928922
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesResult RecognizePiiEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.PiiEntityCollection entities) { throw null; }
929923
public static Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection RecognizePiiEntitiesResultCollection(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.RecognizePiiEntitiesResult> list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; }

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
7070
int docNumber = 1;
7171
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
7272
{
73-
Console.WriteLine($" Action name: {entitiesActionResults.ActionName}");
7473
foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
7574
{
7675
Console.WriteLine($" Document #{docNumber++}");
@@ -93,7 +92,6 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
9392
docNumber = 1;
9493
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
9594
{
96-
Console.WriteLine($" Action name: {piiActionResults.ActionName}");
9795
foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
9896
{
9997
Console.WriteLine($" Document #{docNumber++}");
@@ -116,7 +114,6 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
116114
docNumber = 1;
117115
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
118116
{
119-
Console.WriteLine($" Action name: {keyPhrasesActionResult.ActionName}");
120117
foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
121118
{
122119
Console.WriteLine($" Document #{docNumber++}");
@@ -134,7 +131,6 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
134131
docNumber = 1;
135132
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingResults)
136133
{
137-
Console.WriteLine($" Action name: {linkedEntitiesActionResults.ActionName}");
138134
foreach (RecognizeLinkedEntitiesResult documentResults in linkedEntitiesActionResults.DocumentsResults)
139135
{
140136
Console.WriteLine($" Document #{docNumber++}");
@@ -166,7 +162,6 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
166162
docNumber = 1;
167163
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
168164
{
169-
Console.WriteLine($" Action name: {analyzeSentimentActionsResult.ActionName}");
170165
foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
171166
{
172167
Console.WriteLine($" Document #{docNumber++}");

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentAction.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,5 @@ public AnalyzeSentimentAction(AnalyzeSentimentOptions options)
6262
/// This property only has value for <see cref="TextAnalyticsClientOptions.ServiceVersion.V3_1"/> and up.
6363
/// </remarks>
6464
public bool? IncludeOpinionMining { get; set; }
65-
66-
/// <summary>
67-
/// Gets or sets a name for this action. If not provided, the service will generate one.
68-
/// </summary>
69-
public string ActionName { get; set; }
7065
}
7166
}

0 commit comments

Comments
 (0)