Package com.azure.ai.textanalytics.models

Class TextAnalyticsResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

Direct Known Subclasses:

AbstractiveSummaryResult, AnalyzeHealthcareEntitiesResult, AnalyzeSentimentResult, ClassifyDocumentResult, DetectLanguageResult, ExtractiveSummaryResult, ExtractKeyPhraseResult, RecognizeEntitiesResult, RecognizeLinkedEntitiesResult, RecognizePiiEntitiesResult

public class TextAnalyticsResult
extends Object

The TextAnalyticsResult model.

Method Summary

Modifier and Type	Method	Description
TextAnalyticsError	getError()	Get the error of text document.
String	getId()	Get the document id.
TextDocumentStatistics	getStatistics()	Get the statistics of the text document.
boolean	isError()	Get the boolean value indicates if the document result is error or not.

Methods inherited from class java.lang.Object

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

Method Details

getId

public String getId()

Get the document id.

Returns:

The document id.

getStatistics

public TextDocumentStatistics getStatistics()

Get the statistics of the text document.

Returns:

The TextDocumentStatistics statistics of the text document.

Throws:

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

getError

public TextAnalyticsError getError()

Get the error of text document.

Returns:

The error of text document.

isError

public boolean isError()

Get the boolean value indicates if the document result is error or not.

Returns:

A boolean indicates if the document result is error or not.