Package com.azure.ai.textanalytics.models

Class RecognizeLinkedEntitiesResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.RecognizeLinkedEntitiesResult

public final class RecognizeLinkedEntitiesResult
extends TextAnalyticsResult

The RecognizeLinkedEntitiesResult model.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LinkedEntityCollection	getEntities()	Gets an IterableStream of LinkedEntity.

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

RecognizeLinkedEntitiesResult

public RecognizeLinkedEntitiesResult(String id,
                                     TextDocumentStatistics textDocumentStatistics,
                                     TextAnalyticsError error,
                                     LinkedEntityCollection entities)

Creates a RecognizeLinkedEntitiesResult model that describes recognized linked entities result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

entities - A LinkedEntityCollection contains entities and warnings.

Method Detail

getEntities

public LinkedEntityCollection getEntities()

Gets an IterableStream of LinkedEntity.

Returns:

An IterableStream of LinkedEntity.

Throws:

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