[TA] Add analyze tasks feature support

sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md

@@ -1,7 +1,9 @@
 # Release History
 ## 5.1.0-beta.3 (Unreleased)
 **New features**
-- Added support for Healthcare analysis, it is a long-running operation, and the cancellation supported. 
+- Added support for healthcare analysis feature, it is a long-running operation, and the cancellation supported. 
+- Added support for analyze tasks feature, It analyzes multiple tasks, such as, entity recognition, PII entity recognition 
+and key phrases extraction simultaneously in a list of document.
 
 ## 5.1.0-beta.2 (2020-10-06)
 ### Breaking changes

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/AnalyzeHealthcareAsyncClient.java

@@ -176,7 +176,7 @@ private PagedResponse<HealthcareTaskResult> toTextAnalyticsPagedResponse(
 
         final HealthcareTaskResult healthcareTaskResult = new HealthcareTaskResult(
             // TODO: change back to UUID after service support it.
-            healthcareJobState.getJobId().toString(),
+            healthcareJobState.getJobId(),
             healthcareJobState.getCreatedDateTime(),
             healthcareJobState.getLastUpdateDateTime(),
             toJobState(healthcareJobState.getStatus()),

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java

@@ -6,12 +6,15 @@
 import com.azure.ai.textanalytics.implementation.TextAnalyticsClientImpl;
 import com.azure.ai.textanalytics.models.AnalyzeSentimentOptions;
 import com.azure.ai.textanalytics.models.AnalyzeSentimentResult;
+import com.azure.ai.textanalytics.models.AnalyzeTasksOptions;
+import com.azure.ai.textanalytics.models.AnalyzeTasksResult;
 import com.azure.ai.textanalytics.models.CategorizedEntityCollection;
 import com.azure.ai.textanalytics.models.DetectLanguageInput;
 import com.azure.ai.textanalytics.models.DetectLanguageResult;
 import com.azure.ai.textanalytics.models.DetectedLanguage;
 import com.azure.ai.textanalytics.models.DocumentSentiment;
 import com.azure.ai.textanalytics.models.HealthcareTaskResult;
+import com.azure.ai.textanalytics.models.JobManifestTasks;
 import com.azure.ai.textanalytics.models.KeyPhrasesCollection;
 import com.azure.ai.textanalytics.models.LinkedEntityCollection;
 import com.azure.ai.textanalytics.models.PiiEntityCollection;
@@ -78,6 +81,7 @@ public final class TextAnalyticsAsyncClient {
     final RecognizePiiEntityAsyncClient recognizePiiEntityAsyncClient;
     final RecognizeLinkedEntityAsyncClient recognizeLinkedEntityAsyncClient;
     final AnalyzeHealthcareAsyncClient analyzeHealthcareAsyncClient;
+    final AnalyzeTasksAsyncClient analyzeTasksAsyncClient;
 
     /**
      * Create a {@link TextAnalyticsAsyncClient} that sends requests to the Text Analytics services's endpoint. Each
@@ -101,6 +105,7 @@ public final class TextAnalyticsAsyncClient {
         this.recognizePiiEntityAsyncClient = new RecognizePiiEntityAsyncClient(service);
         this.recognizeLinkedEntityAsyncClient = new RecognizeLinkedEntityAsyncClient(service);
         this.analyzeHealthcareAsyncClient = new AnalyzeHealthcareAsyncClient(service);
+        this.analyzeTasksAsyncClient = new AnalyzeTasksAsyncClient(service);
     }
 
     /**
@@ -1060,4 +1065,34 @@ public PollerFlux<TextAnalyticsOperationResult, PagedFlux<HealthcareTaskResult>>
     public PollerFlux<TextAnalyticsOperationResult, Void> beginCancelAnalyzeHealthcare(UUID jobId) {
         return analyzeHealthcareAsyncClient.beginCancelAnalyzeHealthcare(jobId, Context.NONE);
     }
+
+    // Analyze LRO
+    /**
+     * Analyze tasks, such as, entity recognition, PII entity recognition and key phrases extraction in a list of
+     * {@link TextDocumentInput document} with provided request options.
+     *
+     * See <a href="https://aka.ms/talangs">this</a> supported languages in Text Analytics API.
+     *
+     * <p><strong>Code Sample</strong></p>
+     * {@codesnippet com.azure.ai.textanalytics.TextAnalyticsAsyncClient.beginAnalyze#Iterable-String-JobManifestTasks-AnalyzeTasksOptions}
+     *
+     * @param documents A list of {@link TextDocumentInput documents} to be analyzed.
+     * @param displayName Job's display name.
+     * @param jobManifestTasks A collection of analyze tasks, such as entity recognition, PII, and key phrase tasks.
+     * @param options The additional configurable {@link AnalyzeTasksOptions options} that may be passed when
+     * analyzing a collection of tasks.
+     *
+     * @return A {@link PollerFlux} that polls the analyze a collection of tasks operation until it has completed,
+     * has failed, or has been cancelled. The completed operation returns a {@link PagedFlux} of
+     * {@link AnalyzeTasksResult}.
+     *
+     * @throws TextAnalyticsException If analyze operation fails.
+     * @throws NullPointerException If {@code jobId} is null.
+     */
+    @ServiceMethod(returns = ReturnType.COLLECTION)
+    public PollerFlux<TextAnalyticsOperationResult, PagedFlux<AnalyzeTasksResult>> beginAnalyze(
+        Iterable<TextDocumentInput> documents, String displayName, JobManifestTasks jobManifestTasks,
+        AnalyzeTasksOptions options) {
+        return analyzeTasksAsyncClient.beginAnalyze(documents, displayName, jobManifestTasks, options, Context.NONE);
+    }
 }

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java

@@ -4,12 +4,15 @@
 package com.azure.ai.textanalytics;
 
 import com.azure.ai.textanalytics.models.AnalyzeSentimentOptions;
+import com.azure.ai.textanalytics.models.AnalyzeTasksOptions;
+import com.azure.ai.textanalytics.models.AnalyzeTasksResult;
 import com.azure.ai.textanalytics.models.CategorizedEntity;
 import com.azure.ai.textanalytics.models.CategorizedEntityCollection;
 import com.azure.ai.textanalytics.models.DetectLanguageInput;
 import com.azure.ai.textanalytics.models.DetectedLanguage;
 import com.azure.ai.textanalytics.models.DocumentSentiment;
 import com.azure.ai.textanalytics.models.HealthcareTaskResult;
+import com.azure.ai.textanalytics.models.JobManifestTasks;
 import com.azure.ai.textanalytics.models.KeyPhrasesCollection;
 import com.azure.ai.textanalytics.models.LinkedEntity;
 import com.azure.ai.textanalytics.models.LinkedEntityCollection;
@@ -925,4 +928,38 @@ public SyncPoller<TextAnalyticsOperationResult, PagedIterable<HealthcareTaskResu
     public SyncPoller<TextAnalyticsOperationResult, Void> beginCancelAnalyzeHealthcare(UUID jobId, Context context) {
         return client.analyzeHealthcareAsyncClient.beginCancelAnalyzeHealthcare(jobId, context).getSyncPoller();
     }
+
+    // Analyze
+
+    /**
+     * Analyze tasks, such as, entity recognition, PII entity recognition and key phrases extraction in a list of
+     * {@link TextDocumentInput document} with provided request options.
+     *
+     * See <a href="https://aka.ms/talangs">this</a> supported languages in Text Analytics API.
+     *
+     * <p><strong>Code Sample</strong></p>
+     * {@codesnippet com.azure.ai.textanalytics.TextAnalyticsClient.beginAnalyze#Iterable-String-JobManifestTasks-AnalyzeTasksOptions-Context}
+     *
+     * @param documents A list of {@link TextDocumentInput documents} to be analyzed.
+     * @param displayName Job's display name.
+     * @param jobManifestTasks A collection of analyze tasks, such as entity recognition, PII, and key phrase tasks.
+     * @param options The additional configurable {@link AnalyzeTasksOptions options} that may be passed when
+     * analyzing a collection of tasks.
+     * @param context Additional context that is passed through the Http pipeline during the service call.
+     *
+     * @return A {@link SyncPoller} that polls the analyze a collection of tasks operation until it has completed,
+     * has failed, or has been cancelled. The completed operation returns a {@link PagedIterable} of
+     * {@link AnalyzeTasksResult}.
+     *
+     * @throws TextAnalyticsException If analyze operation fails.
+     * @throws NullPointerException If {@code jobId} is null.
+     */
+    @ServiceMethod(returns = ReturnType.COLLECTION)
+    public SyncPoller<TextAnalyticsOperationResult, PagedIterable<AnalyzeTasksResult>> beginAnalyze(
+        Iterable<TextDocumentInput> documents, String displayName, JobManifestTasks jobManifestTasks,
+        AnalyzeTasksOptions options, Context context) {
+        return client.analyzeTasksAsyncClient.beginAnalyzeIterable(documents, displayName, jobManifestTasks, options,
+            context).getSyncPoller();
+    }
+
 }

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/implementation/AnalyzeTasksResultPropertiesHelper.java

@@ -0,0 +1,88 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.ai.textanalytics.implementation;
+
+import com.azure.ai.textanalytics.models.AnalyzeTasksResult;
+import com.azure.ai.textanalytics.models.TextAnalyticsError;
+import com.azure.ai.textanalytics.models.TextDocumentBatchStatistics;
+import com.azure.ai.textanalytics.util.ExtractKeyPhrasesResultCollection;
+import com.azure.ai.textanalytics.util.RecognizeEntitiesResultCollection;
+import com.azure.ai.textanalytics.util.RecognizePiiEntitiesResultCollection;
+
+import java.util.List;
+
+/**
+ * The helper class to set the non-public properties of an {@link AnalyzeTasksResult} instance.
+ */
+public final class AnalyzeTasksResultPropertiesHelper {
+    private static AnalyzeTasksResultAccessor accessor;
+
+    private AnalyzeTasksResultPropertiesHelper() { }
+
+    /**
+     * Type defining the methods to set the non-public properties of an {@link AnalyzeTasksResult} instance.
+     */
+    public interface AnalyzeTasksResultAccessor {
+        void setErrors(AnalyzeTasksResult analyzeTasksResult, List<TextAnalyticsError> errors);
+        void setStatistics(AnalyzeTasksResult analyzeTasksResult, TextDocumentBatchStatistics statistics);
+        void setCompleted(AnalyzeTasksResult analyzeTasksResult, int completed);
+        void setFailed(AnalyzeTasksResult analyzeTasksResult, int failed);
+        void setInProgress(AnalyzeTasksResult analyzeTasksResult, int inProgress);
+        void setTotal(AnalyzeTasksResult analyzeTasksResult, int total);
+        void setEntityRecognitionTasks(AnalyzeTasksResult analyzeTasksResult,
+            List<RecognizeEntitiesResultCollection> entityRecognitionTasks);
+        void setEntityRecognitionPiiTasks(AnalyzeTasksResult analyzeTasksResult,
+            List<RecognizePiiEntitiesResultCollection> entityRecognitionPiiTasks);
+        void setKeyPhraseExtractionTasks(AnalyzeTasksResult analyzeTasksResult,
+            List<ExtractKeyPhrasesResultCollection> keyPhraseExtractionTasks);
+    }
+
+    /**
+     * The method called from {@link AnalyzeTasksResult} to set it's accessor.
+     *
+     * @param analyzeTasksResultAccessor The accessor.
+     */
+    public static void setAccessor(final AnalyzeTasksResultAccessor analyzeTasksResultAccessor) {
+        accessor = analyzeTasksResultAccessor;
+    }
+
+    public static void setErrors(AnalyzeTasksResult analyzeTasksResult, List<TextAnalyticsError> errors) {
+        accessor.setErrors(analyzeTasksResult, errors);
+    }
+
+    public static void setStatistics(AnalyzeTasksResult analyzeTasksResult, TextDocumentBatchStatistics statistics) {
+        accessor.setStatistics(analyzeTasksResult, statistics);
+    }
+
+    public static void setCompleted(AnalyzeTasksResult analyzeTasksResult, int completed) {
+        accessor.setCompleted(analyzeTasksResult, completed);
+    }
+
+    public static void setFailed(AnalyzeTasksResult analyzeTasksResult, int failed) {
+        accessor.setFailed(analyzeTasksResult, failed);
+    }
+
+    public static void setInProgress(AnalyzeTasksResult analyzeTasksResult, int inProgress) {
+        accessor.setInProgress(analyzeTasksResult, inProgress);
+    }
+
+    public static void setTotal(AnalyzeTasksResult analyzeTasksResult, int total) {
+        accessor.setTotal(analyzeTasksResult, total);
+    }
+
+    public static void setEntityRecognitionTasks(AnalyzeTasksResult analyzeTasksResult,
+        List<RecognizeEntitiesResultCollection> entityRecognitionTasks) {
+        accessor.setEntityRecognitionTasks(analyzeTasksResult, entityRecognitionTasks);
+    }
+
+    public static void setEntityRecognitionPiiTasks(AnalyzeTasksResult analyzeTasksResult,
+        List<RecognizePiiEntitiesResultCollection> entityRecognitionPiiTasks) {
+        accessor.setEntityRecognitionPiiTasks(analyzeTasksResult, entityRecognitionPiiTasks);
+    }
+
+    public static void setKeyPhraseExtractionTasks(AnalyzeTasksResult analyzeTasksResult,
+        List<ExtractKeyPhrasesResultCollection> keyPhraseExtractionTasks) {
+        accessor.setKeyPhraseExtractionTasks(analyzeTasksResult, keyPhraseExtractionTasks);
+    }
+}

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/implementation/HealthcareTaskResultPropertiesHelper.java

@@ -23,7 +23,7 @@ private HealthcareTaskResultPropertiesHelper() { }
     public interface HealthcareTaskResultAccessor {
         void setResult(HealthcareTaskResult healthcareTaskResult,
             RecognizeHealthcareEntitiesResultCollection recognizeHealthcareEntitiesResultCollection);
-        void setError(HealthcareTaskResult healthcareTaskResult, List<TextAnalyticsError> errors);
+        void setErrors(HealthcareTaskResult healthcareTaskResult, List<TextAnalyticsError> errors);
     }
 
     /**
@@ -42,6 +42,6 @@ public static void setResult(HealthcareTaskResult healthcareTaskResult,
     }
 
     public static void setErrors(HealthcareTaskResult healthcareTaskResult, List<TextAnalyticsError> errors) {
-        accessor.setError(healthcareTaskResult, errors);
+        accessor.setErrors(healthcareTaskResult, errors);
     }
 }