[TA] Implement actionName

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

@@ -4,6 +4,8 @@
 ### New features
 - 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.
 - Added value `None` to enum `PiiEntityDomainType` to allow user to specify no domain.
+- Added property `ActionName` to all `xxActions` input types so user can specify a name per action. If not provided, service will generate a name.
+- Added property `ActionName` to all `xxActionResult` output types that displays the name of each action. 
 
 ### Breaking changes
 - Renamed `StartAnalyzeBatchActions` to `StartAnalyzeActions`.

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

@@ -612,6 +612,7 @@ This functionality allows running multiple actions in one or more documents. Act
         int docNumber = 1;
         foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
         {
+            Console.WriteLine($" Action name: {entitiesActionResults.ActionName}");
             foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -634,6 +635,7 @@ This functionality allows running multiple actions in one or more documents. Act
         docNumber = 1;
         foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
         {
+            Console.WriteLine($" Action name: {piiActionResults.ActionName}");
             foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -656,6 +658,7 @@ This functionality allows running multiple actions in one or more documents. Act
         docNumber = 1;
         foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
         {
+            Console.WriteLine($" Action name: {keyPhrasesActionResult.ActionName}");
             foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -704,6 +707,7 @@ This functionality allows running multiple actions in one or more documents. Act
         docNumber = 1;
         foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
         {
+            Console.WriteLine($" Action name: {analyzeSentimentActionsResult.ActionName}");
             foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");

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

@@ -70,6 +70,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
         int docNumber = 1;
         foreach (RecognizeEntitiesActionResult entitiesActionResults in entitiesResults)
         {
+            Console.WriteLine($" Action name: {entitiesActionResults.ActionName}");
             foreach (RecognizeEntitiesResult documentResults in entitiesActionResults.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -92,6 +93,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
         docNumber = 1;
         foreach (RecognizePiiEntitiesActionResult piiActionResults in piiResults)
         {
+            Console.WriteLine($" Action name: {piiActionResults.ActionName}");
             foreach (RecognizePiiEntitiesResult documentResults in piiActionResults.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -114,6 +116,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
         docNumber = 1;
         foreach (ExtractKeyPhrasesActionResult keyPhrasesActionResult in keyPhrasesResults)
         {
+            Console.WriteLine($" Action name: {keyPhrasesActionResult.ActionName}");
             foreach (ExtractKeyPhrasesResult documentResults in keyPhrasesActionResult.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");
@@ -162,6 +165,7 @@ To run multiple actions in multiple documents, call `StartAnalyzeActionsAsync` o
         docNumber = 1;
         foreach (AnalyzeSentimentActionResult analyzeSentimentActionsResult in analyzeSentimentResults)
         {
+            Console.WriteLine($" Action name: {analyzeSentimentActionsResult.ActionName}");
             foreach (AnalyzeSentimentResult documentResults in analyzeSentimentActionsResult.DocumentsResults)
             {
                 Console.WriteLine($" Document #{docNumber++}");

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

@@ -49,5 +49,10 @@ public AnalyzeSentimentAction()
         /// This property only has value for <see cref="TextAnalyticsClientOptions.ServiceVersion.V3_1"/> and up.
         /// </remarks>
         public bool? IncludeOpinionMining { get; set; }
+
+        /// <summary>
+        /// Gets or sets a name for this action. If not provided, the service will generate one.
+        /// </summary>
+        public string ActionName { get; set; }
     }
 }

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

@@ -13,27 +13,23 @@ public class AnalyzeSentimentActionResult : TextAnalyticsActionResult
     {
         private readonly AnalyzeSentimentResultCollection _documentsResults;
 
-        internal AnalyzeSentimentActionResult(AnalyzeSentimentResultCollection result, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
-            : base(completedOn, error)
-        {
-            _documentsResults = result;
-        }
-
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Successful action.
         /// </summary>
-        internal AnalyzeSentimentActionResult(
-            AnalyzeSentimentResultCollection result,
-            DateTimeOffset completedOn) : base(completedOn)
+        internal AnalyzeSentimentActionResult(AnalyzeSentimentResultCollection result, string actionName, DateTimeOffset completedOn)
+            : base(completedOn)
         {
             _documentsResults = result;
+            ActionName = actionName;
         }
 
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Action with an error.
         /// </summary>
-        internal AnalyzeSentimentActionResult(TextAnalyticsErrorInternal error) : base(error)
+        internal AnalyzeSentimentActionResult(string actionName, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
+            : base(completedOn, error)
         {
+            ActionName = actionName;
         }
 
         /// <summary>
@@ -50,5 +46,10 @@ public AnalyzeSentimentResultCollection DocumentsResults
                 return _documentsResults;
             }
         }
+
+        /// <summary>
+        /// Gets the name for this action.
+        /// </summary>
+        public string ActionName { get; }
     }
 }

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

@@ -37,5 +37,10 @@ public ExtractKeyPhrasesAction()
         /// This property only applies for <see cref="TextAnalyticsClientOptions.ServiceVersion.V3_1"/> and up.
         /// </remarks>
         public bool? DisableServiceLogs { get; set; }
+
+        /// <summary>
+        /// Gets or sets a name for this action. If not provided, the service will generate one.
+        /// </summary>
+        public string ActionName { get; set; }
     }
 }

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

@@ -13,27 +13,23 @@ public class ExtractKeyPhrasesActionResult : TextAnalyticsActionResult
     {
         private readonly ExtractKeyPhrasesResultCollection _documentsResults;
 
-        internal ExtractKeyPhrasesActionResult(ExtractKeyPhrasesResultCollection result, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
-            : base(completedOn, error)
-        {
-            _documentsResults = result;
-        }
-
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Successful action.
         /// </summary>
-        internal ExtractKeyPhrasesActionResult(
-            ExtractKeyPhrasesResultCollection result,
-            DateTimeOffset completedOn) : base(completedOn)
+        internal ExtractKeyPhrasesActionResult(ExtractKeyPhrasesResultCollection result, string actionName, DateTimeOffset completedOn)
+            : base(completedOn)
         {
             _documentsResults = result;
+            ActionName = actionName;
         }
 
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Action with an error.
         /// </summary>
-        internal ExtractKeyPhrasesActionResult(TextAnalyticsErrorInternal error) : base(error)
+        internal ExtractKeyPhrasesActionResult(string actionName, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
+            : base(completedOn, error)
         {
+            ActionName = actionName;
         }
 
         /// <summary>
@@ -52,5 +48,10 @@ public ExtractKeyPhrasesResultCollection DocumentsResults
                 return _documentsResults;
             }
         }
+
+        /// <summary>
+        /// Gets the name for this action.
+        /// </summary>
+        public string ActionName { get; }
     }
 }

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

@@ -37,5 +37,10 @@ public RecognizeEntitiesAction()
         /// This property only applies for <see cref="TextAnalyticsClientOptions.ServiceVersion.V3_1"/> and up.
         /// </remarks>
         public bool? DisableServiceLogs { get; set; }
+
+        /// <summary>
+        /// Gets or sets a name for this action. If not provided, the service will generate one.
+        /// </summary>
+        public string ActionName { get; set; }
     }
 }

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

@@ -13,28 +13,23 @@ public class RecognizeEntitiesActionResult : TextAnalyticsActionResult
     {
         private readonly RecognizeEntitiesResultCollection _documentsResults;
 
-        internal RecognizeEntitiesActionResult(RecognizeEntitiesResultCollection result, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
-            : base(completedOn, error)
-        {
-            _documentsResults = result;
-        }
-
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Successful action.
         /// </summary>
-        internal RecognizeEntitiesActionResult(
-            RecognizeEntitiesResultCollection result,
-            DateTimeOffset completedOn) : base(completedOn)
+        internal RecognizeEntitiesActionResult(RecognizeEntitiesResultCollection result, string actionName, DateTimeOffset completedOn)
+            : base(completedOn)
         {
             _documentsResults = result;
+            ActionName = actionName;
         }
 
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Action with an error.
         /// </summary>
-        internal RecognizeEntitiesActionResult(
-            TextAnalyticsErrorInternal error) : base(error)
+        internal RecognizeEntitiesActionResult(string actionName, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
+            : base(completedOn, error)
         {
+            ActionName = actionName;
         }
 
         /// <summary>
@@ -53,5 +48,10 @@ public RecognizeEntitiesResultCollection DocumentsResults
                 return _documentsResults;
             }
         }
+
+        /// <summary>
+        /// Gets the name for this action.
+        /// </summary>
+        public string ActionName { get; }
     }
 }

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

@@ -37,5 +37,10 @@ public RecognizeLinkedEntitiesAction()
         /// This property only applies for <see cref="TextAnalyticsClientOptions.ServiceVersion.V3_1"/> and up.
         /// </remarks>
         public bool? DisableServiceLogs { get; set; }
+
+        /// <summary>
+        /// Gets or sets a name for this action. If not provided, the service will generate one.
+        /// </summary>
+        public string ActionName { get; set; }
     }
 }

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

@@ -13,28 +13,23 @@ public class RecognizeLinkedEntitiesActionResult : TextAnalyticsActionResult
     {
         private readonly RecognizeLinkedEntitiesResultCollection _documentsResults;
 
-        internal RecognizeLinkedEntitiesActionResult(RecognizeLinkedEntitiesResultCollection result, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
-            : base(completedOn, error)
-        {
-            _documentsResults = result;
-        }
-
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Successful action.
         /// </summary>
-        internal RecognizeLinkedEntitiesActionResult(
-            RecognizeLinkedEntitiesResultCollection result,
-            DateTimeOffset completedOn) : base(completedOn)
+        internal RecognizeLinkedEntitiesActionResult(RecognizeLinkedEntitiesResultCollection result, string actionName, DateTimeOffset completedOn)
+            : base(completedOn)
         {
             _documentsResults = result;
+            ActionName = actionName;
         }
 
         /// <summary>
-        /// Intended for mocking purposes only.
+        /// Action with an error.
         /// </summary>
-        internal RecognizeLinkedEntitiesActionResult(
-            TextAnalyticsErrorInternal error) : base(error)
+        internal RecognizeLinkedEntitiesActionResult(string actionName, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
+            : base(completedOn, error)
         {
+            ActionName = actionName;
         }
 
         /// <summary>
@@ -53,5 +48,10 @@ public RecognizeLinkedEntitiesResultCollection DocumentsResults
                 return _documentsResults;
             }
         }
+
+        /// <summary>
+        /// Gets the name for this action.
+        /// </summary>
+        public string ActionName { get; }
     }
 }

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

