PR feedback

Author: maririos

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentType.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/AdditionalSentimentAnalyses.cs

@@ -1,18 +1,19 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+ // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using System;
 
 namespace Azure.AI.TextAnalytics
 {
     /// <summary>
-    /// Specialized types of Sentiment Analysis, like for example Opinion Mining.
+    /// Additional types of Sentiment Analysis to be applied to the
+    /// AnalyzeSentiment method, like for example Opinion Mining.
     /// </summary>
     [Flags]
-    public enum AnalyzeSentimentType
+    public enum AdditionalSentimentAnalyses
     {
         /// <summary>
-        /// Sentiment analysis for documents and its sentences.
+        /// Use standard sentiment analysis for documents and its sentences.
         /// </summary>
         None = 0,
 

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

@@ -23,9 +23,9 @@ internal AnalyzeSentimentOptions(TextAnalyticsRequestOptions options)
         }
 
         /// <summary>
-        /// Specifies the types of analysis to apply, like for example,
-        /// Opinion mining.
+        /// Additional types of Sentiment Analysis to be applied to the
+        /// AnalyzeSentiment method, like for example Opinion Mining.
         /// </summary>
-        public AnalyzeSentimentType IncludeAnalysis { get; set; }
+        public AdditionalSentimentAnalyses AdditionalSentimentAnalyses { get; set; }
 }
 }

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

