Package com.azure.ai.textanalytics.models

Class AnalyzeSentimentResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.AnalyzeSentimentResult

public final class AnalyzeSentimentResult
extends TextAnalyticsResult

The AnalyzeSentimentResult model.

Constructor Summary

Constructors

Constructor	Description
AnalyzeSentimentResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, DocumentSentiment documentSentiment)	Creates a AnalyzeSentimentResult model that describes analyzed sentiment result.

Method Summary

Modifier and Type	Method	Description
DocumentSentiment	getDocumentSentiment()	Gets the document sentiment.

Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsResult

getError, getId, getStatistics, isError

Methods inherited from class java.lang.Object

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

Constructor Details

AnalyzeSentimentResult

public AnalyzeSentimentResult(String id,
 TextDocumentStatistics textDocumentStatistics,
 TextAnalyticsError error,
 DocumentSentiment documentSentiment)

Creates a AnalyzeSentimentResult model that describes analyzed sentiment result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

documentSentiment - The document sentiment.

Method Details

getDocumentSentiment

public DocumentSentiment getDocumentSentiment()

Gets the document sentiment.

Returns:

The document sentiment.

Throws:

TextAnalyticsException - if result has isError equals to true and when a non-error property was accessed.