@@ -51,5 +51,10 @@ public RecognizePiiEntitiesAction()
         /// Filters the response entities to entities that match the <see cref="PiiEntityCategory"/> specified.
         /// </summary>
         public IList<PiiEntityCategory> CategoriesFilter { get; internal set; } = new List<PiiEntityCategory>();
+
+        /// <summary>
+        /// Gets or sets a name for this action. If not provided, the service will generate one.
+        /// </summary>
+        public string ActionName { get; set; }
     }
 }

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

@@ -13,10 +13,23 @@ public class RecognizePiiEntitiesActionResult : TextAnalyticsActionResult
     {
         private readonly RecognizePiiEntitiesResultCollection _documentsResults;
 
-        internal RecognizePiiEntitiesActionResult(RecognizePiiEntitiesResultCollection result, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
-            : base(completedOn, error)
+        /// <summary>
+        /// Successful action.
+        /// </summary>
+        internal RecognizePiiEntitiesActionResult(RecognizePiiEntitiesResultCollection result, string actionName, DateTimeOffset completedOn)
+            : base(completedOn)
         {
             _documentsResults = result;
+            ActionName = actionName;
+        }
+
+        /// <summary>
+        /// Action with an error.
+        /// </summary>
+        internal RecognizePiiEntitiesActionResult(string actionName, DateTimeOffset completedOn, TextAnalyticsErrorInternal error)
+            : base(completedOn, error)
+        {
+            ActionName = actionName;
         }
 
         /// <summary>
@@ -35,5 +48,10 @@ public RecognizePiiEntitiesResultCollection DocumentsResults
                 return _documentsResults;
             }
         }
