enterprise_ai.privacy
Source : sdks/python/src/enterprise_ai/privacy/__init__.py. Retour à l'index de la référence du SDK Python.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe PrivacyClient
/v1/privacy, /v1/retention, /v1/lineage.
Resource
PrivacyClient.classify
classify(text: str | None = None, media_id: str | None = None) -> Any
Classer un texte ou un média. Avec text, détecte les entités avec les règles du tenant et renvoie classification, findings et engine, sans modifier le texte. Avec media_id, renvoie la classification, les constats et le résultat DLP déjà calculés pour ce média (404 not_found pour un média inconnu). L'un des deux est obligatoire (400 invalid_request). Ouvert à tout membre du tenant.
Route : /v1/privacy/classify (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
text | str | None | None | non | Texte à classer. |
media_id | str | None | None | non | Identifiant d'un média téléversé dont la classification enregistrée est renvoyée. |
Retour : Any. Réponse JSON décodée de l'opération « Classer un texte ou un média ».
Erreurs levées : ValueError, les erreurs typées du transport (Erreurs).
PrivacyClient.classify_local
classify_local(text: str) -> dict[str, Any]
Estimation locale par la pré-analyse à expressions régulières (sans réseau).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
text | str | oui | Texte à classifier. |
Retour : dict[str, Any]. Dict {classification, findings} : le niveau de classify_text et les détections masquées de scan.
PrivacyClient.create_retention_policy
create_retention_policy(resource_type: str, ttl_days: int, **extra: Any) -> Any
Créer ou modifier une politique de conservation. Définit la politique de conservation d'un type de ressource, en remplaçant l'existante. Exige tenant_admin, security_officer ou data_steward. Un type de ressource inconnu ou une action autre que erase ou archive répond 400 invalid_request. La politique s'applique à la passe de conservation suivante. Écrit l'événement d'audit retention.policy.upsert. Répond 201 avec la politique.
Route : /v1/retention/policies (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
resource_type | str | oui | Type de ressource : memory, sessions, media, usage_raw, telemetry, documents ou realtime. | |
ttl_days | int | oui | Durée de vie en jours, de 0 à 36500. Les éléments plus anciens sont purgés par la passe suivante. | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Créer ou modifier une politique de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.detect
detect(text: str, **extra: Any) -> Any
Inspecter un texte à la recherche de données sensibles. Applique la DLP au texte avec les règles du tenant, en mode detect sauf si mode en décide autrement. La réponse donne text, findings (type, position, score, classification, court aperçu, action, règle), action (action la plus forte appliquée), classification, mode, engine (builtin ou presidio), blocked et count. Un mode inconnu répond 400. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.inspect (nombres et types uniquement).
Route : /v1/dlp/inspect (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
text | str | oui | Texte à inspecter ou à masquer. | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Inspecter un texte à la recherche de données sensibles ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.detokenize
detokenize(tokens: list[str], purpose: str, **extra: Any) -> Any
Détokeniser des valeurs. Renvoie les valeurs d'origine des jetons donnés dans tokens ou trouvés dans text.
Route : /v1/tokenization/detokenize (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
tokens | list[str] | oui | Jetons à résoudre, tok_<type>_<hex>. | |
purpose | str | oui | Raison pour laquelle les valeurs sont nécessaires, transmise à la politique dans context.purpose et inscrite dans le journal d'audit. | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Détokeniser des valeurs ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.encrypt
encrypt(plaintext: bytes | str, key: str, aad: str | None = None, **extra: Any) -> Any
Chiffrer des données avec une clé du tenant. Chiffre plaintext (texte UTF-8) ou plaintext_base64 (octets) avec la version courante de la clé, lié à aad. Renvoie ciphertext (eaienc1:...), key_id et key_version. L'une des deux entrées est obligatoire, et le base64 doit être valide (400 invalid_request) ; une clé inconnue répond 404 key_not_found. Ouvert à tout membre du tenant. Écrit l'événement d'audit encryption.encrypt (taille uniquement).
Route : /v1/encryption/encrypt (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
plaintext | bytes | str | oui | Texte UTF-8 à chiffrer. | |
key | str | oui | Clé à utiliser, par identifiant (UUID) ou par nom. | |
aad | str | None | None | non | Données associées liées au chiffré ; la même valeur est exigée pour déchiffrer (vide par défaut). |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Chiffrer des données avec une clé du tenant ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.erase_subject
erase_subject(subject_id: str, reason: str | None = None, dry_run: bool | None = None, include_documents: bool | None = None) -> Any
Effacer une personne concernée. Supprime les données détenues sur une personne, en une transaction. Exige tenant_admin, security_officer ou data_steward.
Route : /v1/retention/erase (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
subject_id | str | oui | Personne à effacer, telle que la plateforme la connaît (sujet utilisateur), 1 à 200 caractères. | |
reason | str | None | None | non | Base légale de l'effacement, inscrite dans le journal d'audit. gdpr_art_17 par défaut. |
dry_run | bool | None | None | non | Si vrai, compte ce qui serait effacé sans rien supprimer (faux par défaut). |
include_documents | bool | None | None | non | Si vrai, supprime aussi les documents des bases de connaissances créés par la personne et leurs vecteurs (faux par défaut). |
Retour : Any. Réponse JSON décodée de l'opération « Effacer une personne concernée ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.legal_hold
legal_hold(resource_type: str, resource_id: str, active: bool = True, reason: str | None = None) -> Any
Poser ou lever un gel juridique. Sans hold_id, pose un nouveau gel sur une personne (subject_id) ou sur une ressource (resource_type et resource_id) ; reason est obligatoire (400 invalid_request sinon). Avec hold_id, active ou lève ce gel selon active (404 not_found pour un gel inconnu).
Route : /v1/retention/legal-hold (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
resource_type | str | oui | Type de la ressource gelée, par exemple memory, media, sessions ou documents. Va avec resource_id. | |
resource_id | str | oui | Identifiant de la ressource gelée. | |
active | bool | True | non | true (par défaut) pour geler, false pour lever le gel désigné par hold_id. |
reason | str | None | None | non | Raison du gel, par exemple un numéro de dossier. Obligatoire pour un nouveau gel. |
Retour : Any. Réponse JSON décodée de l'opération « Poser ou lever un gel juridique ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.lineage_dataset
lineage_dataset(dataset_id: str) -> Any
Lire le lignage d'un jeu de données. Renvoie le nœud du jeu de données, les traitements qui le produisent (produced_by), ceux qui le consomment (consumed_by) et ses graphes amont et aval jusqu'à depth sauts. Ouvert à tout membre du tenant. Répond 404 not_found pour un jeu de données inconnu.
Route : /v1/lineage/datasets/{dataset_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
dataset_id | str | oui | Clé du jeu de données, dataset:<namespace>:<name> ou <namespace>:<name> (le préfixe est ajouté), encodée pour l'URL. |
Retour : Any. Réponse JSON décodée de l'opération « Lire le lignage d'un jeu de données ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.lineage_event
lineage_event(event: dict[str, Any]) -> Any
Envoyer des événements OpenLineage. Accepte un RunEvent OpenLineage ou {"events": [RunEvent, ...]}, en une transaction. Chaque événement exige run.runId, job.namespace et job.name ; eventType vaut START, RUNNING, COMPLETE, ABORT, FAIL ou OTHER (par défaut ; toute autre valeur répond 400) ; eventTime vaut par défaut l'heure de réception.
Route : /v1/lineage/events (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
event | dict[str, Any] | oui | Événement d'exécution OpenLineage, envoyé comme corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Envoyer des événements OpenLineage ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.lineage_graph
lineage_graph(**filters: Any) -> Any
Lire le graphe de lignage. Renvoie nodes et edges. Avec node, le graphe est parcouru depuis ce nœud dans la direction direction jusqu'à depth sauts (404 not_found pour un nœud inconnu). Sans node, renvoie jusqu'à limit nœuds de traitements et de jeux de données triés par clé, et les arêtes qui les relient. Une direction autre que both, upstream ou downstream répond 400 invalid_request. Ouvert à tout membre du tenant.
Route : /v1/lineage/graph (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
**filters | Any | non | Paramètres de requête du graphe de lignée, envoyés tels quels. |
Retour : Any. Réponse JSON décodée de l'opération « Lire le graphe de lignage ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.list_retention_policies
list_retention_policies() -> Any
Lister les politiques de conservation. Renvoie les politiques de conservation du tenant triées par type de ressource dans items, et les gels juridiques actifs dans legal_holds. Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/retention/policies (GET).
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse JSON décodée de l'opération « Lister les politiques de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.mask
mask(text: str, **extra: Any) -> Any
Masquer les données sensibles d'un texte. Comme l'inspection, en mode mask par défaut : chaque constat est remplacé par [TYPE] (par exemple [EMAIL]), ou tokenisé ou bloqué quand une règle du tenant ou mode le demande ; un texte bloqué revient vide avec blocked: true. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.redact.
Route : /v1/dlp/redact (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
text | str | oui | Texte à inspecter ou à masquer. | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Masquer les données sensibles d'un texte ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.run_retention
run_retention(dry_run: bool = False) -> Any
Lancer les politiques de conservation. Applique maintenant les politiques actives, à tous les types de ressources ou à ceux de resource_types. Les éléments de mémoire et les médias dont l'expiration propre est passée sont purgés même sans politique ; les transcriptions et enregistrements temps réel suivent la durée de conservation du consentement des participants. Les éléments sous gel juridique sont ignorés.
Route : /v1/retention/run (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
dry_run | bool | False | non | Si vrai, la requête est vérifiée et son résultat renvoyé, mais rien n'est modifié. |
Retour : Any. Réponse JSON décodée de l'opération « Lancer les politiques de conservation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PrivacyClient.tokenize
tokenize(values: list[dict[str, str]] | None = None, text: str | None = None, **extra: Any) -> Any
Tokeniser des valeurs. Remplace les valeurs sensibles par des jetons déterministes tok_<type>_<hex> du tenant (une même valeur donne toujours le même jeton), les valeurs étant conservées chiffrées dans le coffre. Avec values, renvoie tokens ; avec text, détecte les entités et renvoie le text tokenisé, findings et classification. L'un des deux est obligatoire (400 invalid_request). Ouvert à tout membre du tenant. Écrit l'événement d'audit tokenization.tokenize (nombre uniquement).
Route : /v1/tokenization/tokenize (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
values | list[dict[str, str]] | None | None | non | Valeurs à tokeniser, chacune avec son type. |
text | str | None | None | non | Texte dont les entités détectées sont remplacées par des jetons. |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. Réponse JSON décodée de l'opération « Tokeniser des valeurs ».
Erreurs levées : les erreurs typées du transport (Erreurs).