Skip to content

Commit 729b709

Browse files
authored
[TA] Rename xxActionsResults to xxResults in AnalyzeActionsResult (Azure#21807)
1 parent 7f31a2e commit 729b709

11 files changed

+106
-105
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- Renamed type `TextAnalyticsActionDetails` to `TextAnalyticsActionResult`.
2020
- Renamed type `PiiEntityDomainType` to `PiiEntityDomain`.
2121
- Renamed type `Results` to `DocumentsResults` in `AnalyzeSentimentActionResult`, `ExtractKeyPhrasesActionResult`, `RecognizeEntitiesActionResult`, `RecognizeLinkedEntitiesActionResult`, and `RecognizePiiEntitiesActionResult`.
22+
- Renamed all types under `AnalyzeActionsResult` from `xxActionsResults` to ``xxResults`.
2223
- Changed type `RecognizePiiEntitiesOptions.DomainFilter` from `PiiEntityDomainType?` to `PiiEntityDomainType`.
2324
- Changed type `AnalyzeActionsOptions.IncludeStatistics` from `bool` to `bool?`.
2425
- Removed property `Statistics` from `AnalyzeActionsResult` as it is not currently returned by the service even if the user passes `IncludeStatistics = true`.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -602,15 +602,15 @@ This functionality allows running multiple actions in one or more documents. Act
602602

603603
await foreach (AnalyzeActionsResult documentsInPage in operation.Value)
604604
{
605-
IReadOnlyCollection<ExtractKeyPhrasesActionResult> keyPhrasesActionsResults = documentsInPage.ExtractKeyPhrasesActionsResults;
606-
IReadOnlyCollection<RecognizeEntitiesActionResult> entitiesActionsResults = documentsInPage.RecognizeEntitiesActionsResults;
607-
IReadOnlyCollection<RecognizePiiEntitiesActionResult> piiActionsResults = documentsInPage.RecognizePiiEntitiesActionsResults;
608-
IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> entityLinkingActionsResults = documentsInPage.RecognizeLinkedEntitiesActionsResults;
609-
IReadOnlyCollection<AnalyzeSentimentActionResult> analyzeSentimentActionsResults = documentsInPage.AnalyzeSentimentActionsResults;
605+
IReadOnlyCollection<ExtractKeyPhrasesActionResult> keyPhrasesResults = documentsInPage.ExtractKeyPhrasesResults;
606+
IReadOnlyCollection<RecognizeEntitiesActionResult> entitiesResults = documentsInPage.RecognizeEntitiesResults;
607+
IReadOnlyCollection<RecognizePiiEntitiesActionResult> piiResults = documentsInPage.RecognizePiiEntitiesResults;
608+
IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> entityLinkingResults = documentsInPage.RecognizeLinkedEntitiesResults;
609+
IReadOnlyCollection<AnalyzeSentimentActionResult> analyzeSentimentResults = documentsInPage.AnalyzeSentimentResults;
610610

611611
Console.WriteLine("Recognized Entities");
612612
int docNumber = 1;
613-
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesActionsResults)
613+
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
614614
{
615615
foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
616616
{
@@ -632,7 +632,7 @@ This functionality allows running multiple actions in one or more documents. Act
632632

633633
Console.WriteLine("Recognized PII Entities");
634634
docNumber = 1;
635-
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiActionsResults)
635+
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
636636
{
637637
foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
638638
{
@@ -654,7 +654,7 @@ This functionality allows running multiple actions in one or more documents. Act
654654

655655
Console.WriteLine("Key Phrases");
656656
docNumber = 1;
657-
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesActionsResults)
657+
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
658658
{
659659
foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
660660
{
@@ -671,7 +671,7 @@ This functionality allows running multiple actions in one or more documents. Act
671671

672672
Console.WriteLine("Recognized Linked Entities");
673673
docNumber = 1;
674-
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingActionsResults)
674+
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingResults)
675675
{
676676
foreach (RecognizeLinkedEntitiesResult documentResults in linkedEntitiesActionResults.DocumentsResults)
677677
{
@@ -702,7 +702,7 @@ This functionality allows running multiple actions in one or more documents. Act
702702

703703
Console.WriteLine("Analyze Sentiment");
704704
docNumber = 1;
705-
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentActionsResults)
705+
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
706706
{
707707
foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
708708
{

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ public AnalyzeActionsOptions() { }
3434
public partial class AnalyzeActionsResult
3535
{
3636
internal AnalyzeActionsResult() { }
37-
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.AnalyzeSentimentActionResult> AnalyzeSentimentActionsResults { get { throw null; } }
38-
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult> ExtractKeyPhrasesActionsResults { get { throw null; } }
39-
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeEntitiesActionResult> RecognizeEntitiesActionsResults { get { throw null; } }
40-
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesActionsResults { get { throw null; } }
41-
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult> RecognizePiiEntitiesActionsResults { get { throw null; } }
37+
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.AnalyzeSentimentActionResult> AnalyzeSentimentResults { get { throw null; } }
38+
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult> ExtractKeyPhrasesResults { get { throw null; } }
39+
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeEntitiesActionResult> RecognizeEntitiesResults { get { throw null; } }
40+
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesResults { get { throw null; } }
41+
public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult> RecognizePiiEntitiesResults { get { throw null; } }
4242
}
4343
public partial class AnalyzeHealthcareEntitiesOperation : Azure.PageableOperation<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResultCollection>
4444
{

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
6060

6161
await foreach (AnalyzeActionsResult documentsInPage in operation.Value)
6262
{
63-
IReadOnlyCollection<ExtractKeyPhrasesActionResult> keyPhrasesActionsResults = documentsInPage.ExtractKeyPhrasesActionsResults;
64-
IReadOnlyCollection<RecognizeEntitiesActionResult> entitiesActionsResults = documentsInPage.RecognizeEntitiesActionsResults;
65-
IReadOnlyCollection<RecognizePiiEntitiesActionResult> piiActionsResults = documentsInPage.RecognizePiiEntitiesActionsResults;
66-
IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> entityLinkingActionsResults = documentsInPage.RecognizeLinkedEntitiesActionsResults;
67-
IReadOnlyCollection<AnalyzeSentimentActionResult> analyzeSentimentActionsResults = documentsInPage.AnalyzeSentimentActionsResults;
63+
IReadOnlyCollection<ExtractKeyPhrasesActionResult> keyPhrasesResults = documentsInPage.ExtractKeyPhrasesResults;
64+
IReadOnlyCollection<RecognizeEntitiesActionResult> entitiesResults = documentsInPage.RecognizeEntitiesResults;
65+
IReadOnlyCollection<RecognizePiiEntitiesActionResult> piiResults = documentsInPage.RecognizePiiEntitiesResults;
66+
IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> entityLinkingResults = documentsInPage.RecognizeLinkedEntitiesResults;
67+
IReadOnlyCollection<AnalyzeSentimentActionResult> analyzeSentimentResults = documentsInPage.AnalyzeSentimentResults;
6868

6969
Console.WriteLine("Recognized Entities");
7070
int docNumber = 1;
71-
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesActionsResults)
71+
foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
7272
{
7373
foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
7474
{
@@ -90,7 +90,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
9090

9191
Console.WriteLine("Recognized PII Entities");
9292
docNumber = 1;
93-
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiActionsResults)
93+
foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
9494
{
9595
foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
9696
{
@@ -112,7 +112,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
112112

113113
Console.WriteLine("Key Phrases");
114114
docNumber = 1;
115-
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesActionsResults)
115+
foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
116116
{
117117
foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
118118
{
@@ -129,7 +129,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
129129

130130
Console.WriteLine("Recognized Linked Entities");
131131
docNumber = 1;
132-
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingActionsResults)
132+
foreach (RecognizeLinkedEntitiesActionResult linkedEntitiesActionResults in entityLinkingResults)
133133
{
134134
foreach (RecognizeLinkedEntitiesResult documentResults in linkedEntitiesActionResults.DocumentsResults)
135135
{
@@ -160,7 +160,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
160160

161161
Console.WriteLine("Analyze Sentiment");
162162
docNumber = 1;
163-
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentActionsResults)
163+
foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
164164
{
165165
foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
166166
{

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,36 @@ internal AnalyzeActionsResult(
1717
IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> recognizeLinkedEntitiesActionsResults,
1818
IReadOnlyCollection<AnalyzeSentimentActionResult> analyzeSentimentActionsResults)
1919
{
20-
ExtractKeyPhrasesActionsResults = extractKeyPhrasesActionResult;
21-
RecognizeEntitiesActionsResults = recognizeEntitiesActionResults;
22-
RecognizePiiEntitiesActionsResults = recognizePiiEntitiesActionResults;
23-
RecognizeLinkedEntitiesActionsResults = recognizeLinkedEntitiesActionsResults;
24-
AnalyzeSentimentActionsResults = analyzeSentimentActionsResults;
20+
ExtractKeyPhrasesResults = extractKeyPhrasesActionResult;
21+
RecognizeEntitiesResults = recognizeEntitiesActionResults;
22+
RecognizePiiEntitiesResults = recognizePiiEntitiesActionResults;
23+
RecognizeLinkedEntitiesResults = recognizeLinkedEntitiesActionsResults;
24+
AnalyzeSentimentResults = analyzeSentimentActionsResults;
2525
}
2626

2727
/// <summary>
2828
/// Determines the collection of <see cref="ExtractKeyPhrasesActionResult"/>.
2929
/// </summary>
30-
public IReadOnlyCollection<ExtractKeyPhrasesActionResult> ExtractKeyPhrasesActionsResults { get; }
30+
public IReadOnlyCollection<ExtractKeyPhrasesActionResult> ExtractKeyPhrasesResults { get; }
3131

3232
/// <summary>
3333
/// Determines the collection of <see cref="RecognizeEntitiesActionResult"/>.
3434
/// </summary>
35-
public IReadOnlyCollection<RecognizeEntitiesActionResult> RecognizeEntitiesActionsResults { get; }
35+
public IReadOnlyCollection<RecognizeEntitiesActionResult> RecognizeEntitiesResults { get; }
3636

3737
/// <summary>
3838
/// Determines the collection of <see cref="RecognizePiiEntitiesActionResult"/>.
3939
/// </summary>
40-
public IReadOnlyCollection<RecognizePiiEntitiesActionResult> RecognizePiiEntitiesActionsResults { get; }
40+
public IReadOnlyCollection<RecognizePiiEntitiesActionResult> RecognizePiiEntitiesResults { get; }
4141

4242
/// <summary>
4343
/// Determines the collection of <see cref="RecognizeLinkedEntitiesActionResult"/>.
4444
/// </summary>
45-
public IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesActionsResults { get; }
45+
public IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesResults { get; }
4646

4747
/// <summary>
4848
/// Determines the collection of <see cref="AnalyzeSentimentActionResult"/>.
4949
/// </summary>
50-
public IReadOnlyCollection<AnalyzeSentimentActionResult> AnalyzeSentimentActionsResults { get; }
50+
public IReadOnlyCollection<AnalyzeSentimentActionResult> AnalyzeSentimentResults { get; }
5151
}
5252
}

sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationMockTests.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -285,11 +285,11 @@ public async Task AnalyzeOperationWithActionsError()
285285
//Take the first page
286286
AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault();
287287

288-
RecognizeEntitiesActionResult entitiesActionsResults = resultCollection.RecognizeEntitiesActionsResults.FirstOrDefault();
289-
ExtractKeyPhrasesActionResult keyPhrasesActionsResults = resultCollection.ExtractKeyPhrasesActionsResults.FirstOrDefault();
290-
RecognizePiiEntitiesActionResult piiActionsResults = resultCollection.RecognizePiiEntitiesActionsResults.FirstOrDefault();
291-
RecognizeLinkedEntitiesActionResult entityLinkingActionsResults = resultCollection.RecognizeLinkedEntitiesActionsResults.FirstOrDefault();
292-
AnalyzeSentimentActionResult analyzeSentimentActionsResults = resultCollection.AnalyzeSentimentActionsResults.FirstOrDefault();
288+
RecognizeEntitiesActionResult entitiesActionsResults = resultCollection.RecognizeEntitiesResults.FirstOrDefault();
289+
ExtractKeyPhrasesActionResult keyPhrasesActionsResults = resultCollection.ExtractKeyPhrasesResults.FirstOrDefault();
290+
RecognizePiiEntitiesActionResult piiActionsResults = resultCollection.RecognizePiiEntitiesResults.FirstOrDefault();
291+
RecognizeLinkedEntitiesActionResult entityLinkingActionsResults = resultCollection.RecognizeLinkedEntitiesResults.FirstOrDefault();
292+
AnalyzeSentimentActionResult analyzeSentimentActionsResults = resultCollection.AnalyzeSentimentResults.FirstOrDefault();
293293

294294
Assert.IsTrue(entitiesActionsResults.HasError);
295295
Assert.Throws<InvalidOperationException>(() => entitiesActionsResults.DocumentsResults.GetType());

0 commit comments

Comments
 (0)