API de détection de données

Référence pour l’API de détection de données

DataPatternValidator : matchs(modèle de chaîne, entrée de chaîne)

Valide si l’entrée correspond au modèle regex (expression régulière).

Tableau 1. Paramètres

Nom	Type	Description
modèle	Chaîne	Le modèle regex
entrée	Chaîne	Données d’entrée à mettre en correspondance

Tableau 2. Renvoie

Type	Description
Booléen	Renvoie la valeur true si l’entrée correspond au modèle, sinon valeur false.

Exemple de code

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var input = '09/09/2023';
var output = datapatternValidatorApi.matches(pattern, input);
if (output) {
  gs.info('pattern found!');
} else {
  gs.info('pattern not found');
}

DataPatternValidator : isValid(modèle de chaîne)

Valide si le modèle donné est une expression régulière valide.

Tableau 3. Paramètres

Nom	Type	Description
modèle	Chaîne	Le modèle regex

Tableau 4. Renvoie

Type	Description
Booléen	Renvoie la valeur true si l’expression est une expression régulière valide, sinon false.

Exemple de code

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var output = datapatternValidatorApi.isValid(pattern);
if (output) {
 gs.info('pattern is valid!');
} else {
  gs.info('pattern is not valid');
}

DataPatternValidator – keywordMatches(String pattern, String input, String keywords, int keywordProximity)

Validez si les données d’entrée indiquées correspondent au modèle d’expression régulière (regex) ainsi qu’aux mots clés. Consultez Configurer Détection de données des modèles pour plus d’informations sur les mots clés et la proximité des mots clés.

Tableau 5. Paramètres

Nom	Type	Description
modèle	Chaîne	Le modèle regex
entrée	Chaîne	Données d’entrée à mettre en correspondance
Mots clés	Chaîne	Valeurs de mots clés séparées par des virgules à faire correspondre
mot-cléProximité	int	Proximité des mots clés du modèle correspondant

Tableau 6. Renvoie

Type	Description
Booléen	Renvoie la valeur true si l’expression est une expression régulière valide, sinon valeur false

Exemple de code

var datapatternValidatorApi = new sn_data_discovery_api.DataPatternValidator();
var pattern = '\\b[0-3]?[0-9]/[0-3]?[0-9]/(?:[0-9]{2})?[0-9]{2}\\b';
var keywords = 'dob,date of birth';
var keywordProximity = 20;
var matchInput = 'dob: 09/09/2023';
var noMatchInput = '09/09/2023';
var output = datapatternValidatorApi.keywordMatches(pattern, matchInput, keywords, keywordProximity);
gs.info('match found for input: ' + matchInput + ' = ' + output);
output = datapatternValidatorApi.keywordMatches(pattern, noMatchInput, keywords, keywordProximity);
gs.info('match found for noMatchInput: ' + noMatchInput + ' = ' + output);

DataPatternScanner : scan (entrée de chaîne)

Remarque :

Un tableau d’ID système de modèle de données doit être transmis au constructeur DataPatternScanner.

Tableau 7. Paramètres

Nom	Type	Description
entrée	Chaîne	Données d’entrée à analyser

Tableau 8. Renvoie

Type

Description

Chaîne

Chaîne JSON sérialisée hasMatches (en anglais seulement) Renvoyez la valeur vrai si au moins 1 correspondance de modèle est présente. « finding » : [ { # pour chaque modèle avec correspondance, contient la liste des positions de début et de fin des correspondances. erreur Contient un code d’erreur et un message en cas d’échec de l’API, sinon vide. unprocessedPatterns Renvoie un tableau des ID système de modèle de données qui n’ont pas été traités Trouver Renvoie l’ID de chaque modèle ainsi qu’une liste des positions de début et de fin des correspondances.

Exemple de code

var emailSysId = '8e5605bceb0561107977d256385228e6';
var ssnSysId = '4964417ceb0561107977d256385228b8';
var dataPatternSysIds = [emailSysId, ssnSysId] // Email and SSN
var dataDiscoveryApi = new sn_data_discovery_api.DataDiscoveryScanner(dataPatternSysIds);

var input = 'my ssn is 123-45-6789 and email is [e-mail]'
var jsonString = dataDiscoveryApi.scan(input);
var output = JSON.parse(jsonString);

if (output.hasMatches) {
   gs.info('found matches for patterns in input');
   for (var i=0; i<output.finding.length; i++) {
        curFinding = output.finding[i];
        gs.info('first match for ' + curFinding.pattern + ' is (' + curFinding.matches[0]['start'] + ',' + + curFinding.matches[0]['end'] + ')');
   }
}

Tableau 9. Configuration

Nom	Configuration Mode	Description
Longueur maximale de la chaîne de mots clés (csv).	Ne peut pas être configuré	Définit la longueur maximale de chaîne qui peut être configurée dans le champ DataPattern.keyword La valeur par défaut est 128 La valeur maximale est 128.
Valeur minimale et maximale pour la proximité des mots clés	Ne peut pas être configuré	Définit les valeurs minimale et maximale qui peuvent être saisies dans DataPattern.keyword_proximity champ. Minimum de 0 Maximum de 64
Taille maximale de l’entrée pour les correspondances et l’API keywordMatches	Ne peut pas être configuré	Définit la taille d’entrée maximale prise en charge par les API DataPatternValidator.matches et DataPatternValidator.keywordMatches La valeur par défaut est 2048 La valeur maximale est 2 048.
Délai d’expiration de l’API d’analyse	DataDiscoveryScanner.setScanTimeout(long timeoutMillis)	Appel d’API pour définir le temps maximal, en millisecondes, pour terminer les appels DataDiscoveryScanner.scan. La valeur par défaut est 20 000 (ms) La plage est une valeur entière comprise entre 0 et 50 000 (ms)