PiiEntityCollection Class

Package:
com.azure.ai.textanalytics.models
Maven Artifact:
com.azure:azure-ai-textanalytics:5.5.12

public final class PiiEntityCollection
extends IterableStream<PiiEntity>

The PiiEntityCollection model.

Constructor Summary

Constructor Description
PiiEntityCollection(IterableStream<PiiEntity> entities, String redactedText, IterableStream<TextAnalyticsWarning> warnings)

Creates a PiiEntityCollection model that describes a Personally Identifiable Information entities collection including warnings.

Method Summary

Modifier and Type Method and Description
String getRedactedText()

Get the property redactedText value.
IterableStream<TextAnalyticsWarning> getWarnings()

Get the IterableStream<T> of TextAnalyticsWarning.

Methods inherited from IterableStream

<T>of iterator stream

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PiiEntityCollection

public PiiEntityCollection(IterableStream<PiiEntity> entities, String redactedText, IterableStream<TextAnalyticsWarning> warnings)

Creates a PiiEntityCollection model that describes a Personally Identifiable Information entities collection including warnings.

Parameters:

entities - An IterableStream<T> of PiiEntity.
redactedText - The text of the input document with all of the PII information redacted out.

Method Details

getRedactedText

public String getRedactedText()

Get the property redactedText value. The text of the input document with all of the PII information redacted out. Only returned for API version v3.1 and newer.

Returns:

The text of the input document with all of the PII information redacted out.

getWarnings

public IterableStream<TextAnalyticsWarning> getWarnings()

Get the IterableStream<T> of TextAnalyticsWarning.

Returns:

Applies to