Share via

PiiEntity Class

Entity object with tags.

Constructor

PiiEntity(*args: Any, **kwargs: Any)

Variables

Name Description
text
str

Entity text as appears in the request. Required.
category
str

Entity type. Required.
subcategory
str

(Optional) Entity sub type.
offset
int

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned. Required.
length
int

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned. Required.
confidence_score
float

Confidence score between 0 and 1 of the extracted entity. Required.
type
str

An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.
tags
list[EntityTag]

List of entity tags. Tags are to express some similarities/affinity between entities.
mask
str

Optional field which will be returned only when using the redaction policy kind "MaskWithEntityType". This field will contain the exact mask text used to mask the PII entity in the original text.
mask_offset
int

Start position of masked text in the redacted text when using the redaction policy kind "MaskWithEntityType".
mask_length
int

The length of the masked text. Will be present when using the redaction policy kind "MaskWithEntityType".

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

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

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

category

Entity type. Required.

category: str

confidence_score

Confidence score between 0 and 1 of the extracted entity. Required.

confidence_score: float

length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned. Required.

length: int

mask

Optional field which will be returned only when using the redaction policy kind "MaskWithEntityType". This field will contain the exact mask text used to mask the PII entity in the original text.

mask: str | None

mask_length

The length of the masked text. Will be present when using the redaction policy kind "MaskWithEntityType".

mask_length: int | None

mask_offset

Start position of masked text in the redacted text when using the redaction policy kind "MaskWithEntityType".

mask_offset: int | None

offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned. Required.

offset: int

subcategory

(Optional) Entity sub type.

subcategory: str | None

tags

List of entity tags. Tags are to express some similarities/affinity between entities.

tags: list['_models.EntityTag'] | None

text

Entity text as appears in the request. Required.

text: str

type

An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

type: str | None