[TA] Generate 3.1-preview.4 swagger and fixes breaking changes (Azure#19413)

* Regenerated and fix errors and create follow-up issue

Author: mssfang

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

@@ -1,6 +1,14 @@
 # Release History
 ## 5.1.0-beta.5 (Unreleased)
-
+### Breaking changes
+- Renamed `AspectSentiment` to `TargetSentiment`, `OpinionSentiment` to `AssesssmentSentiment`.
+- Renamed
+  `SentenceSentiment`'s method, `getMinedOpinions()` to `getOpinions()`.
+  `MinedOpinion`'s methods, `getAspect()` to `getTarget()`, `getOpinions()` to `getAssessments()`,
+- Removed constructors, 
+  `SentenceSentiment(String text, TextSentiment sentiment, SentimentConfidenceScores confidenceScores, IterableStream<MinedOpinion> minedOpinions, int offset)`,
+  `AspectSentiment(String text, TextSentiment sentiment, int offset, SentimentConfidenceScores confidenceScores)`,
+  `OpinionSentiment(String text, TextSentiment sentiment, int offset, boolean isNegated, SentimentConfidenceScores confidenceScores)`
 
 ## 5.1.0-beta.4 (2021-02-10)
 ### New features

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

@@ -13,12 +13,15 @@
 import com.azure.ai.textanalytics.implementation.Utility;
 import com.azure.ai.textanalytics.implementation.models.AnalyzeBatchInput;
 import com.azure.ai.textanalytics.implementation.models.AnalyzeJobState;
+import com.azure.ai.textanalytics.implementation.models.EntitiesResult;
 import com.azure.ai.textanalytics.implementation.models.EntitiesTask;
 import com.azure.ai.textanalytics.implementation.models.EntitiesTaskParameters;
 import com.azure.ai.textanalytics.implementation.models.JobManifestTasks;
+import com.azure.ai.textanalytics.implementation.models.KeyPhraseResult;
 import com.azure.ai.textanalytics.implementation.models.KeyPhrasesTask;
 import com.azure.ai.textanalytics.implementation.models.KeyPhrasesTaskParameters;
 import com.azure.ai.textanalytics.implementation.models.MultiLanguageBatchInput;
+import com.azure.ai.textanalytics.implementation.models.PiiResult;
 import com.azure.ai.textanalytics.implementation.models.PiiTask;
 import com.azure.ai.textanalytics.implementation.models.PiiTaskParameters;
 import com.azure.ai.textanalytics.implementation.models.PiiTaskParametersDomain;
@@ -334,8 +337,11 @@ private AnalyzeBatchActionsResult toAnalyzeTasks(AnalyzeJobState analyzeJobState
             for (int i = 0; i < entityRecognitionTasksItems.size(); i++) {
                 final TasksStateTasksEntityRecognitionTasksItem taskItem = entityRecognitionTasksItems.get(i);
                 final RecognizeEntitiesActionResult actionResult = new RecognizeEntitiesActionResult();
-                RecognizeEntitiesActionResultPropertiesHelper.setResult(actionResult,
-                    toRecognizeEntitiesResultCollectionResponse(taskItem.getResults()));
+                final EntitiesResult results = taskItem.getResults();
+                if (results != null) {
+                    RecognizeEntitiesActionResultPropertiesHelper.setResult(actionResult,
+                        toRecognizeEntitiesResultCollectionResponse(results));
+                }
                 TextAnalyticsActionResultPropertiesHelper.setCompletedAt(actionResult,
                     taskItem.getLastUpdateDateTime());
                 recognizeEntitiesActionResults.add(actionResult);
@@ -345,8 +351,11 @@ private AnalyzeBatchActionsResult toAnalyzeTasks(AnalyzeJobState analyzeJobState
             for (int i = 0; i < piiTasksItems.size(); i++) {
                 final TasksStateTasksEntityRecognitionPiiTasksItem taskItem = piiTasksItems.get(i);
                 final RecognizePiiEntitiesActionResult actionResult = new RecognizePiiEntitiesActionResult();
-                RecognizePiiEntitiesActionResultPropertiesHelper.setResult(actionResult,
-                    toRecognizePiiEntitiesResultCollection(taskItem.getResults()));
+                final PiiResult results = taskItem.getResults();
+                if (results != null) {
+                    RecognizePiiEntitiesActionResultPropertiesHelper.setResult(actionResult,
+                        toRecognizePiiEntitiesResultCollection(results));
+                }
                 TextAnalyticsActionResultPropertiesHelper.setCompletedAt(actionResult,
                     taskItem.getLastUpdateDateTime());
                 recognizePiiEntitiesActionResults.add(actionResult);
@@ -356,8 +365,11 @@ private AnalyzeBatchActionsResult toAnalyzeTasks(AnalyzeJobState analyzeJobState
             for (int i = 0; i < keyPhraseExtractionTasks.size(); i++) {
                 final TasksStateTasksKeyPhraseExtractionTasksItem taskItem = keyPhraseExtractionTasks.get(i);
                 final ExtractKeyPhrasesActionResult actionResult = new ExtractKeyPhrasesActionResult();
-                ExtractKeyPhrasesActionResultPropertiesHelper.setResult(actionResult,
-                    toExtractKeyPhrasesResultCollection(taskItem.getResults()));
+                final KeyPhraseResult results = taskItem.getResults();
+                if (results != null) {
+                    ExtractKeyPhrasesActionResultPropertiesHelper.setResult(actionResult,
+                        toExtractKeyPhrasesResultCollection(results));
+                }
                 TextAnalyticsActionResultPropertiesHelper.setCompletedAt(actionResult,
                     taskItem.getLastUpdateDateTime());
                 extractKeyPhrasesActionResults.add(actionResult);

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

@@ -3,28 +3,29 @@
 
 package com.azure.ai.textanalytics;
 
-import com.azure.ai.textanalytics.implementation.AspectSentimentPropertiesHelper;
-import com.azure.ai.textanalytics.implementation.OpinionSentimentPropertiesHelper;
+import com.azure.ai.textanalytics.implementation.SentenceOpinionPropertiesHelper;
+import com.azure.ai.textanalytics.implementation.TargetSentimentPropertiesHelper;
+import com.azure.ai.textanalytics.implementation.AssessmentSentimentPropertiesHelper;
 import com.azure.ai.textanalytics.implementation.SentenceSentimentPropertiesHelper;
 import com.azure.ai.textanalytics.implementation.TextAnalyticsClientImpl;
 import com.azure.ai.textanalytics.implementation.Utility;
-import com.azure.ai.textanalytics.implementation.models.AspectConfidenceScoreLabel;
-import com.azure.ai.textanalytics.implementation.models.AspectRelationType;
 import com.azure.ai.textanalytics.implementation.models.DocumentError;
 import com.azure.ai.textanalytics.implementation.models.DocumentSentiment;
 import com.azure.ai.textanalytics.implementation.models.DocumentSentimentValue;
 import com.azure.ai.textanalytics.implementation.models.MultiLanguageBatchInput;
-import com.azure.ai.textanalytics.implementation.models.SentenceAspect;
-import com.azure.ai.textanalytics.implementation.models.SentenceOpinion;
+import com.azure.ai.textanalytics.implementation.models.SentenceAssessment;
 import com.azure.ai.textanalytics.implementation.models.SentenceSentimentValue;
+import com.azure.ai.textanalytics.implementation.models.SentenceTarget;
 import com.azure.ai.textanalytics.implementation.models.SentimentConfidenceScorePerLabel;
 import com.azure.ai.textanalytics.implementation.models.SentimentResponse;
+import com.azure.ai.textanalytics.implementation.models.TargetConfidenceScoreLabel;
+import com.azure.ai.textanalytics.implementation.models.TargetRelationType;
 import com.azure.ai.textanalytics.implementation.models.WarningCodeValue;
 import com.azure.ai.textanalytics.models.AnalyzeSentimentOptions;
 import com.azure.ai.textanalytics.models.AnalyzeSentimentResult;
-import com.azure.ai.textanalytics.models.AspectSentiment;
-import com.azure.ai.textanalytics.models.MinedOpinion;
-import com.azure.ai.textanalytics.models.OpinionSentiment;
+import com.azure.ai.textanalytics.models.TargetSentiment;
+import com.azure.ai.textanalytics.models.SentenceOpinion;
+import com.azure.ai.textanalytics.models.AssessmentSentiment;
 import com.azure.ai.textanalytics.models.SentenceSentiment;
 import com.azure.ai.textanalytics.models.SentimentConfidenceScores;
 import com.azure.ai.textanalytics.models.TextAnalyticsWarning;
@@ -166,10 +167,10 @@ private AnalyzeSentimentResult convertToAnalyzeSentimentResult(DocumentSentiment
                 final SentenceSentiment sentenceSentiment1 = new SentenceSentiment(sentenceSentiment.getText(),
                     TextSentiment.fromString(sentenceSentimentValue == null ? null : sentenceSentimentValue.toString()),
                     new SentimentConfidenceScores(confidenceScorePerSentence.getNegative(),
-                        confidenceScorePerSentence.getNeutral(), confidenceScorePerSentence.getPositive()),
-                    toMinedOpinionList(sentenceSentiment, documentSentimentList),
-                    sentenceSentiment.getOffset()
-                );
+                        confidenceScorePerSentence.getNeutral(), confidenceScorePerSentence.getPositive()));
+                SentenceSentimentPropertiesHelper.setOpinions(sentenceSentiment1,
+                    toSentenceOpinionList(sentenceSentiment, documentSentimentList));
+                SentenceSentimentPropertiesHelper.setOffset(sentenceSentiment1, sentenceSentiment.getOffset());
                 SentenceSentimentPropertiesHelper.setLength(sentenceSentiment1, sentenceSentiment.getLength());
                 return sentenceSentiment1;
             }).collect(Collectors.toList());
@@ -229,112 +230,123 @@ private Mono<Response<AnalyzeSentimentResultCollection>> getAnalyzedSentimentRes
     /*
      * Transform SentenceSentiment's opinion mining to output that user can use.
      */
-    private IterableStream<MinedOpinion> toMinedOpinionList(
+    private IterableStream<SentenceOpinion> toSentenceOpinionList(
         com.azure.ai.textanalytics.implementation.models.SentenceSentiment sentenceSentiment,
         List<DocumentSentiment> documentSentimentList) {
-        // If include opinion mining indicator is false, the service return null for the aspect list.
-        final List<SentenceAspect> sentenceAspects = sentenceSentiment.getAspects();
-        if (sentenceAspects == null) {
+        // If include opinion mining indicator is false, the service return null for the target list.
+        final List<SentenceTarget> sentenceTargets = sentenceSentiment.getTargets();
+        if (sentenceTargets == null) {
             return null;
         }
-        final List<MinedOpinion> minedOpinions = new ArrayList<>();
-        sentenceAspects.forEach(sentenceAspect -> {
-            final List<OpinionSentiment> opinionSentiments = new ArrayList<>();
-            sentenceAspect.getRelations().forEach(aspectRelation -> {
-                final AspectRelationType aspectRelationType = aspectRelation.getRelationType();
-                final String opinionPointer = aspectRelation.getRef();
-                if (AspectRelationType.OPINION == aspectRelationType) {
-                    opinionSentiments.add(toOpinionSentiment(
-                        findSentimentOpinion(opinionPointer, documentSentimentList)));
+        final List<SentenceOpinion> sentenceOpinions = new ArrayList<>();
+        sentenceTargets.forEach(sentenceTarget -> {
+            final List<AssessmentSentiment> assessmentSentiments = new ArrayList<>();
+            sentenceTarget.getRelations().forEach(targetRelation -> {
+                final TargetRelationType targetRelationType = targetRelation.getRelationType();
+                final String opinionPointer = targetRelation.getRef();
+                if (TargetRelationType.ASSESSMENT == targetRelationType) {
+                    assessmentSentiments.add(toAssessmentSentiment(
+                        findSentimentAssessment(opinionPointer, documentSentimentList)));
                 }
             });
-            final AspectSentiment aspectSentiment = new AspectSentiment(sentenceAspect.getText(),
-                TextSentiment.fromString(sentenceAspect.getSentiment().toString()),
-                sentenceAspect.getOffset(),
-                toSentimentConfidenceScores(sentenceAspect.getConfidenceScores()));
-            AspectSentimentPropertiesHelper.setLength(aspectSentiment, sentenceAspect.getLength());
-            minedOpinions.add(new MinedOpinion(aspectSentiment, new IterableStream<>(opinionSentiments)));
+            final TargetSentiment targetSentiment = new TargetSentiment();
+            TargetSentimentPropertiesHelper.setText(targetSentiment, sentenceTarget.getText());
+            TargetSentimentPropertiesHelper.setSentiment(targetSentiment,
+                TextSentiment.fromString(sentenceTarget.getSentiment().toString()));
+            TargetSentimentPropertiesHelper.setConfidenceScores(targetSentiment,
+                toSentimentConfidenceScores(sentenceTarget.getConfidenceScores()));
+            TargetSentimentPropertiesHelper.setOffset(targetSentiment, sentenceTarget.getOffset());
+            TargetSentimentPropertiesHelper.setLength(targetSentiment, sentenceTarget.getLength());
+
+            final SentenceOpinion sentenceOpinion = new SentenceOpinion();
+            SentenceOpinionPropertiesHelper.setTarget(sentenceOpinion, targetSentiment);
+            SentenceOpinionPropertiesHelper.setAssessments(sentenceOpinion, new IterableStream<>(assessmentSentiments));
+            sentenceOpinions.add(sentenceOpinion);
         });
 
-        return new IterableStream<>(minedOpinions);
+        return new IterableStream<>(sentenceOpinions);
     }
 
     /*
-     * Transform type AspectConfidenceScoreLabel to SentimentConfidenceScores.
+     * Transform type TargetConfidenceScoreLabel to SentimentConfidenceScores.
      */
     private SentimentConfidenceScores toSentimentConfidenceScores(
-        AspectConfidenceScoreLabel aspectConfidenceScoreLabel) {
-        return new SentimentConfidenceScores(aspectConfidenceScoreLabel.getNegative(), NEUTRAL_SCORE_ZERO,
-            aspectConfidenceScoreLabel.getPositive());
+        TargetConfidenceScoreLabel targetConfidenceScoreLabel) {
+        return new SentimentConfidenceScores(targetConfidenceScoreLabel.getNegative(), NEUTRAL_SCORE_ZERO,
+            targetConfidenceScoreLabel.getPositive());
     }
 
     /*
      * Transform type SentenceOpinion to OpinionSentiment.
      */
-    private OpinionSentiment toOpinionSentiment(SentenceOpinion sentenceOpinion) {
-        final OpinionSentiment opinionSentiment = new OpinionSentiment(sentenceOpinion.getText(),
-            TextSentiment.fromString(sentenceOpinion.getSentiment().toString()),
-            sentenceOpinion.getOffset(), sentenceOpinion.isNegated(),
-            toSentimentConfidenceScores(sentenceOpinion.getConfidenceScores()));
-        OpinionSentimentPropertiesHelper.setLength(opinionSentiment, sentenceOpinion.getLength());
-        return opinionSentiment;
+    private AssessmentSentiment toAssessmentSentiment(SentenceAssessment sentenceAssessment) {
+        final AssessmentSentiment assessmentSentiment = new AssessmentSentiment();
+        AssessmentSentimentPropertiesHelper.setText(assessmentSentiment, sentenceAssessment.getText());
+        AssessmentSentimentPropertiesHelper.setSentiment(assessmentSentiment,
+            TextSentiment.fromString(sentenceAssessment.getSentiment().toString()));
+        AssessmentSentimentPropertiesHelper.setConfidenceScores(assessmentSentiment,
+            toSentimentConfidenceScores(sentenceAssessment.getConfidenceScores()));
+        AssessmentSentimentPropertiesHelper.setNegated(assessmentSentiment, sentenceAssessment.isNegated());
+        AssessmentSentimentPropertiesHelper.setOffset(assessmentSentiment, sentenceAssessment.getOffset());
+        AssessmentSentimentPropertiesHelper.setLength(assessmentSentiment, sentenceAssessment.getLength());
+        return assessmentSentiment;
     }
 
     /*
      * Parses the reference pointer to an index array that contains document, sentence, and opinion indexes.
      */
-    int[] parseRefPointerToIndexArray(String opinionPointer) {
-        // The pattern always start with character '#', the opinion index will existing in specified sentence, which
+    int[] parseRefPointerToIndexArray(String assessmentPointer) {
+        // The pattern always start with character '#', the assessment index will existing in specified sentence, which
         // is under specified document.
-        // example: #/documents/0/sentences/0/opinions/0
-        final String patternRegex = "#/documents/(\\d+)/sentences/(\\d+)/opinions/(\\d+)";
+        // example: #/documents/0/sentences/0/assessments/0
+        final String patternRegex = "#/documents/(\\d+)/sentences/(\\d+)/assessments/(\\d+)";
         final Pattern pattern = Pattern.compile(patternRegex);
-        final Matcher matcher = pattern.matcher(opinionPointer);
+        final Matcher matcher = pattern.matcher(assessmentPointer);
         final boolean isMatched = matcher.find();
 
         // The first index represents the document index, second one represents the sentence index,
-        // third ond represents the opinion index.
+        // third ond represents the assessment index.
         final int[] result = new int[3];
 
         if (isMatched) {
-            String[] segments = opinionPointer.split("/");
+            String[] segments = assessmentPointer.split("/");
             result[0] = Integer.parseInt(segments[2]);
             result[1] = Integer.parseInt(segments[4]);
             result[2] = Integer.parseInt(segments[6]);
         } else {
             throw logger.logExceptionAsError(new IllegalStateException(
-                String.format("'%s' is not a valid opinion pointer.", opinionPointer)));
+                String.format("'%s' is not a valid assessment pointer.", assessmentPointer)));
         }
 
         return result;
     }
 
     /*
-     * Find the specific sentence opinion in the document sentiment list by given the opinion reference pointer.
+     * Find the specific sentence assessment in the document sentiment list by given the assessment reference pointer.
      */
-    SentenceOpinion findSentimentOpinion(String opinionPointer, List<DocumentSentiment> documentSentiments) {
-        final int[] opinionIndexes = parseRefPointerToIndexArray(opinionPointer);
-        final int documentIndex = opinionIndexes[0];
-        final int sentenceIndex = opinionIndexes[1];
-        final int opinionIndex = opinionIndexes[2];
+    SentenceAssessment findSentimentAssessment(String assessmentPointer, List<DocumentSentiment> documentSentiments) {
+        final int[] assessmentIndexes = parseRefPointerToIndexArray(assessmentPointer);
+        final int documentIndex = assessmentIndexes[0];
+        final int sentenceIndex = assessmentIndexes[1];
+        final int assessmentIndex = assessmentIndexes[2];
         if (documentIndex >= documentSentiments.size()) {
             throw logger.logExceptionAsError(new IllegalStateException(
-                String.format("Invalid document index '%s' in '%s'.", documentIndex, opinionPointer)));
+                String.format("Invalid document index '%s' in '%s'.", documentIndex, assessmentPointer)));
         }
         final DocumentSentiment documentsentiment = documentSentiments.get(documentIndex);
 
         final List<com.azure.ai.textanalytics.implementation.models.SentenceSentiment> sentenceSentiments =
             documentsentiment.getSentences();
         if (sentenceIndex >= sentenceSentiments.size()) {
             throw logger.logExceptionAsError(new IllegalStateException(
-                String.format("Invalid sentence index '%s' in '%s'.", sentenceIndex, opinionPointer)));
+                String.format("Invalid sentence index '%s' in '%s'.", sentenceIndex, assessmentPointer)));
         }
 
-        final List<SentenceOpinion> opinions = sentenceSentiments.get(sentenceIndex).getOpinions();
-        if (opinionIndex >= opinions.size()) {
+        final List<SentenceAssessment> assessments = sentenceSentiments.get(sentenceIndex).getAssessments();
+        if (assessmentIndex >= assessments.size()) {
             throw logger.logExceptionAsError(new IllegalStateException(
-                String.format("Invalid opinion index '%s' in '%s'.", opinionIndex, opinionPointer)));
+                String.format("Invalid assessment index '%s' in '%s'.", assessmentIndex, assessmentPointer)));
         }
-        return opinions.get(opinionIndex);
+        return assessments.get(assessmentIndex);
     }
 }