Detect Pii Entities

comprehend_detect_pii_entities

R Documentation

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them

Description

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Usage

comprehend_detect_pii_entities(Text, LanguageCode)

Arguments

Text

[required] A UTF-8 text string. The maximum string size is 100 KB.

LanguageCode

[required] The language of the input text. Enter the language code for English (en) or Spanish (es).

Value

A list with the following syntax:

list(
  Entities = list(
    list(
      Score = 123.0,
      Type = "BANK_ACCOUNT_NUMBER"|"BANK_ROUTING"|"CREDIT_DEBIT_NUMBER"|"CREDIT_DEBIT_CVV"|"CREDIT_DEBIT_EXPIRY"|"PIN"|"EMAIL"|"ADDRESS"|"NAME"|"PHONE"|"SSN"|"DATE_TIME"|"PASSPORT_NUMBER"|"DRIVER_ID"|"URL"|"AGE"|"USERNAME"|"PASSWORD"|"AWS_ACCESS_KEY"|"AWS_SECRET_KEY"|"IP_ADDRESS"|"MAC_ADDRESS"|"ALL"|"LICENSE_PLATE"|"VEHICLE_IDENTIFICATION_NUMBER"|"UK_NATIONAL_INSURANCE_NUMBER"|"CA_SOCIAL_INSURANCE_NUMBER"|"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"|"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"|"IN_PERMANENT_ACCOUNT_NUMBER"|"IN_NREGA"|"INTERNATIONAL_BANK_ACCOUNT_NUMBER"|"SWIFT_CODE"|"UK_NATIONAL_HEALTH_SERVICE_NUMBER"|"CA_HEALTH_NUMBER"|"IN_AADHAAR"|"IN_VOTER_NUMBER",
      BeginOffset = 123,
      EndOffset = 123
    )
  )
)

Request syntax

svc$detect_pii_entities(
  Text = "string",
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW"
)