RecognizePiiEntitiesResult 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.RecognizePiiEntitiesResult

public final class RecognizePiiEntitiesResult
extends TextAnalyticsResult

The RecognizePiiEntitiesResult model.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
PiiEntityCollection	getEntities() Gets an IterableStream<T> of PiiEntity.

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

RecognizePiiEntitiesResult

public RecognizePiiEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, PiiEntityCollection entities)

Creates a RecognizePiiEntitiesResult model that describes recognized PII entities result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

entities - A PiiEntityCollection contains entities and warnings.

Method Details

getEntities

public PiiEntityCollection getEntities()

Gets an IterableStream<T> of PiiEntity.

Returns:

An IterableStream<T> of PiiEntity.