comprehend_detect_pii_entities: Inspects the input text for entities that contain personally...

Description Usage Arguments Value Request syntax

View source: R/comprehend_operations.R

Description

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

Usage

1
comprehend_detect_pii_entities(Text, LanguageCode)

Arguments

Text

[required] A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

LanguageCode

[required] The language of the input documents.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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",
      BeginOffset = 123,
      EndOffset = 123
    )
  )
)

Request syntax

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

paws.machine.learning documentation built on Aug. 23, 2021, 9:14 a.m.