Class GuardrailPiiEntityConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailPiiEntityConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GuardrailPiiEntityConfig.Builder,GuardrailPiiEntityConfig>

@Generated("software.amazon.awssdk:codegen")
public final class GuardrailPiiEntityConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailPiiEntityConfig.Builder,GuardrailPiiEntityConfig>

The PII entity to configure for the guardrail.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailPiiEntityConfig.Builder

Method Summary

Modifier and Type	Method	Description
final GuardrailSensitiveInformationAction	action()	Configure guardrail action when the PII entity is detected.
final String	actionAsString()	Configure guardrail action when the PII entity is detected.
static GuardrailPiiEntityConfig.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final GuardrailSensitiveInformationAction	inputAction()	Specifies the action to take when harmful content is detected in the input.
final String	inputActionAsString()	Specifies the action to take when harmful content is detected in the input.
final Boolean	inputEnabled()	Specifies whether to enable guardrail evaluation on the input.
final GuardrailSensitiveInformationAction	outputAction()	Specifies the action to take when harmful content is detected in the output.
final String	outputActionAsString()	Specifies the action to take when harmful content is detected in the output.
final Boolean	outputEnabled()	Specifies whether to enable guardrail evaluation on the output.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailPiiEntityConfig.Builder>	serializableBuilderClass()
GuardrailPiiEntityConfig.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final GuardrailPiiEntityType	type()	Configure guardrail type when the PII entity is detected.
final String	typeAsString()	Configure guardrail type when the PII entity is detected.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

type

public final GuardrailPiiEntityType type()

Configure guardrail type when the PII entity is detected.

The following PIIs are used to block or mask sensitive information:

• General

  • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

  • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age.

  • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

  • EMAIL

    An email address, such as marymajor@email.com.

  • PHONE

    A phone number. This entity type also includes fax and pager numbers.

  • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

  • PASSWORD

    An alphanumeric string that is used as a password, such as "*very20special#pass*".

  • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

  • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

  • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

• Finance

  • CREDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

  • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.

  • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

  • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

  • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.

  • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

• IT

  • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0.

  • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

  • URL

    A web address, such as www.example.com.

  • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

  • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

• USA specific

  • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

  • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

  • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

  • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

  • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

• Canada specific

  • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

  • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.

• UK Specific

  • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

  • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

  • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

• Custom

  • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

If the service returns an enum value that is not available in the current SDK version, type will return GuardrailPiiEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Configure guardrail type when the PII entity is detected.

The following PIIs are used to block or mask sensitive information:

• General

  • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

  • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age.

  • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

  • EMAIL

    An email address, such as marymajor@email.com.

  • PHONE

    A phone number. This entity type also includes fax and pager numbers.

  • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

  • PASSWORD

    An alphanumeric string that is used as a password, such as "*very20special#pass*".

  • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

  • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

  • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

• Finance

  • CREDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

  • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.

  • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

  • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

  • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.

  • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

• IT

  • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0.

  • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

  • URL

    A web address, such as www.example.com.

  • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

  • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

• USA specific

  • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

  • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

  • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

  • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

  • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

• Canada specific

  • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

  • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.

• UK Specific

  • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

  • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

  • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

• Custom

  • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

See Also:

• GuardrailPiiEntityType

typeAsString

public final String typeAsString()

Configure guardrail type when the PII entity is detected.

The following PIIs are used to block or mask sensitive information:

• General

  • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

  • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age.

  • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

  • EMAIL

    An email address, such as marymajor@email.com.

  • PHONE

    A phone number. This entity type also includes fax and pager numbers.

  • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

  • PASSWORD

    An alphanumeric string that is used as a password, such as "*very20special#pass*".

  • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

  • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

  • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

• Finance

  • CREDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

  • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.

  • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

  • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

  • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.

  • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

• IT

  • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0.

  • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

  • URL

    A web address, such as www.example.com.

  • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

  • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

• USA specific

  • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

  • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

  • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

  • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

  • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

