Package com.azure.ai.textanalytics.models

Class AnalyzeSentimentActionResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActionResult

com.azure.ai.textanalytics.models.AnalyzeSentimentActionResult

public final class AnalyzeSentimentActionResult
extends TextAnalyticsActionResult

The AnalyzeSentimentActionResult model.

Constructor Summary

Constructors

Constructor	Description
AnalyzeSentimentActionResult()	Constructs a AnalyzeSentimentActionResult model.

Method Summary

Modifier and Type	Method	Description
AnalyzeSentimentResultCollection	getDocumentsResults()	Gets the sentiment analysis action result.

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

getActionName, getCompletedAt, getError, isError

Methods inherited from class java.lang.Object

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

Constructor Details

AnalyzeSentimentActionResult

public AnalyzeSentimentActionResult()

Constructs a AnalyzeSentimentActionResult model.

Method Details

getDocumentsResults

public AnalyzeSentimentResultCollection getDocumentsResults()

Gets the sentiment analysis action result.

Returns:

The sentiment analysis action result.

Throws:

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