Class PiiEntity.Builder

  • Enclosing class:
    PiiEntity

    public static class PiiEntity.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • id

        public PiiEntity.Builder id​(String id)
        Unique id of the entity.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • offset

        public PiiEntity.Builder offset​(Integer offset)
        The number of Unicode code points preceding this entity in the submitted text.
        Parameters:
        offset - the value to set
        Returns:
        this builder
      • length

        public PiiEntity.Builder length​(Integer length)
        Length of PII entity text.
        Parameters:
        length - the value to set
        Returns:
        this builder
      • text

        public PiiEntity.Builder text​(String text)
        Entity text like name of person, Organization and so on.
        Parameters:
        text - the value to set
        Returns:
        this builder
      • type

        public PiiEntity.Builder type​(String type)
        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
        Parameters:
        type - the value to set
        Returns:
        this builder
      • score

        public PiiEntity.Builder score​(Double score)
        Score or confidence for detected PII entity.
        Parameters:
        score - the value to set
        Returns:
        this builder