diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentiment.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentiment.cs index 9ef9a40e579e..222ceb23d75e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentiment.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentiment.cs @@ -16,7 +16,7 @@ namespace Azure.AI.TextAnalytics /// public class DocumentSentiment { - internal DocumentSentiment(SentimentLabel sentiment, double positiveScore, double neutralScore, double negativeScore, List sentenceSentiments) + internal DocumentSentiment(DocumentSentimentLabel sentiment, double positiveScore, double neutralScore, double negativeScore, List sentenceSentiments) { Sentiment = sentiment; ConfidenceScores = new SentimentConfidenceScorePerLabel(positiveScore, neutralScore, negativeScore); @@ -27,7 +27,7 @@ internal DocumentSentiment(SentimentLabel sentiment, double positiveScore, doubl /// Gets the predicted sentiment for the analyzed input document /// or substring. /// - public SentimentLabel Sentiment { get; } + public DocumentSentimentLabel Sentiment { get; } /// /// Gets the sentiment confidence score (Softmax score) between 0 and 1, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentimentLabel.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentimentLabel.cs similarity index 77% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/SentimentLabel.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentimentLabel.cs index 7f2c54ba6a93..8daadaa88988 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentimentLabel.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DocumentSentimentLabel.cs @@ -4,10 +4,9 @@ namespace Azure.AI.TextAnalytics { /// - /// The predicted sentiment label for a given span of text. + /// The predicted sentiment label for a given document. /// - public enum SentimentLabel - #pragma warning restore + public enum DocumentSentimentLabel { /// /// Indicates that the sentiment is positive. @@ -15,7 +14,7 @@ public enum SentimentLabel Positive, /// - /// Indicates that the lacks a sentiment. + /// Indicates that the sentiment is neutral. /// Neutral, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentiment.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentiment.cs index a6893a29bded..6487be3ee955 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentiment.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentiment.cs @@ -10,7 +10,7 @@ namespace Azure.AI.TextAnalytics /// public readonly struct SentenceSentiment { - internal SentenceSentiment(SentimentLabel sentiment, double positiveScore, double neutralScore, double negativeScore, int offset, int length) + internal SentenceSentiment(SentenceSentimentLabel sentiment, double positiveScore, double neutralScore, double negativeScore, int offset, int length) { Sentiment = sentiment; ConfidenceScores = new SentimentConfidenceScorePerLabel(positiveScore, neutralScore, negativeScore); @@ -22,7 +22,7 @@ internal SentenceSentiment(SentimentLabel sentiment, double positiveScore, doubl /// Gets the predicted sentiment for the analyzed input document /// or substring. /// - public SentimentLabel Sentiment { get; } + public SentenceSentimentLabel Sentiment { get; } /// /// Gets the sentiment confidence score (Softmax score) between 0 and 1, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentimentLabel.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentimentLabel.cs new file mode 100644 index 000000000000..c10cbacabef9 --- /dev/null +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/SentenceSentimentLabel.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +namespace Azure.AI.TextAnalytics +{ + /// + /// The predicted sentiment label for a given sentence. + /// + public enum SentenceSentimentLabel + { + /// + /// Indicates that the sentiment is positive. + /// + Positive, + + /// + /// Indicates that the sentiment is neutral. + /// + Neutral, + + /// + /// Indicates that the sentiment is negative. + /// + Negative, + } +} diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsServiceSerializer.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsServiceSerializer.cs index 82bfa13e60a2..0107ad25e3d9 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsServiceSerializer.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsServiceSerializer.cs @@ -404,14 +404,14 @@ private static AnalyzeSentimentResult ReadDocumentSentimentResult(JsonElement do private static DocumentSentiment ReadDocumentSentiment(JsonElement documentElement, string scoresElementName) { - SentimentLabel sentiment = default; + DocumentSentimentLabel sentiment = default; double positiveScore = default; double neutralScore = default; double negativeScore = default; if (documentElement.TryGetProperty("sentiment", out JsonElement sentimentValue)) { - sentiment = (SentimentLabel)Enum.Parse(typeof(SentimentLabel), sentimentValue.ToString(), ignoreCase: true); + sentiment = (DocumentSentimentLabel)Enum.Parse(typeof(DocumentSentimentLabel), sentimentValue.ToString(), ignoreCase: true); } if (documentElement.TryGetProperty(scoresElementName, out JsonElement scoreValues)) @@ -440,7 +440,7 @@ private static DocumentSentiment ReadDocumentSentiment(JsonElement documentEleme private static SentenceSentiment ReadSentenceSentiment(JsonElement documentElement, string scoresElementName) { - SentimentLabel sentiment = default; + SentenceSentimentLabel sentiment = default; double positiveScore = default; double neutralScore = default; double negativeScore = default; @@ -449,7 +449,7 @@ private static SentenceSentiment ReadSentenceSentiment(JsonElement documentEleme if (documentElement.TryGetProperty("sentiment", out JsonElement sentimentValue)) { - sentiment = (SentimentLabel)Enum.Parse(typeof(SentimentLabel), sentimentValue.ToString(), ignoreCase: true); + sentiment = (SentenceSentimentLabel)Enum.Parse(typeof(SentenceSentimentLabel), sentimentValue.ToString(), ignoreCase: true); } if (documentElement.TryGetProperty(scoresElementName, out JsonElement scoreValues))