• Canada specific

  • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

  • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.

• UK Specific

  • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

  • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

  • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

• Custom

  • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

If the service returns an enum value that is not available in the current SDK version, type will return GuardrailPiiEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Configure guardrail type when the PII entity is detected.

The following PIIs are used to block or mask sensitive information:

• General

  • ADDRESS

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

  • AGE

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age.

  • NAME

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.

  • EMAIL

    An email address, such as marymajor@email.com.

  • PHONE

    A phone number. This entity type also includes fax and pager numbers.

  • USERNAME

    A user name that identifies an account, such as a login name, screen name, nick name, or handle.

  • PASSWORD

    An alphanumeric string that is used as a password, such as "*very20special#pass*".

  • DRIVER_ID

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.

  • LICENSE_PLATE

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

  • VEHICLE_IDENTIFICATION_NUMBER

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

• Finance

  • CREDIT_DEBIT_CARD_CVV

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

  • CREDIT_DEBIT_CARD_EXPIRY

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.

  • CREDIT_DEBIT_CARD_NUMBER

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

  • PIN

    A four-digit personal identification number (PIN) with which you can access your bank account.

  • INTERNATIONAL_BANK_ACCOUNT_NUMBER

    An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.

  • SWIFT_CODE

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.

• IT

  • IP_ADDRESS

    An IPv4 address, such as 198.51.100.0.

  • MAC_ADDRESS

    A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

  • URL

    A web address, such as www.example.com.

  • AWS_ACCESS_KEY

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

  • AWS_SECRET_KEY

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.

• USA specific

  • US_BANK_ACCOUNT_NUMBER

    A US bank account number, which is typically 10 to 12 digits long.

  • US_BANK_ROUTING_NUMBER

    A US bank account routing number. These are typically nine digits long,

  • US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

  • US_PASSPORT_NUMBER

    A US passport number. Passport numbers range from six to nine alphanumeric characters.

  • US_SOCIAL_SECURITY_NUMBER

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

• Canada specific

  • CA_HEALTH_NUMBER

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

  • CA_SOCIAL_INSURANCE_NUMBER

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.

• UK Specific

  • UK_NATIONAL_HEALTH_SERVICE_NUMBER

    A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

  • UK_NATIONAL_INSURANCE_NUMBER

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

  • UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

• Custom

  • Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..

See Also:

• GuardrailPiiEntityType

action

public final GuardrailSensitiveInformationAction action()

Configure guardrail action when the PII entity is detected.

If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Configure guardrail action when the PII entity is detected.

See Also:

• GuardrailSensitiveInformationAction

actionAsString

public final String actionAsString()

Configure guardrail action when the PII entity is detected.

If the service returns an enum value that is not available in the current SDK version, action will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Configure guardrail action when the PII entity is detected.

See Also:

• GuardrailSensitiveInformationAction

inputAction

public final GuardrailSensitiveInformationAction inputAction()

Specifies the action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().

Returns:

Specifies the action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

See Also:

• GuardrailSensitiveInformationAction

inputActionAsString

public final String inputActionAsString()

Specifies the action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().

Returns:

Specifies the action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

See Also:

• GuardrailSensitiveInformationAction

outputAction

public final GuardrailSensitiveInformationAction outputAction()

Specifies the action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().

Returns:

Specifies the action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

See Also:

• GuardrailSensitiveInformationAction

outputActionAsString

public final String outputActionAsString()

Specifies the action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailSensitiveInformationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().

Returns:

Specifies the action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• ANONYMIZE – Mask the content and replace it with identifier tags.

• NONE – Take no action but return detection information in the trace response.

See Also:

• GuardrailSensitiveInformationAction

inputEnabled

public final Boolean inputEnabled()

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

outputEnabled

public final Boolean outputEnabled()

Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

toBuilder

public GuardrailPiiEntityConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailPiiEntityConfig.Builder,GuardrailPiiEntityConfig>

Returns:

a builder for type T

builder

public static GuardrailPiiEntityConfig.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailPiiEntityConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.