Package com.azure.ai.textanalytics.models

Class AssessmentSentiment

java.lang.Object

com.azure.ai.textanalytics.models.AssessmentSentiment

public final class AssessmentSentiment
extends Object

The AssessmentSentiment model.

Constructor Summary

Constructors

Constructor	Description
AssessmentSentiment()	Constructs a AssessmentSentiment model.

Method Summary

Modifier and Type	Method	Description
SentimentConfidenceScores	getConfidenceScores()	Gets the confidence score of the sentiment label.
int	getLength()	Gets the length of opinion text.
int	getOffset()	Gets the offset of opinion text.
TextSentiment	getSentiment()	Gets the opinion text sentiment label: POSITIVE, NEGATIVE, MIXED.
String	getText()	Gets the opinion text property.
boolean	isNegated()	Gets the boolean indicator to show if the text is negative.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AssessmentSentiment

public AssessmentSentiment()

Constructs a AssessmentSentiment model.

Method Details

getText

public String getText()

Gets the opinion text property.

Returns:

The text value.

getSentiment

public TextSentiment getSentiment()

Gets the opinion text sentiment label: POSITIVE, NEGATIVE, MIXED. TextSentiment has neutral sentiment type additionally, but target sentiment can only be positive, negative, or mixed.

Returns:

The sentiment value.

getOffset

public int getOffset()

Gets the offset of opinion text.

Returns:

The offset of opinion text.

getLength

public int getLength()

Gets the length of opinion text.

Returns:

The length of opinion text.

isNegated

public boolean isNegated()

Gets the boolean indicator to show if the text is negative.

Returns:

The boolean indicator to show if the text is negative.

getConfidenceScores

public SentimentConfidenceScores getConfidenceScores()

Gets the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the higher the confidence in the sentiment. AssessmentSentiment only has positive or negative confidence score value because there is no neutral sentiment label in the AssessmentSentiment.

Returns:

The SentimentConfidenceScores.