gen_ai_hub.orchestration.models.sap_data_privacy_integration module

class gen_ai_hub.orchestration.models.sap_data_privacy_integration.MaskingMethod(*values)

Bases: str, Enum

Enumerates the supported masking methods.

This enum defines the two main methods for masking sensitive information: anonymization and pseudonymization. Anonymization irreversibly removes sensitive data, while pseudonymization allows the original data to be recovered.

Values:

ANONYMIZATION: Irreversibly replaces sensitive data with placeholders (e.g., MASKED_ENTITY).

PSEUDONYMIZATION: Replaces sensitive data with reversible placeholders (e.g., MASKED_ENTITY_ID).

ANONYMIZATION = 'anonymization'

Irreversibly replaces sensitive data with placeholders (e.g., MASKED_ENTITY).

PSEUDONYMIZATION = 'pseudonymization'

Replaces sensitive data with reversible placeholders (e.g., MASKED_ENTITY_ID).

class gen_ai_hub.orchestration.models.sap_data_privacy_integration.ProfileEntity(*values)

Bases: str, Enum

Enumerates the entity categories that can be masked by the SAP Data Privacy Integration service.

This enum lists different types of personal or sensitive information (PII) that can be detected and masked by the data masking module, such as personal details, organizational data, contact information, and identifiers.

Values:

PERSON: Represents personal names.

ORG: Represents organizational names.

UNIVERSITY: Represents educational institutions.

LOCATION: Represents geographical locations.

EMAIL: Represents email addresses.

PHONE: Represents phone numbers.

ADDRESS: Represents physical addresses.

SAP_IDS_INTERNAL: Represents internal SAP identifiers.

SAP_IDS_PUBLIC: Represents public SAP identifiers.

URL: Represents URLs.

USERNAME_PASSWORD: Represents usernames and passwords.

NATIONAL_ID: Represents national identification numbers.

IBAN: Represents International Bank Account Numbers.

SSN: Represents Social Security Numbers.

CREDIT_CARD_NUMBER: Represents credit card numbers.

PASSPORT: Represents passport numbers.

DRIVING_LICENSE: Represents driving license numbers.

NATIONALITY: Represents nationality information.

RELIGIOUS_GROUP: Represents religious group affiliation.

POLITICAL_GROUP: Represents political group affiliation.

PRONOUNS_GENDER: Represents pronouns and gender identity.

GENDER: Represents gender information.

SEXUAL_ORIENTATION: Represents sexual orientation.

TRADE_UNION: Represents trade union membership.

SENSITIVE_DATA: Represents any other sensitive information.

PERSON = 'profile-person'

Represents personal names.

ORG = 'profile-org'

Represents organizational names.

UNIVERSITY = 'profile-university'

Represents educational institutions.

LOCATION = 'profile-location'

Represents geographical locations.

EMAIL = 'profile-email'

Represents email addresses.

PHONE = 'profile-phone'

Represents phone numbers.

ADDRESS = 'profile-address'

Represents physical addresses.

SAP_IDS_INTERNAL = 'profile-sapids-internal'

Represents internal SAP identifiers.

SAP_IDS_PUBLIC = 'profile-sapids-public'

Represents public SAP identifiers.

URL = 'profile-url'

Represents URLs.

USERNAME_PASSWORD = 'profile-username-password'

Represents usernames and passwords.

NATIONAL_ID = 'profile-nationalid'

Represents national identification numbers.

IBAN = 'profile-iban'

Represents International Bank Account Numbers.

SSN = 'profile-ssn'

Represents Social Security Numbers.

CREDIT_CARD_NUMBER = 'profile-credit-card-number'

Represents credit card numbers.

PASSPORT = 'profile-passport'

Represents passport numbers.

DRIVING_LICENSE = 'profile-driverlicense'

Represents driving license numbers.

NATIONALITY = 'profile-nationality'

Represents nationality information.

RELIGIOUS_GROUP = 'profile-religious-group'

Represents religious group affiliation.

POLITICAL_GROUP = 'profile-political-group'

Represents political group affiliation.

PRONOUNS_GENDER = 'profile-pronouns-gender'

Represents pronouns and gender identity.

GENDER = 'profile-gender'

Represents gender information.

SEXUAL_ORIENTATION = 'profile-sexual-orientation'

Represents sexual orientation.

TRADE_UNION = 'profile-trade-union'

Represents trade union membership.

SENSITIVE_DATA = 'profile-sensitive-data'

Represents any other sensitive information.

class gen_ai_hub.orchestration.models.sap_data_privacy_integration.SAPDataPrivacyIntegration(method: MaskingMethod, entities: List[ProfileEntity], allowlist: List[str] = None, mask_grounding_input: bool = False)

Bases: DataMaskingProvider

SAP Data Privacy Integration provider for data masking.

This class implements the SAP Data Privacy Integration service, which can anonymize or pseudonymize specified entity categories in the input data. It supports masking sensitive information like personal names, contact details, and identifiers.

__init__(method: MaskingMethod, entities: List[ProfileEntity], allowlist: List[str] = None, mask_grounding_input: bool = False)

Initializes the SAPDataPrivacyIntegration data masking provider.

Parameters:

• method (MaskingMethod) – The method of masking to apply

• entities (List[ProfileEntity]) – A list of entity categories to be masked

• allowlist (List[str], optional) – A list of strings that should not be masked, defaults to None

• mask_grounding_input (bool, optional) – A flag indicating whether to mask input to the grounding module, defaults to False

to_dict()

Converts the SAPDataPrivacyIntegration instance to a dictionary representation.

Returns:

Dictionary representation of the SAPDataPrivacyIntegration instance.

Return type:

dict