Package com.azure.ai.textanalytics.models

Class RecognizeEntitiesResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.RecognizeEntitiesResult

public final class RecognizeEntitiesResult
extends TextAnalyticsResult

The RecognizeEntitiesResult model.

Constructor Summary

Constructors

Constructor	Description
RecognizeEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, CategorizedEntityCollection entities)	Creates a RecognizeEntitiesResult model that describes recognized entities result.

Method Summary

Modifier and Type	Method	Description
CategorizedEntityCollection	getEntities()	Gets an IterableStream of CategorizedEntity.

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

RecognizeEntitiesResult

public RecognizeEntitiesResult(String id,
                               TextDocumentStatistics textDocumentStatistics,
                               TextAnalyticsError error,
                               CategorizedEntityCollection entities)

Creates a RecognizeEntitiesResult model that describes recognized entities result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

entities - A CategorizedEntityCollection contains entities and warnings.

Method Detail

getEntities

public CategorizedEntityCollection getEntities()

Gets an IterableStream of CategorizedEntity.

Returns:

An IterableStream of CategorizedEntity.

Throws:

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