Package com.azure.ai.textanalytics.models

Class ClassifyDocumentResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.ClassifyDocumentResult

public final class ClassifyDocumentResult
extends TextAnalyticsResult

The ClassifyDocumentResult model. It classify the text document one single category.

Constructor Summary

Constructors

Constructor	Description
ClassifyDocumentResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a ClassifyDocumentResult model.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.IterableStream<ClassificationCategory>	getClassifications()	The document classification result which contains the classification category and the confidence score on it.
DetectedLanguage	getDetectedLanguage()	Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.
com.azure.core.util.IterableStream<TextAnalyticsWarning>	getWarnings()	Gets the IterableStream of Text Analytics warnings.

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

ClassifyDocumentResult

public ClassifyDocumentResult(String id,
 TextDocumentStatistics textDocumentStatistics,
 TextAnalyticsError error)

Creates a ClassifyDocumentResult model.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Details

getClassifications

public com.azure.core.util.IterableStream<ClassificationCategory> getClassifications()

The document classification result which contains the classification category and the confidence score on it.

Returns:

IterableStream of ClassificationCategory.

getDetectedLanguage

public DetectedLanguage getDetectedLanguage()

Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.

Returns:

the detectedLanguage value.

getWarnings

public com.azure.core.util.IterableStream<TextAnalyticsWarning> getWarnings()

Gets the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.