You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::PiiEntity

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about a PII entity.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offset ⇒ Integer

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

  • (Integer) —

    A character offset in the input text that shows where the PII entity begins (the first character is at position 0).

#end_offset ⇒ Integer

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

  • (Integer) —

    A character offset in the input text that shows where the PII entity ends.

#score ⇒ Float

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

  • (Float) —

    The level of confidence that Amazon Comprehend has in the accuracy of the detection.

#type ⇒ String

The entity\'s type.

Possible values:

  • 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

Returns:

  • (String) —

    The entity\'s type.