PiiEntity¶

class oci.ai_language.models.PiiEntity(**kwargs)¶

Bases: object

PII entity object.

Methods

__init__(**kwargs) Initializes a new PiiEntity object with values from keyword arguments.

Attributes

`id`	Gets the id of this PiiEntity.
`length`	[Required] Gets the length of this PiiEntity.
`offset`	[Required] Gets the offset of this PiiEntity.
`score`	[Required] Gets the score of this PiiEntity.
`text`	[Required] Gets the text of this PiiEntity.
`type`	[Required] Gets the type of this PiiEntity.

__init__(**kwargs)¶

Initializes a new PiiEntity object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this PiiEntity.
offset (int) – The value to assign to the offset property of this PiiEntity.
length (int) – The value to assign to the length property of this PiiEntity.
text (str) – The value to assign to the text property of this PiiEntity.
type (str) – The value to assign to the type property of this PiiEntity.
score (float) – The value to assign to the score property of this PiiEntity.

id¶

Gets the id of this PiiEntity. Unique id of the entity.

Returns:	The id of this PiiEntity.
Return type:	str

length¶

[Required] Gets the length of this PiiEntity. Length of PII entity text.

Returns:	The length of this PiiEntity.
Return type:	int

offset¶

[Required] Gets the offset of this PiiEntity. The number of Unicode code points preceding this entity in the submitted text.

Returns:	The offset of this PiiEntity.
Return type:	int

score¶

[Required] Gets the score of this PiiEntity. Score or confidence for detected PII entity.

Returns:	The score of this PiiEntity.
Return type:	float

text¶

[Required] Gets the text of this PiiEntity. Entity text like name of person, Organization and so on.

Returns:	The text of this PiiEntity.
Return type:	str

type¶

[Required] Gets the type of this PiiEntity. Entity type supported PERSON ADDRESS AGE DATE_TIME SSN_OR_TAXPAYER EMAIL PASSPORT_NUMBER_US TELEPHONE_NUMBER DRIVER_ID_US BANK_ACCOUNT_NUMBER BANK_SWIFT BANK_ROUTING CREDIT_DEBIT_NUMBER IP_ADDRESS MAC_ADDRESS COOKIE XSRF_TOKEN AUTH_BASIC AUTH_BEARER JSON_WEB_TOKEN PRIVATE_KEY PUBLIC_KEY OCI_OCID_USER OCI_OCID_TENANCY OCI_SMTP_USERNAME OCI_OCID_REFERENCE OCI_FINGERPRINT OCI_CREDENTIAL OCI_PRE_AUTH_REQUEST OCI_STORAGE_SIGNED_URL OCI_CUSTOMER_SECRET_KEY OCI_ACCESS_KEy MEDICAL_RECORD_NUMBER HEALTH_PLAN_ID URL CERTIFICATE_NUMBER FIN GUIDs VEHICLE_LICENSE_PLATE_US VEHICLE_IDENTIFIER_US

Returns:	The type of this PiiEntity.
Return type:	str