Package com.azure.ai.textanalytics.models

Class SingleCategoryClassifyResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.SingleCategoryClassifyResult

public final class SingleCategoryClassifyResult
extends TextAnalyticsResult

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ClassificationCategory	getClassification()	The document classification result which contains the classified category and the confidence score on it.
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 Detail

SingleCategoryClassifyResult

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

Creates a SingleCategoryClassifyResult model.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Detail

getClassification

public ClassificationCategory getClassification()

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

Returns:

The ClassificationCategory.

getWarnings

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

Gets the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.