Package com.azure.ai.textanalytics.models

Class RecognizePiiEntitiesActionResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActionResult

com.azure.ai.textanalytics.models.RecognizePiiEntitiesActionResult

public final class RecognizePiiEntitiesActionResult
extends TextAnalyticsActionResult

The RecognizePiiEntitiesActionResult model.

Constructor Summary

Constructors

Constructor	Description
RecognizePiiEntitiesActionResult()	Constructs a RecognizePiiEntitiesActionResult model.

Method Summary

Modifier and Type	Method	Description
RecognizePiiEntitiesResultCollection	getDocumentsResults()	Gets the PII entities recognition action result.

Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsActionResult

getActionName, getCompletedAt, getError, isError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RecognizePiiEntitiesActionResult

public RecognizePiiEntitiesActionResult()

Constructs a RecognizePiiEntitiesActionResult model.

Method Details

getDocumentsResults

public RecognizePiiEntitiesResultCollection getDocumentsResults()

Gets the PII entities recognition action result.

Returns:

The PII entities recognition action result.

Throws:

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