gen_ai_hub.orchestration.models.sap_data_privacy_integration
index
/home/jenkins/agent/workspace/ation_generative-ai-hub-sdk_main/gen_ai_hub/orchestration/models/sap_data_privacy_integration.py

 
Classes
       
builtins.str(builtins.object)
MaskingMethod(builtins.str, enum.Enum)
ProfileEntity(builtins.str, enum.Enum)
enum.Enum(builtins.object)
MaskingMethod(builtins.str, enum.Enum)
ProfileEntity(builtins.str, enum.Enum)
gen_ai_hub.orchestration.models.data_masking.DataMaskingProvider(gen_ai_hub.orchestration.models.base.JSONSerializable, abc.ABC)
SAPDataPrivacyIntegration

 
class MaskingMethod(builtins.str, enum.Enum)
    MaskingMethod(value, names=None, *, module=None, qualname=None, type=None, start=1)
 
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).
 
 
Method resolution order:
MaskingMethod
builtins.str
enum.Enum
builtins.object

Data and other attributes defined here:
ANONYMIZATION = <MaskingMethod.ANONYMIZATION: 'anonymization'>
PSEUDONYMIZATION = <MaskingMethod.PSEUDONYMIZATION: 'pseudonymization'>

Data descriptors inherited from enum.Enum:
name
The name of the Enum member.
value
The value of the Enum member.

Readonly properties inherited from enum.EnumMeta:
__members__
Returns a mapping of member name->value.
 
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.

 
class ProfileEntity(builtins.str, enum.Enum)
    ProfileEntity(value, names=None, *, module=None, qualname=None, type=None, start=1)
 
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.
 
 
Method resolution order:
ProfileEntity
builtins.str
enum.Enum
builtins.object

Data and other attributes defined here:
ADDRESS = <ProfileEntity.ADDRESS: 'profile-address'>
CREDIT_CARD_NUMBER = <ProfileEntity.CREDIT_CARD_NUMBER: 'profile-credit-card-number'>
DRIVING_LICENSE = <ProfileEntity.DRIVING_LICENSE: 'profile-driverlicense'>
EMAIL = <ProfileEntity.EMAIL: 'profile-email'>
GENDER = <ProfileEntity.GENDER: 'profile-gender'>
IBAN = <ProfileEntity.IBAN: 'profile-iban'>
LOCATION = <ProfileEntity.LOCATION: 'profile-location'>
NATIONALITY = <ProfileEntity.NATIONALITY: 'profile-nationality'>
NATIONAL_ID = <ProfileEntity.NATIONAL_ID: 'profile-nationalid'>
ORG = <ProfileEntity.ORG: 'profile-org'>
PASSPORT = <ProfileEntity.PASSPORT: 'profile-passport'>
PERSON = <ProfileEntity.PERSON: 'profile-person'>
PHONE = <ProfileEntity.PHONE: 'profile-phone'>
POLITICAL_GROUP = <ProfileEntity.POLITICAL_GROUP: 'profile-political-group'>
PRONOUNS_GENDER = <ProfileEntity.PRONOUNS_GENDER: 'profile-pronouns-gender'>
RELIGIOUS_GROUP = <ProfileEntity.RELIGIOUS_GROUP: 'profile-religious-group'>
SAP_IDS_INTERNAL = <ProfileEntity.SAP_IDS_INTERNAL: 'profile-sapids-internal'>
SAP_IDS_PUBLIC = <ProfileEntity.SAP_IDS_PUBLIC: 'profile-sapids-public'>
SENSITIVE_DATA = <ProfileEntity.SENSITIVE_DATA: 'profile-sensitive-data'>
SEXUAL_ORIENTATION = <ProfileEntity.SEXUAL_ORIENTATION: 'profile-sexual-orientation'>
SSN = <ProfileEntity.SSN: 'profile-ssn'>
TRADE_UNION = <ProfileEntity.TRADE_UNION: 'profile-trade-union'>
UNIVERSITY = <ProfileEntity.UNIVERSITY: 'profile-university'>
URL = <ProfileEntity.URL: 'profile-url'>
USERNAME_PASSWORD = <ProfileEntity.USERNAME_PASSWORD: 'profile-username-password'>

Data descriptors inherited from enum.Enum:
name
The name of the Enum member.
value
The value of the Enum member.

Readonly properties inherited from enum.EnumMeta:
__members__
Returns a mapping of member name->value.
 
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.

 
class SAPDataPrivacyIntegration(gen_ai_hub.orchestration.models.data_masking.DataMaskingProvider)
    SAPDataPrivacyIntegration(method: gen_ai_hub.orchestration.models.sap_data_privacy_integration.MaskingMethod, entities: List[gen_ai_hub.orchestration.models.sap_data_privacy_integration.ProfileEntity], allowlist: List[str] = None, mask_grounding_input: bool = False)
 
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.
 
Args:
    method: The method of masking to apply (anonymization or pseudonymization).
    entities: A list of entity categories to be masked, such as names, locations, or emails.
    allowlist: A list of strings that should not be masked.
    mask_grounding_input: A flag indicating whether to mask input to the grounding module.
 
 
Method resolution order:
SAPDataPrivacyIntegration
gen_ai_hub.orchestration.models.data_masking.DataMaskingProvider
gen_ai_hub.orchestration.models.base.JSONSerializable
abc.ABC
builtins.object

Methods defined here:
__init__(self, method: gen_ai_hub.orchestration.models.sap_data_privacy_integration.MaskingMethod, entities: List[gen_ai_hub.orchestration.models.sap_data_privacy_integration.ProfileEntity], allowlist: List[str] = None, mask_grounding_input: bool = False)
Initialize self.  See help(type(self)) for accurate signature.
to_dict(self)
Convert the object to a JSON-serializable dictionary.

Data and other attributes defined here:
__abstractmethods__ = frozenset()
__annotations__ = {}

Data descriptors inherited from gen_ai_hub.orchestration.models.base.JSONSerializable:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        List = typing.List