View a markdown version of this page

GuardrailChecksSensitiveInformationResultEntry - Amazon Bedrock

GuardrailChecksSensitiveInformationResultEntry

The detection result for a single sensitive information entity found in the evaluated messages.

Contents

beginOffset

The start character offset of the detected entity within the content block.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

confidenceScore

The confidence score for the detection, ranging from 0.0 to 1.0. Higher values indicate greater confidence.

Type: Double

Valid Range: Minimum value of 0.0. Maximum value of 1.0.

Required: Yes

contentIndex

The zero-based index of the content block within the message where the entity was detected.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

endOffset

The end character offset of the detected entity within the content block.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

messageIndex

The zero-based index of the message in the input messages array where the entity was detected.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

type

The PII entity type that was detected.

Type: String

Valid Values: ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: