AWSComprehendPiiEntity

Objective-C

@interface AWSComprehendPiiEntity

Swift

class AWSComprehendPiiEntity

Provides information about a PII entity.

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable beginOffset;

    Swift

    var beginOffset: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable endOffset;

    Swift

    var endOffset: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable score;

    Swift

    var score: NSNumber? { get set }

  • The entity’s type.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendPiiEntityType types;

    Swift

    var types: AWSComprehendPiiEntityType { get set }