RecognizePiiEntitiesResult Class

RecognizePiiEntitiesResult is a result object which contains the recognized Personally Identifiable Information (PII) entities from a particular document.

New in version v3.1-preview: The redacted_text parameter.

Inheritance
azure.ai.textanalytics._models.DictMixin
RecognizePiiEntitiesResult

Constructor

RecognizePiiEntitiesResult(**kwargs)

Variables

id
str

Unique, non-empty document identifier that matches the document id that was passed in with the request. If not specified in the request, an id is assigned for the document.

entities
list[PiiEntity]

Recognized PII entities in the document.

redacted_text
str

Returns the text of the input document with all of the PII information redacted out. Only returned for API versions v3.1-preview and up.

warnings
list[TextAnalyticsWarning]

Warnings encountered while processing document. Results will still be returned if there are warnings, but they may not be fully accurate.

statistics
TextDocumentStatistics

If show_stats=True was specified in the request this field will contain information about the document payload.

is_error
bool

Boolean check for error item when iterating over list of results. Always False for an instance of a RecognizePiiEntitiesResult.