RecognizePiiEntitiesResult Class

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

Inheritance

azure.ai.textanalytics._dict_mixin.DictMixin

RecognizePiiEntitiesResult

Constructor

RecognizePiiEntitiesResult(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get

get(key: str, default: Any | None = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

has_key

has_key(k: str) -> bool

Parameters

Name	Description
k Required

items

items() -> Iterable[Tuple[str, Any]]

keys

keys() -> Iterable[str]

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> Iterable[Any]

Attributes

entities

Recognized PII entities in the document.

entities: List[PiiEntity]

id

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.

id: str

is_error

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

is_error: Literal[False] = False

kind

The text analysis kind - "PiiEntityRecognition".

kind: Literal['PiiEntityRecognition'] = 'PiiEntityRecognition'

redacted_text

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

redacted_text: str

statistics

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

statistics: TextDocumentStatistics | None = None

warnings

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

warnings: List[TextAnalyticsWarning]