@@ -57,7 +57,7 @@ internal SentenceSentiment(SentenceSentimentInternal sentenceSentiment, IReadOnl
 
         /// <summary>
         /// Gets the mined opinions of a sentence. This is only returned if
-        /// <see cref="AnalyzeSentimentType.OpinionMining"/> is set in <see cref="AnalyzeSentimentOptions.IncludeAnalysis"/>.
+        /// <see cref="AdditionalSentimentAnalyses.OpinionMining"/> is set in <see cref="AnalyzeSentimentOptions.AdditionalSentimentAnalyses"/>.
         /// </summary>
         public IReadOnlyCollection<MinedOpinion> MinedOpinions { get; }
 

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

@@ -788,7 +788,7 @@ public virtual async Task<Response<DocumentSentiment>> AnalyzeSentimentAsync(str
             try
             {
                 var documents = new List<MultiLanguageInput>() { ConvertToMultiLanguageInput(document, language) };
-                bool opinionMining = options.IncludeAnalysis.HasFlag(AnalyzeSentimentType.OpinionMining) ? true : false;
+                bool opinionMining = options.AdditionalSentimentAnalyses.HasFlag(AdditionalSentimentAnalyses.OpinionMining);
                 Response<SentimentResponse> result = await _serviceRestClient.SentimentAsync(
                     new MultiLanguageBatchInput(documents),
                     options.ModelVersion,
@@ -849,7 +849,7 @@ public virtual Response<DocumentSentiment> AnalyzeSentiment(string document, str
             try
             {
                 var documents = new List<MultiLanguageInput>() { ConvertToMultiLanguageInput(document, language) };
-                bool opinionMining = options.IncludeAnalysis.HasFlag(AnalyzeSentimentType.OpinionMining) ? true : false;
+                bool opinionMining = options.AdditionalSentimentAnalyses.HasFlag(AdditionalSentimentAnalyses.OpinionMining);
                 Response<SentimentResponse> result = _serviceRestClient.Sentiment(
                     new MultiLanguageBatchInput(documents),
                     options.ModelVersion,
@@ -1128,7 +1128,7 @@ private async Task<Response<AnalyzeSentimentResultCollection>> AnalyzeSentimentB
 
             try
             {
-                bool opinionMining = options.IncludeAnalysis.HasFlag(AnalyzeSentimentType.OpinionMining) ? true : false;
+                bool opinionMining = options.AdditionalSentimentAnalyses.HasFlag(AdditionalSentimentAnalyses.OpinionMining);
                 Response<SentimentResponse> result = await _serviceRestClient.SentimentAsync(
                     batchInput,
                     options.ModelVersion,
@@ -1156,7 +1156,7 @@ private Response<AnalyzeSentimentResultCollection> AnalyzeSentimentBatch(MultiLa
 
             try
             {
-                bool opinionMining = options.IncludeAnalysis.HasFlag(AnalyzeSentimentType.OpinionMining) ? true : false;
+                bool opinionMining = options.AdditionalSentimentAnalyses.HasFlag(AdditionalSentimentAnalyses.OpinionMining);
                 Response<SentimentResponse> result = _serviceRestClient.Sentiment(
                     batchInput,
                     options.ModelVersion,

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

@@ -65,7 +65,7 @@ public async Task AnalyzeSentimentWithOpinionMining()
             TextAnalyticsClient client = GetClient();
             string document = "The park was clean and pretty. The bathrooms and restaurant were not clean.";
 
-            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, options: new AnalyzeSentimentOptions() { IncludeOpinionMining = true });
+            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, options: new AnalyzeSentimentOptions() { AdditionalSentimentAnalyses = AdditionalSentimentAnalyses.OpinionMining });
 
             CheckAnalyzeSentimentProperties(docSentiment, opinionMining: true);
             Assert.AreEqual("Mixed", docSentiment.Sentiment.ToString());
@@ -77,7 +77,7 @@ public async Task AnalyzeSentimentWithOpinionMiningEmpty()
             TextAnalyticsClient client = GetClient();
             string document = singleEnglish;
 
-            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, "en", new AnalyzeSentimentOptions() { IncludeOpinionMining = true });
+            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, "en", new AnalyzeSentimentOptions() { AdditionalSentimentAnalyses = AdditionalSentimentAnalyses.OpinionMining });
 
             CheckAnalyzeSentimentProperties(docSentiment);
             Assert.AreEqual("Positive", docSentiment.Sentiment.ToString());
@@ -89,7 +89,7 @@ public async Task AnalyzeSentimentWithOpinionMiningNegated()
             TextAnalyticsClient client = GetClient();
             string document = "The bathrooms are not clean.";
 
-            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, options: new AnalyzeSentimentOptions() { IncludeOpinionMining = true });
+            DocumentSentiment docSentiment = await client.AnalyzeSentimentAsync(document, options: new AnalyzeSentimentOptions() { AdditionalSentimentAnalyses = AdditionalSentimentAnalyses.OpinionMining });
 
             CheckAnalyzeSentimentProperties(docSentiment, opinionMining: true);
             MinedOpinion minedOpinion = docSentiment.Sentences.FirstOrDefault().MinedOpinions.FirstOrDefault();
@@ -151,7 +151,7 @@ public async Task AnalyzeSentimentBatchConvenienceWithOpinionMiningTest()
                 "The food and service is not good."
             };
 
-            AnalyzeSentimentResultCollection results = await client.AnalyzeSentimentBatchAsync(documents, options: new AnalyzeSentimentOptions() { IncludeOpinionMining = true });
+            AnalyzeSentimentResultCollection results = await client.AnalyzeSentimentBatchAsync(documents, options: new AnalyzeSentimentOptions() { AdditionalSentimentAnalyses = AdditionalSentimentAnalyses.OpinionMining });
 
             foreach (AnalyzeSentimentResult docs in results)
             {
@@ -334,7 +334,7 @@ public async Task AnalyzeSentimentBatchWithOpinionMiningTest()
                 }
             };
 
-            AnalyzeSentimentResultCollection results = await client.AnalyzeSentimentBatchAsync(documents, options: new AnalyzeSentimentOptions() { IncludeOpinionMining = true });
+            AnalyzeSentimentResultCollection results = await client.AnalyzeSentimentBatchAsync(documents, options: new AnalyzeSentimentOptions() { AdditionalSentimentAnalyses = AdditionalSentimentAnalyses.OpinionMining });
 
             foreach (AnalyzeSentimentResult docs in results)
             {