ClassifyDocumentResult Class

Package:

com.azure.ai.textanalytics.models

Maven Artifact:

com.azure:azure-ai-textanalytics:5.5.12

• 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

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

Method Summary

Modifier and Type	Method and Description
IterableStream<ClassificationCategory>	getClassifications() The document classification result which contains the classification category and the confidence score on it.
IterableStream<TextAnalyticsWarning>	getWarnings() Gets the IterableStream<T> of TextAnalyticsWarning.

Methods inherited from TextAnalyticsResult

getError getId getStatistics isError

Methods inherited from 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 IterableStream<ClassificationCategory> getClassifications()

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

Returns:

IterableStream<T> of ClassificationCategory.

getWarnings

public IterableStream<TextAnalyticsWarning> getWarnings()

Gets the IterableStream<T> of TextAnalyticsWarning.

Returns:

IterableStream<T> of TextAnalyticsWarning.