[Text Analytics] Analyze design update

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

@@ -493,25 +493,25 @@ The Analyze functionality allows to choose which of the supported Text Analytics
 
     var batchDocuments = new List<string> { document };
 
-    AnalyzeOperationOptions operationOptions = new AnalyzeOperationOptions()
+    TextAnalyticsActions batchActions = new TextAnalyticsActions()
     {
-        KeyPhrasesTaskParameters = new KeyPhrasesTaskParameters(),
-        EntitiesTaskParameters = new EntitiesTaskParameters(),
-        PiiTaskParameters = new PiiTaskParameters(),
+        ExtractKeyPhrasesOptions = new List<ExtractKeyPhrasesOptions>() { new ExtractKeyPhrasesOptions() },
+        RecognizeEntitiesOptions = new List<RecognizeEntitiesOptions>() { new RecognizeEntitiesOptions() },
+        RecognizePiiEntityOptions = new List<RecognizePiiEntitiesOptions>() { new RecognizePiiEntitiesOptions() },
         DisplayName = "AnalyzeOperationSample"
     };
 
-    AnalyzeOperation operation = client.StartAnalyzeOperationBatch(batchDocuments, operationOptions);
+    AnalyzeBatchActionsOperation operation = await client.StartAnalyzeBatchActionsAsync(batchDocuments, batchActions);
 
     await operation.WaitForCompletionAsync();
 
-    AnalyzeOperationResult resultCollection = operation.Value;
+    AnalyzeBatchActionsResult resultCollection = operation.Value;
 
-    RecognizeEntitiesResultCollection entitiesResult = resultCollection.Tasks.EntityRecognitionTasks[0].Results;
+    RecognizeEntitiesResultCollection entitiesResult = resultCollection.RecognizeEntitiesActionResults.Results[0];
 
-    ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.Tasks.KeyPhraseExtractionTasks[0].Results;
+    ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.ExtractKeyPhrasesActionResults.Results[0];
 
-    RecognizePiiEntitiesResultCollection piiResult = resultCollection.Tasks.EntityRecognitionPiiTasks[0].Results;
+    RecognizePiiEntitiesResultCollection piiResult = resultCollection.RecognizePiiEntitiesActionResults.Results[0];
 
     Console.WriteLine("Recognized Entities");
 

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

