PiiEntityMasking

class oci.ai_language.models.PiiEntityMasking(**kwargs)

Bases: object

Mask recognized PII entities with different modes.

Attributes:

MODE_MASK

A constant which can be used with the mode property of a PiiEntityMasking.

MODE_RELEXIFY

A constant which can be used with the mode property of a PiiEntityMasking.

MODE_REMOVE

A constant which can be used with the mode property of a PiiEntityMasking.

MODE_REPLACE

A constant which can be used with the mode property of a PiiEntityMasking.

exclude

Gets the exclude of this PiiEntityMasking.

mode

[Required] Gets the mode of this PiiEntityMasking.

should_detect

Gets the should_detect of this PiiEntityMasking.

Methods:

__init__(**kwargs)

Initializes a new PiiEntityMasking object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODE_MASK = 'MASK'

A constant which can be used with the mode property of a PiiEntityMasking. This constant has a value of “MASK”

MODE_RELEXIFY = 'RELEXIFY'

A constant which can be used with the mode property of a PiiEntityMasking. This constant has a value of “RELEXIFY”

MODE_REMOVE = 'REMOVE'

A constant which can be used with the mode property of a PiiEntityMasking. This constant has a value of “REMOVE”

MODE_REPLACE = 'REPLACE'

A constant which can be used with the mode property of a PiiEntityMasking. This constant has a value of “REPLACE”

__init__(**kwargs)

Initializes a new PiiEntityMasking object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • mode (str) – The value to assign to the mode property of this PiiEntityMasking. Allowed values for this property are: “REPLACE”, “MASK”, “REMOVE”, “RELEXIFY”

  • exclude (list[str]) – The value to assign to the exclude property of this PiiEntityMasking.

  • should_detect (bool) – The value to assign to the should_detect property of this PiiEntityMasking.

property exclude

Gets the exclude of this PiiEntityMasking. List of offsets/entities to be removed from anonymization.

Returns

The exclude of this PiiEntityMasking.

Return type

list[str]

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property mode

[Required] Gets the mode of this PiiEntityMasking. The type of masking mode.

Allowed values for this property are: “REPLACE”, “MASK”, “REMOVE”, “RELEXIFY”

Returns

The mode of this PiiEntityMasking.

Return type

str

property should_detect

Gets the should_detect of this PiiEntityMasking. To include excluded entities from masking in detected entities or not.

Returns

The should_detect of this PiiEntityMasking.

Return type

bool