ConfidenceScoreThresholdOverride Class

Confidence score threshold override for a specific PII category.

Constructor

ConfidenceScoreThresholdOverride(*args: Any, **kwargs: Any)

Variables

Name	Description
entity	str or PiiCategoriesExclude The PII category for which to override the confidence score threshold. Required. Known values are: "ABARoutingNumber", "ARNationalIdentityNumber", "AUBankAccountNumber", "AUDriversLicenseNumber", "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", "AUBusinessNumber", "AUCompanyNumber", "ATIdentityCard", "ATTaxIdentificationNumber", "ATValueAddedTaxNumber", "AzureDocumentDBAuthKey", "AzureIAASDatabaseConnectionAndSQLString", "AzureIoTConnectionString", "AzurePublishSettingPassword", "AzureRedisCacheString", "AzureSAS", "AzureServiceBusString", "AzureStorageAccountKey", "AzureStorageAccountGeneric", "BENationalNumber", "BENationalNumberV2", "BEValueAddedTaxNumber", "BRCPFNumber", "BRLegalEntityNumber", "BRNationalIDRG", "BGUniformCivilNumber", "CABankAccountNumber", "CADriversLicenseNumber", "CAHealthServiceNumber", "CAPassportNumber", "CAPersonalHealthIdentification", "CASocialInsuranceNumber", "CLIdentityCardNumber", "CNResidentIdentityCardNumber", "CreditCardNumber", "HRIdentityCardNumber", "HRNationalIDNumber", "HRPersonalIdentificationNumber", "HRPersonalIdentificationOIBNumberV2", "CYIdentityCard", "CYTaxIdentificationNumber", "CZPersonalIdentityNumber", "CZPersonalIdentityV2", "DKPersonalIdentificationNumber", "DKPersonalIdentificationV2", "DrugEnforcementAgencyNumber", "EEPersonalIdentificationCode", "EUDebitCardNumber", "EUDriversLicenseNumber", "EUGPSCoordinates", "EUNationalIdentificationNumber", "EUPassportNumber", "EUSocialSecurityNumber", "EUTaxIdentificationNumber", "FIEuropeanHealthNumber", "FINationalID", "FINationalIDV2", "FIPassportNumber", "FRDriversLicenseNumber", "FRHealthInsuranceNumber", "FRNationalID", "FRPassportNumber", "FRSocialSecurityNumber", "FRTaxIdentificationNumber", "FRValueAddedTaxNumber", "DEDriversLicenseNumber", "DEPassportNumber", "DEIdentityCardNumber", "DETaxIdentificationNumber", "DEValueAddedNumber", "GRNationalIDCard", "GRNationalIDV2", "GRTaxIdentificationNumber", "HKIdentityCardNumber", "HUValueAddedNumber", "HUPersonalIdentificationNumber", "HUTaxIdentificationNumber", "INPermanentAccount", "INUniqueIdentificationNumber", "IDIdentityCardNumber", "InternationalBankingAccountNumber", "IEPersonalPublicServiceNumber", "IEPersonalPublicServiceNumberV2", "ILBankAccountNumber", "ILNationalID", "ITDriversLicenseNumber", "ITFiscalCode", "ITValueAddedTaxNumber", "JPBankAccountNumber", "JPDriversLicenseNumber", "JPPassportNumber", "JPResidentRegistrationNumber", "JPSocialInsuranceNumber", "JPMyNumberCorporate", "JPMyNumberPersonal", "JPResidenceCardNumber", "LVPersonalCode", "LTPersonalCode", "LUNationalIdentificationNumberNatural", "LUNationalIdentificationNumberNonNatural", "MYIdentityCardNumber", "MTIdentityCardNumber", "MTTaxIDNumber", "NLCitizensServiceNumber", "NLCitizensServiceNumberV2", "NLTaxIdentificationNumber", "NLValueAddedTaxNumber", "NZBankAccountNumber", "NZDriversLicenseNumber", "NZInlandRevenueNumber", "NZMinistryOfHealthNumber", "NZSocialWelfareNumber", "NOIdentityNumber", "PHUnifiedMultiPurposeIDNumber", "PLIdentityCard", "PLNationalID", "PLNationalIDV2", "PLPassportNumber", "PLTaxIdentificationNumber", "PLREGONNumber", "PTCitizenCardNumber", "PTCitizenCardNumberV2", "PTTaxIdentificationNumber", "ROPersonalNumericalCode", "RUPassportNumberDomestic", "RUPassportNumberInternational", "SANationalID", "SGNationalRegistrationIdentityCardNumber", "SKPersonalNumber", "SITaxIdentificationNumber", "SIUniqueMasterCitizenNumber", "ZAIdentificationNumber", "KRResidentRegistrationNumber", "ESDNI", "ESSocialSecurityNumber", "ESTaxIdentificationNumber", "SQLServerConnectionString", "SENationalID", "SENationalIDV2", "SEPassportNumber", "SETaxIdentificationNumber", "SWIFTCode", "CHSocialSecurityNumber", "TWNationalID", "TWPassportNumber", "TWResidentCertificate", "THPopulationIdentificationCode", "TRNationalIdentificationNumber", "UKDriversLicenseNumber", "UKElectoralRollNumber", "UKNationalHealthNumber", "UKNationalInsuranceNumber", "UKUniqueTaxpayerNumber", "USUKPassportNumber", "USBankAccountNumber", "USDriversLicenseNumber", "USIndividualTaxpayerIdentification", "USSocialSecurityNumber", "UAPassportNumberDomestic", "UAPassportNumberInternational", "Organization", "Email", "URL", "Age", "PhoneNumber", "IPAddress", "Date", "Person", "Address", "DateOfBirth", "BankAccountNumber", "PassportNumber", "DriversLicenseNumber", "Neighborhood", "SortCode", "PIN", "VIN", "VehicleIdentificationNumber", "LicensePlate", "KRPassportNumber", "KRDriversLicenseNumber", "KRSocialSecurityNumber", "GovernmentIssuedId", "Password", "NationalId", "ZipCode", "CVV", "ExpirationDate", "CASocialIdentificationNumber", "USMedicareBeneficiaryId", "Location", "City", "State", "Airport", and "GPE".
value	float The confidence score threshold for the specified PII category. Required.
language	str The 2 letter ISO 639-1 language for which the override applies. If not specified, the override applies to all languages.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