@@ -29,25 +29,25 @@ To run analyze operation in multiple documents, call `StartAnalyzeOperationBatch
 
     var batchDocuments = new List<string> { document };
 
-    AnalyzeOperationOptions operationOptions = new AnalyzeOperationOptions()
+    TextAnalyticsActions batchActions = new TextAnalyticsActions()
     {
-        KeyPhrasesTaskParameters = new KeyPhrasesTaskParameters(),
-        EntitiesTaskParameters = new EntitiesTaskParameters(),
-        PiiTaskParameters = new PiiTaskParameters(),
+        ExtractKeyPhrasesOptions = new List<ExtractKeyPhrasesOptions>() { new ExtractKeyPhrasesOptions() },
+        RecognizeEntitiesOptions = new List<RecognizeEntitiesOptions>() { new RecognizeEntitiesOptions() },
+        RecognizePiiEntityOptions = new List<RecognizePiiEntitiesOptions>() { new RecognizePiiEntitiesOptions() },
         DisplayName = "AnalyzeOperationSample"
     };
 
-    AnalyzeOperation operation = client.StartAnalyzeOperationBatch(batchDocuments, operationOptions);
+    AnalyzeBatchActionsOperation operation = await client.StartAnalyzeBatchActionsAsync(batchDocuments, batchActions);
 
     await operation.WaitForCompletionAsync();
 
-    AnalyzeOperationResult resultCollection = operation.Value;
+    AnalyzeBatchActionsResult resultCollection = operation.Value;
 
-    RecognizeEntitiesResultCollection entitiesResult = resultCollection.Tasks.EntityRecognitionTasks[0].Results;
+    RecognizeEntitiesResultCollection entitiesResult = resultCollection.RecognizeEntitiesActionResults.Results[0];
 
-    ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.Tasks.KeyPhraseExtractionTasks[0].Results;
+    ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.ExtractKeyPhrasesActionResults.Results[0];
 
-    RecognizePiiEntitiesResultCollection piiResult = resultCollection.Tasks.EntityRecognitionPiiTasks[0].Results;
+    RecognizePiiEntitiesResultCollection piiResult = resultCollection.RecognizePiiEntitiesActionResults.Results[0];
 
     Console.WriteLine("Recognized Entities");
 

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeOperation.cs → sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeBatchActionsOperation.cs

@@ -12,15 +12,60 @@
 
 namespace Azure.AI.TextAnalytics
 {
-    /// <summary> The AnalyzeOperation class for LRO. </summary>
-    public class AnalyzeOperation : Operation<AnalyzeOperationResult>
+    /// <summary> The AnalyzeBatchActionsOperation class for LRO. </summary>
+    public class AnalyzeBatchActionsOperation : Operation<AnalyzeBatchActionsResult>
     {
         /// <summary>Provides communication with the Form Recognizer Azure Cognitive Service through its REST API.</summary>
         private readonly TextAnalyticsRestClient _serviceClient;
 
         /// <summary>Provides tools for exception creation in case of failure.</summary>
         private readonly ClientDiagnostics _diagnostics;
 
+        /// <summary>
+        /// Total actions failed in the operation
+        /// </summary>
+        public int ActionsFailed => _actionsFailed;
+
+        /// <summary>
+        /// Total actions in progress in the operation
+        /// </summary>
+        public int ActionsInProgress => _actionsInProgress;
+
+        /// <summary>
+        /// Total actions succeeded in the operation
+        /// </summary>
+        public int ActionsSucceeded => _actionSucceeded;
+
+        /// <summary>
+        /// Time when the operation was created on.
+        /// </summary>
+        public DateTimeOffset CreatedOn => _createdOn;
+
+        /// <summary>
+        /// Display Name of the operation
+        /// </summary>
+        public string DisplayName => _displayName;
+
+        /// <summary>
+        /// Time when the operation will expire.
+        /// </summary>
+        public DateTimeOffset? ExpiresOn => _expiresOn;
+
+        /// <summary>
+        /// Time when the operation was last modified on.
+        /// </summary>
+        public DateTimeOffset LastModified => _lastModified;
+
+        /// <summary>
+        /// The current status of the operation.
+        /// </summary>
+        public TextAnalyticsOperationStatus Status => _status;
+
+        /// <summary>
+        /// Total actions in the operation
+        /// </summary>
+        public int TotalActions => _totalActions;
+
         /// <summary>
         /// Gets an ID representing the operation that can be used to poll for the status
         /// of the long-running operation.
@@ -43,7 +88,7 @@ public class AnalyzeOperation : Operation<AnalyzeOperationResult>
         /// <remarks>
         /// This property can be accessed only after the operation completes successfully (HasValue is true).
         /// </remarks>
-        public override AnalyzeOperationResult Value
+        public override AnalyzeBatchActionsResult Value
         {
             get
             {
@@ -61,6 +106,16 @@ public override AnalyzeOperationResult Value
         /// <summary><c>true</c> if the long-running operation has completed. Otherwise, <c>false</c>.</summary>
         private bool _hasCompleted;
 
+        private int _totalActions;
+        private int _actionsFailed;
+        private int _actionSucceeded;
+        private int _actionsInProgress;
+        private DateTimeOffset _createdOn;
+        private DateTimeOffset? _expiresOn;
+        private DateTimeOffset _lastModified;
+        private TextAnalyticsOperationStatus _status;
+        private string _displayName;
+
         /// <summary>
         /// Returns true if the long-running operation completed.
         /// </summary>
@@ -72,7 +127,7 @@ public override AnalyzeOperationResult Value
         private Response _response;
 
         /// <summary>The result of the long-running operation. <c>null</c> until result is received on status update.</summary>
-        private AnalyzeOperationResult _value;
+        private AnalyzeBatchActionsResult _value;
 
         private int? _top { get; }
         private int? _skip { get; }
@@ -84,11 +139,11 @@ public override AnalyzeOperationResult Value
         public override bool HasValue => _value != null;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="AnalyzeOperation"/> class.
+        /// Initializes a new instance of the <see cref="AnalyzeBatchActionsOperation"/> class.
         /// </summary>
         /// <param name="operationId">The ID of this operation.</param>
         /// <param name="client">The client used to check for completion.</param>
-        public AnalyzeOperation(string operationId, TextAnalyticsClient client)
+        public AnalyzeBatchActionsOperation(string operationId, TextAnalyticsClient client)
         {
             // TODO: Add argument validation here.
 
@@ -98,7 +153,7 @@ public AnalyzeOperation(string operationId, TextAnalyticsClient client)
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="AnalyzeOperation"/> class.
+        /// Initializes a new instance of the <see cref="AnalyzeBatchActionsOperation"/> class.
         /// </summary>
         /// <param name="serviceClient">The client for communicating with the Form Recognizer Azure Cognitive Service through its REST API.</param>
         /// <param name="diagnostics">The client diagnostics for exception creation in case of failure.</param>
@@ -107,7 +162,7 @@ public AnalyzeOperation(string operationId, TextAnalyticsClient client)
         /// <param name="top"></param>
         /// <param name="skip"></param>
         /// <param name="showStats"></param>
-        internal AnalyzeOperation(TextAnalyticsRestClient serviceClient, ClientDiagnostics diagnostics, string operationLocation, IDictionary<string, int> idToIndexMap, int? top = default, int? skip = default, bool? showStats = default)
+        internal AnalyzeBatchActionsOperation(TextAnalyticsRestClient serviceClient, ClientDiagnostics diagnostics, string operationLocation, IDictionary<string, int> idToIndexMap, int? top = default, int? skip = default, bool? showStats = default)
         {
             _serviceClient = serviceClient;
             _diagnostics = diagnostics;
@@ -126,7 +181,7 @@ internal AnalyzeOperation(TextAnalyticsRestClient serviceClient, ClientDiagnosti
         /// </summary>
         /// <remarks>
         /// The last response returned from the server during the lifecycle of this instance.
-        /// An instance of <see cref="AnalyzeOperation"/> sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods.
+        /// An instance of <see cref="AnalyzeBatchActionsOperation"/> sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods.
         /// Responses from these requests can be accessed using GetRawResponse.
         /// </remarks>
         public override Response GetRawResponse() => _response;
@@ -161,7 +216,7 @@ public override async ValueTask<Response> UpdateStatusAsync(CancellationToken ca
         /// <remarks>
         /// This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
         /// </remarks>
-        public override ValueTask<Response<AnalyzeOperationResult>> WaitForCompletionAsync(CancellationToken cancellationToken = default) =>
+        public override ValueTask<Response<AnalyzeBatchActionsResult>> WaitForCompletionAsync(CancellationToken cancellationToken = default) =>
             this.DefaultWaitForCompletionAsync(cancellationToken);
 
         /// <summary>
@@ -177,7 +232,7 @@ public override ValueTask<Response<AnalyzeOperationResult>> WaitForCompletionAsy
         /// <remarks>
         /// This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
         /// </remarks>
-        public override ValueTask<Response<AnalyzeOperationResult>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) =>
+        public override ValueTask<Response<AnalyzeBatchActionsResult>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) =>
             this.DefaultWaitForCompletionAsync(pollingInterval, cancellationToken);
 
         /// <summary>
@@ -190,7 +245,7 @@ private async ValueTask<Response> UpdateStatusAsync(bool async, CancellationToke
         {
             if (!_hasCompleted)
             {
-                using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(AnalyzeOperation)}.{nameof(UpdateStatus)}");
+                using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(AnalyzeBatchActionsOperation)}.{nameof(UpdateStatus)}");
                 scope.Start();
 
                 try
@@ -201,6 +256,16 @@ private async ValueTask<Response> UpdateStatusAsync(bool async, CancellationToke
 
                     _response = update.GetRawResponse();
 
+                    _displayName = update.Value.DisplayName;
+                    _createdOn = update.Value.CreatedDateTime;
+                    _expiresOn = update.Value.ExpirationDateTime;
+                    _lastModified = update.Value.LastUpdateDateTime;
+                    _status = update.Value.Status;
+                    _actionsFailed = update.Value.Tasks.Failed;
+                    _actionsInProgress = update.Value.Tasks.InProgress;
+                    _actionSucceeded = update.Value.Tasks.Completed;
+                    _totalActions = update.Value.Tasks.Total;
+
                     if (update.Value.Status == TextAnalyticsOperationStatus.Succeeded)
                     {
                         // we need to first assign a vaue and then mark the operation as completed to avoid race conditions

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

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Azure.AI.TextAnalytics
+{
+    /// <summary>
+    /// AnalyzeBatchActionsOptions
+    /// </summary>
+    public class AnalyzeBatchActionsOptions
+    {
+        /// <summary>
+        /// IncludeStatistics
+        /// </summary>
+        public bool IncludeStatistics { get; set; }
+    }
+}

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

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using Azure.AI.TextAnalytics.Models;
+
+namespace Azure.AI.TextAnalytics
+{
+    /// <summary>
+    /// Collection of <see cref="JobMetadata"/> objects corresponding
+    /// to a batch of documents, and information about the batch operation.
+    /// </summary>
+    public class AnalyzeBatchActionsResult
+    {
+        /// <summary>
+        /// AnalyzeBatchActionsResult
+        /// </summary>
+        internal AnalyzeBatchActionsResult(AnalyzeJobState jobState, IDictionary<string, int> map)
+        {
+            ExtractKeyPhrasesActionResults = Transforms.ConvertToExtractKeyPhrasesActionResults(jobState, map);
+            RecognizeEntitiesActionResults = Transforms.ConvertToRecognizeEntitiesActionsResults(jobState, map);
+            RecognizePiiEntitiesActionResults = Transforms.ConvertToRecognizePiiEntitiesActionsResults(jobState, map);
+        }
+
+        /// <summary>
+        /// Collection for ExtractKeyPhrasesActionsResults
+        /// </summary>
+        public ExtractKeyPhrasesActionResults ExtractKeyPhrasesActionResults { get; }
+
+        /// <summary>
+        /// RecognizeEntitiesActionsResults
+        /// </summary>
+        public RecognizeEntitiesActionResults RecognizeEntitiesActionResults { get; }
+
+        /// <summary>
+        /// RecognizePiiEntitiesActionsResults
+        /// </summary>
+        public RecognizePiiEntitiesActionResults RecognizePiiEntitiesActionResults { get; }
+
+        /// <summary>
+        /// Statistics
+        /// </summary>
+        public TextDocumentBatchStatistics Statistics { get; }
+    }
+}