Show / Hide Table of Contents

Class PiiEntity

PII entity object.

Inheritance
object
PiiEntity
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AilanguageService.Models
Assembly: OCI.DotNetSDK.Ailanguage.dll
Syntax
public class PiiEntity

Properties

Id

Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Unique id of the entity.

Length

Declaration
[Required(ErrorMessage = "Length is required.")]
[JsonProperty(PropertyName = "length")]
public int? Length { get; set; }
Property Value
Type Description
int?

Length of PII entity text.

Remarks

Required

Offset

Declaration
[Required(ErrorMessage = "Offset is required.")]
[JsonProperty(PropertyName = "offset")]
public int? Offset { get; set; }
Property Value
Type Description
int?

The number of Unicode code points preceding this entity in the submitted text.

Remarks

Required

Score

Declaration
[Required(ErrorMessage = "Score is required.")]
[JsonProperty(PropertyName = "score")]
public double Score { get; set; }
Property Value
Type Description
double

Score or confidence for detected PII entity.

Remarks

Required

Text

Declaration
[Required(ErrorMessage = "Text is required.")]
[JsonProperty(PropertyName = "text")]
public string Text { get; set; }
Property Value
Type Description
string

Entity text like name of person, Organization and so on.

Remarks

Required

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type Description
string

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

Remarks

Required

In this article
Back to top