+
+        /// <summary>
+        /// Gets the name for this action.
+        /// </summary>
+        public string ActionName { get; }
     }
 }

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

@@ -17,22 +17,11 @@ internal TextAnalyticsActionResult (DateTimeOffset completedOn, TextAnalyticsErr
             Error = error != null ? Transforms.ConvertToError(error) : default;
         }
 
-        /// <summary>
-        /// Intended for mocking purposes only.
-        /// </summary>
         internal TextAnalyticsActionResult(DateTimeOffset completedOn)
         {
             CompletedOn = completedOn;
         }
 
-        /// <summary>
-        /// Intended for mocking purposes only.
-        /// </summary>
-        internal TextAnalyticsActionResult(TextAnalyticsErrorInternal error)
-        {
-            Error = Transforms.ConvertToError(error);
-        }
-
         /// <summary>
         /// Indicates the time at which the action was last updated on.
         /// </summary>

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

@@ -8,6 +8,15 @@ namespace Azure.AI.TextAnalytics
     /// <summary> Determines the set of actions that will get executed on the input documents.</summary>
     public class TextAnalyticsActions
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="TextAnalyticsActions"/>
+        /// class which determines the set of actions that will get executed on the input documents.
+        /// For example, execute extract key phrases, recognize entities, and more.
+        /// </summary>
+        public TextAnalyticsActions()
+        {
+        }
+
         /// <summary>
         /// Optional display name for the operation.
         /// </summary>