entity

The PII category for which to override the confidence score threshold. Required. Known values are: "ABARoutingNumber", "ARNationalIdentityNumber", "AUBankAccountNumber", "AUDriversLicenseNumber", "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", "AUBusinessNumber", "AUCompanyNumber", "ATIdentityCard", "ATTaxIdentificationNumber", "ATValueAddedTaxNumber", "AzureDocumentDBAuthKey", "AzureIAASDatabaseConnectionAndSQLString", "AzureIoTConnectionString", "AzurePublishSettingPassword", "AzureRedisCacheString", "AzureSAS", "AzureServiceBusString", "AzureStorageAccountKey", "AzureStorageAccountGeneric", "BENationalNumber", "BENationalNumberV2", "BEValueAddedTaxNumber", "BRCPFNumber", "BRLegalEntityNumber", "BRNationalIDRG", "BGUniformCivilNumber", "CABankAccountNumber", "CADriversLicenseNumber", "CAHealthServiceNumber", "CAPassportNumber", "CAPersonalHealthIdentification", "CASocialInsuranceNumber", "CLIdentityCardNumber", "CNResidentIdentityCardNumber", "CreditCardNumber", "HRIdentityCardNumber", "HRNationalIDNumber", "HRPersonalIdentificationNumber", "HRPersonalIdentificationOIBNumberV2", "CYIdentityCard", "CYTaxIdentificationNumber", "CZPersonalIdentityNumber", "CZPersonalIdentityV2", "DKPersonalIdentificationNumber", "DKPersonalIdentificationV2", "DrugEnforcementAgencyNumber", "EEPersonalIdentificationCode", "EUDebitCardNumber", "EUDriversLicenseNumber", "EUGPSCoordinates", "EUNationalIdentificationNumber", "EUPassportNumber", "EUSocialSecurityNumber", "EUTaxIdentificationNumber", "FIEuropeanHealthNumber", "FINationalID", "FINationalIDV2", "FIPassportNumber", "FRDriversLicenseNumber", "FRHealthInsuranceNumber", "FRNationalID", "FRPassportNumber", "FRSocialSecurityNumber", "FRTaxIdentificationNumber", "FRValueAddedTaxNumber", "DEDriversLicenseNumber", "DEPassportNumber", "DEIdentityCardNumber", "DETaxIdentificationNumber", "DEValueAddedNumber", "GRNationalIDCard", "GRNationalIDV2", "GRTaxIdentificationNumber", "HKIdentityCardNumber", "HUValueAddedNumber", "HUPersonalIdentificationNumber", "HUTaxIdentificationNumber", "INPermanentAccount", "INUniqueIdentificationNumber", "IDIdentityCardNumber", "InternationalBankingAccountNumber", "IEPersonalPublicServiceNumber", "IEPersonalPublicServiceNumberV2", "ILBankAccountNumber", "ILNationalID", "ITDriversLicenseNumber", "ITFiscalCode", "ITValueAddedTaxNumber", "JPBankAccountNumber", "JPDriversLicenseNumber", "JPPassportNumber", "JPResidentRegistrationNumber", "JPSocialInsuranceNumber", "JPMyNumberCorporate", "JPMyNumberPersonal", "JPResidenceCardNumber", "LVPersonalCode", "LTPersonalCode", "LUNationalIdentificationNumberNatural", "LUNationalIdentificationNumberNonNatural", "MYIdentityCardNumber", "MTIdentityCardNumber", "MTTaxIDNumber", "NLCitizensServiceNumber", "NLCitizensServiceNumberV2", "NLTaxIdentificationNumber", "NLValueAddedTaxNumber", "NZBankAccountNumber", "NZDriversLicenseNumber", "NZInlandRevenueNumber", "NZMinistryOfHealthNumber", "NZSocialWelfareNumber", "NOIdentityNumber", "PHUnifiedMultiPurposeIDNumber", "PLIdentityCard", "PLNationalID", "PLNationalIDV2", "PLPassportNumber", "PLTaxIdentificationNumber", "PLREGONNumber", "PTCitizenCardNumber", "PTCitizenCardNumberV2", "PTTaxIdentificationNumber", "ROPersonalNumericalCode", "RUPassportNumberDomestic", "RUPassportNumberInternational", "SANationalID", "SGNationalRegistrationIdentityCardNumber", "SKPersonalNumber", "SITaxIdentificationNumber", "SIUniqueMasterCitizenNumber", "ZAIdentificationNumber", "KRResidentRegistrationNumber", "ESDNI", "ESSocialSecurityNumber", "ESTaxIdentificationNumber", "SQLServerConnectionString", "SENationalID", "SENationalIDV2", "SEPassportNumber", "SETaxIdentificationNumber", "SWIFTCode", "CHSocialSecurityNumber", "TWNationalID", "TWPassportNumber", "TWResidentCertificate", "THPopulationIdentificationCode", "TRNationalIdentificationNumber", "UKDriversLicenseNumber", "UKElectoralRollNumber", "UKNationalHealthNumber", "UKNationalInsuranceNumber", "UKUniqueTaxpayerNumber", "USUKPassportNumber", "USBankAccountNumber", "USDriversLicenseNumber", "USIndividualTaxpayerIdentification", "USSocialSecurityNumber", "UAPassportNumberDomestic", "UAPassportNumberInternational", "Organization", "Email", "URL", "Age", "PhoneNumber", "IPAddress", "Date", "Person", "Address", "DateOfBirth", "BankAccountNumber", "PassportNumber", "DriversLicenseNumber", "Neighborhood", "SortCode", "PIN", "VIN", "VehicleIdentificationNumber", "LicensePlate", "KRPassportNumber", "KRDriversLicenseNumber", "KRSocialSecurityNumber", "GovernmentIssuedId", "Password", "NationalId", "ZipCode", "CVV", "ExpirationDate", "CASocialIdentificationNumber", "USMedicareBeneficiaryId", "Location", "City", "State", "Airport", and "GPE".

entity: str | _models.PiiCategoriesExclude

language

The 2 letter ISO 639-1 language for which the override applies. If not specified, the override applies to all languages.

language: str | None

value

The confidence score threshold for the specified PII category. Required.

value: float