PIIDetection ¶

class PIIDetection(TypedDict, closed=True):
    name: "capo_glue.types.node_name.NodeName"
    """<p>The name of the transform node.</p>"""
    inputs: "capo_glue.types.one_input.OneInput"
    """<p>The node ID inputs to the transform.</p>"""
    pii_type: "capo_glue.types.pii_type.PiiType"
    """<p>Indicates the type of PIIDetection transform. </p>"""
    entity_types_to_detect: (
        "capo_glue.types.enclosed_in_string_properties.EnclosedInStringProperties"
    )
    """<p>Indicates the types of entities the PIIDetection transform will identify as PII data. </p> <p> PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE </p>"""
    output_column_name: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Indicates the output column name that will contain any entity type detected in that row. </p>"""
    sample_fraction: NotRequired[
        "capo_glue.types.boxed_double_fraction.BoxedDoubleFraction"
    ]
    """<p>Indicates the fraction of the data to sample when scanning for PII entities. </p>"""
    threshold_fraction: NotRequired[
        "capo_glue.types.boxed_double_fraction.BoxedDoubleFraction"
    ]
    """<p>Indicates the fraction of the data that must be met in order for a column to be identified as PII data. </p>"""
    mask_value: NotRequired["capo_glue.types.mask_value.MaskValue"]
    """<p>Indicates the value that will replace the detected entity. </p>"""
    redact_text: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Specifies whether to redact the detected PII text. When set to <code>true</code>, PII content is replaced with redaction characters.</p>"""
    redact_char: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The character used to replace detected PII content when redaction is enabled. The default redaction character is <code>*</code>.</p>"""
    match_pattern: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.</p>"""
    num_left_chars_to_exclude: NotRequired[
        "capo_glue.types.boxed_positive_int.BoxedPositiveInt"
    ]
    """<p>The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.</p>"""
    num_right_chars_to_exclude: NotRequired[
        "capo_glue.types.boxed_positive_int.BoxedPositiveInt"
    ]
    """<p>The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.</p>"""
    detection_parameters: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Additional parameters for configuring PII detection behavior and sensitivity settings.</p>"""
    detection_sensitivity: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.</p>"""