Module Values_0.PIIDetectionSource

Specifies a transform that identifies, removes or masks PII data.

Sourcetype nonrec t = {
  1. name : NodeName.t;
    (*

    The name of the transform node.

    *)
  2. inputs : OneInput.t;
    (*

    The node ID inputs to the transform.

    *)
  3. piiType : PiiType.t;
    (*

    Indicates the type of PIIDetection transform.

    *)
  4. entityTypesToDetect : EnclosedInStringProperties.t;
    (*

    Indicates the types of entities the PIIDetection transform will identify as PII data. 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

    *)
  5. outputColumnName : EnclosedInStringProperty.t option;
    (*

    Indicates the output column name that will contain any entity type detected in that row.

    *)
  6. sampleFraction : BoxedDoubleFraction.t option;
    (*

    Indicates the fraction of the data to sample when scanning for PII entities.

    *)
  7. thresholdFraction : BoxedDoubleFraction.t option;
    (*

    Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

    *)
  8. maskValue : MaskValue.t option;
    (*

    Indicates the value that will replace the detected entity.

    *)
  9. redactText : EnclosedInStringProperty.t option;
    (*

    Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

    *)
  10. redactChar : EnclosedInStringProperty.t option;
    (*

    The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

    *)
  11. matchPattern : EnclosedInStringProperty.t option;
    (*

    A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

    *)
  12. numLeftCharsToExclude : BoxedPositiveInt.t option;
    (*

    The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

    *)
  13. numRightCharsToExclude : BoxedPositiveInt.t option;
    (*

    The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

    *)
  14. detectionParameters : EnclosedInStringProperty.t option;
    (*

    Additional parameters for configuring PII detection behavior and sensitivity settings.

    *)
  15. detectionSensitivity : EnclosedInStringProperty.t option;
    (*

    The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

    *)
}
Sourceval context_ : string
Sourceval make : ?outputColumnName:??? -> ?sampleFraction:??? -> ?thresholdFraction:??? -> ?maskValue:??? -> ?redactText:??? -> ?redactChar:??? -> ?matchPattern:??? -> ?numLeftCharsToExclude:??? -> ?numRightCharsToExclude:??? -> ?detectionParameters:??? -> ?detectionSensitivity:??? -> name:NodeName.t -> inputs:OneInput.t -> piiType:PiiType.t -> entityTypesToDetect:EnclosedInStringProperties.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Double of BoxedDoubleFraction.t | `Enum of string | `Integer of BoxedPositiveInt.t | `List of [> `String of NodeId.t ] list | `String of NodeName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t