Package com.azure.ai.textanalytics.models

Class MultiCategoryClassifyResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.MultiCategoryClassifyResult

public final class MultiCategoryClassifyResult
extends TextAnalyticsResult

The MultiCategoryClassifyResult model. It classifies the text document the multiple categories.

Constructor Summary

Constructors

Constructor	Description
MultiCategoryClassifyResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a MultiCategoryClassifyResult model that describes recognized document classification result.

Method Summary

Modifier and Type	Method	Description
ClassificationCategoryCollection	getClassifications()	Gets an IterableStream of ClassificationCategory.

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

MultiCategoryClassifyResult

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

Creates a MultiCategoryClassifyResult model that describes recognized document classification result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Detail

getClassifications

public ClassificationCategoryCollection getClassifications()

Gets an IterableStream of ClassificationCategory.

Returns:

An IterableStream of ClassificationCategory.

Throws:

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