Package com.azure.ai.textanalytics.models

Class RecognizePiiEntitiesResult

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

Constructors

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	Description
DetectedLanguage	getDetectedLanguage()	Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.
PiiEntityCollection	getEntities()	Gets an IterableStream of PiiEntity.

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 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 of PiiEntity.

Returns:

An IterableStream of PiiEntity.

Throws:

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

getDetectedLanguage

public DetectedLanguage getDetectedLanguage()

Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.

Returns:

the detectedLanguage value.