Package com.azure.ai.textanalytics.models

Class PiiEntityCollection

java.lang.Object

com.azure.core.util.IterableStream<PiiEntity>

com.azure.ai.textanalytics.models.PiiEntityCollection

All Implemented Interfaces:

Iterable<PiiEntity>

public final class PiiEntityCollection
extends IterableStream<PiiEntity>

The PiiEntityCollection model.

Constructor Summary

Constructors

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	Description
String	getRedactedText()	Get the property redactedText value.
IterableStream<TextAnalyticsWarning>	getWarnings()	Get the IterableStream of Text Analytics warnings.

Methods inherited from class com.azure.core.util.IterableStream

iterator, of, stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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 of Personally Identifiable Information entities.

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

warnings - An IterableStream of warnings.

Method Details

getWarnings

public IterableStream<TextAnalyticsWarning> getWarnings()

Get the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.

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

Returns:

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