Waafir
Cette page est une traduction automatique en attente de relecture humaine. Elle peut contenir des erreurs.

Référence waafir-redact

Le serveur waafir-redact expose le caviardage de Waafir à un client IA connecté, sous deux formes :

  • redact_text — un bloc de texte, caviardé en ligne et renvoyé immédiatement.
  • redact_file / redact_file_status — tout un document d'une salle de données, analysé pour y repérer des données personnelles et préparé pour une revue humaine.

Appliquer un caviardage à un document n'est délibérément pas possible via MCP. L'application modifie ce que voient toutes les autres parties lorsqu'elles ouvrent le fichier ; une personne doit donc l'approuver dans l'écran de revue du caviardage IA. Aucun outil de ce serveur ne modifie ce que voit un lecteur.

Connexion : https://app.waafir.io/api/mcp/waafir, ou le serveur de domaine https://app.waafir.io/api/mcp/waafir-redact ; les noms d'outils sont identiques sur les deux — voir Configuration. redact_text n'exige qu'un PAT de portée read (ou supérieure) — il ne touche aucune salle de données, il n'y a donc aucun contrôle par fichier ou par salle à franchir (il nécessite néanmoins une offre payante et l'IA activée, comme tout outil qui exécute un modèle).

Les deux outils de document sont réservés à l'équipe de transaction. redact_file exige la portée write et l'appartenance à l'équipe de transaction de la salle de données — tout comme redact_file_status, bien qu'il ne fasse que lire : un PAT de portée read est nécessaire mais pas suffisant, car l'existence d'une tâche de caviardage est en soi une information sur le document. Un appelant hors de l'équipe de transaction reçoit FORBIDDEN, quelle que soit la portée du jeton. La portée du jeton est le plafond du jeton ; l'appartenance à l'équipe de transaction est celui de la personne — les deux doivent être franchis.

redact_text

Caviarder les données personnelles d'un bloc de texte. Le texte est traité par l'agent de caviardage de votre organisation, et l'outil renvoie le texte caviardé ainsi que la liste des entités qu'il a identifiées. Vous pouvez éventuellement restreindre le résultat à des types d'entités précis.

Entrées

ChampTypeObligatoireDescription
textstringouiLe texte à caviarder (ne doit pas être vide).
typesstring[]nonRestreint le caviardage à ces types de données personnelles. Omettez-le pour caviarder tout ce qui est détecté.

Sortie

{ redacted_text, entities, truncated, processed_chars, total_chars, max_chars,
  filtered_out_count, unclassified_redacted_count, unclassified_types,
  filter_exact }
  • redacted_text — le texte analysé, avec les passages sensibles noircis.
  • entities — les données personnelles supprimées. type est le libellé utilisé par le modèle de caviardage ; canonical_type est le type standard auquel il correspond, ou null s'il n'a pas pu être classé.
  • truncated / processed_chars / total_chars / max_chars — voir Limite de taille.
  • filtered_out_count / unclassified_redacted_count / unclassified_types / filter_exact — voir Filtrage par type.

Le caviardage s'exécute selon la configuration de caviardage propre à votre organisation ; les résultats reflètent donc le même agent que celui utilisé par le produit. Comme pour tout ce qui se trouve sur cette surface, l'appel agit en tant que propriétaire du jeton et est limité à cette organisation.

Limite de taille

Seuls les 80 000 premiers caractères sont analysés. Cela a toujours été le cas ; le résultat vous l'indique désormais. Lorsque truncated vaut true, le texte au-delà de processed_chars n'a jamais été examiné — ne considérez pas la réponse comme un caviardage de l'ensemble de l'entrée. Envoyez le reste dans un appel ultérieur.

Filtrage par type

types n'accepte que ces valeurs :

name, email, phone, ssn, account, address, financial, confidential, url, username

⚠️ Changement incompatible (août 2026). types acceptait auparavant n'importe quelle chaîne. Il n'accepte désormais que les valeurs ci-dessus, et toute autre valeur — "emails", "PII", "credit-card", ou une casse différente comme "EMAIL" — renvoie une erreur de validation.

Cela remplace un échec silencieux par un échec visible. Une valeur non reconnue ne correspondait auparavant à rien : l'outil ne caviardait rien et renvoyait votre texte d'origine comme redacted_text dans une réponse réussie. Si vous transmettez types, faites correspondre vos valeurs à la liste ci-dessus. Les appels qui omettent types ne sont pas concernés.

Un type d'entité est caviardé même si vous ne l'avez pas demandé. Si le modèle de caviardage attribue à un élément un type que nous ne reconnaissons pas, cette entité est caviardée malgré tout plutôt qu'écartée — nous ne pouvons pas prouver qu'elle sort du périmètre demandé, et laisser des données personnelles dans le texte est l'erreur la plus grave. Dans ce cas :

  • filter_exact vaut false (il vaut true chaque fois que le filtre s'est appliqué exactement),
  • unclassified_redacted_count indique combien d'entités sont concernées, et
  • unclassified_types liste les libellés en cause.

Les entités que vous avez délibérément exclues par filtrage sont comptées séparément, dans filtered_out_count.

Prérequis : une offre payante et les fonctionnalités IA de votre organisation activées (activées par défaut ; un administrateur de l'organisation peut les désactiver dans Paramètres → IA et intégrations). Les appels sont également refusés une fois que votre organisation atteint sa limite quotidienne d'utilisation de l'IA, ou tant que Waafir a mis la fonctionnalité en pause ; le message d'erreur précise lequel des deux.

redact_file

Analyser tout un document d'une salle de données pour y repérer des données personnelles. Cet outil ne fait qu'analyser — le document n'est pas modifié, et la vue de quiconque sur ce document reste inchangée. L'analyse est asynchrone ; interrogez redact_file_status.

Entrées

ChampTypeObligatoireDescription
file_idstringouiL'UUID du fichier.
override_redactedbooleannonRéanalyse un document déjà caviardé. Sans lui, un fichier déjà caviardé est refusé.

Sortie

{ file_id, job_id, status: "analysis_started", applied: false,
  review_required: true, review_with, apply_via }

Il n'existe pas d'option auto_apply, à dessein — voir la note en haut de cette page. Les fichiers image ne sont pas pris en charge.

Prérequis : un PAT de portée write, l'appartenance à l'équipe de transaction de la salle de données, une offre payante et les fonctionnalités IA de votre organisation activées (activées par défaut ; un administrateur de l'organisation peut les désactiver dans Paramètres → IA et intégrations).

Un fichier encore en cours de vérification. Si le fichier est un nouveau téléversement ou une nouvelle version que Waafir n'a pas fini de vérifier, redact_file et redact_apply répondent UNAVAILABLE avec error.reason: "ACTIVATION_PENDING" et le message This file is still being checked. Try again shortly. Rien n'est analysé ni appliqué ; rappelez l'outil après un court délai.

redact_file_status

Vérifier l'état de l'analyse de caviardage d'un document.

Entrées

ChampTypeObligatoireDescription
file_idstringouiL'UUID du fichier.

Sortie

{ file_id, status, entity_count?, applied: false, apply_via }
  • status — l'une des valeurs idle, analyzing, applying, review_ready, completed, failed, error. applying et completed décrivent un caviardage en cours d'application dans l'interface de Waafir par une personne — vous ne pouvez pas les atteindre depuis MCP, mais vous les verrez si quelqu'un approuve la revue pendant que vous interrogez.
  • entity_count — le nombre d'entités de données personnelles proposées par l'analyse, une fois la revue prête.
  • applied vaut toujours false : l'approbation et l'application du caviardage ont lieu dans l'interface de Waafir.

Traitez un status non reconnu comme « continuer d'interroger », et non comme une erreur. Les états terminaux ne sont conservés que brièvement avant le nettoyage du marqueur de tâche ; un processus d'interrogation qui arrive tard voit donc idle (ou un review_ready reconstitué) plutôt que l'état qu'il attendait — et idle signifie « aucune tâche en cours », et non « rien ne s'est jamais produit ». Interrogez jusqu'à obtenir l'état voulu, avec une échéance, plutôt que d'affirmer que la valeur appartient à une liste fixe.

redact_history

La dernière analyse de caviardage d'un fichier, sous forme de décomptes par type d'entité. Le texte caviardé lui-même n'est jamais renvoyé.

  • Portée : read. Membres de l'équipe de transaction, sur un fichier dont ils peuvent lire le contenu.
  • Entrées : file_id (obligatoire).
  • Sortie : { file_id, analysis }. analysis vaut { history_id, analysed_at, entities: { total, by_type } }, ou null lorsque le fichier n'a jamais été analysé.

redact_list_terms

Les termes de caviardage d'une salle de données : les expressions toujours caviardées (always) et les expressions jamais caviardées (never).

  • Portée : read. Membres de l'équipe de transaction.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { terms }, chacun { id, term, kind, created_at }.

redact_add_term

Ajouter un terme à une salle de données. Il s'applique au prochain caviardage d'un fichier de la salle et ne modifie aucun fichier pour l'instant.

  • Portée : write. Membres de l'équipe de transaction, avec une offre payante.
  • Entrées : dataroom_id, term (tous deux obligatoires) ; kind (always ou never, always par défaut).
  • Sortie : { term }.

redact_remove_term

Retirer un terme d'une salle de données. Cela ne modifie aucun fichier pour l'instant ; rajouter le terme annule l'opération.

  • Portée : write. Membres de l'équipe de transaction.
  • Entrées : dataroom_id, term_id (tous deux obligatoires).
  • Sortie : { removed, term_id }.

redact_revert

Annuler le caviardage d'un fichier. Chaque lecteur, investisseurs compris, reçoit de nouveau immédiatement le document d'origine. La version caviardée est conservée, afin de pouvoir être réappliquée.

  • Portée : write. Membres de l'équipe de transaction, sur un fichier qu'ils peuvent modifier.
  • Entrées : file_id (obligatoire) ; confirm_token.
  • Deux étapes. Sans confirm_token, rien ne change et vous obtenez un aperçu ainsi qu'un jeton. Rappelez l'outil avec les mêmes arguments et le jeton pour annuler le caviardage.
  • Un fichier qui n'est pas caviardé est refusé (409). De même pour un fichier dont une analyse ou une gravure est en cours (409) : vous en êtes informé dès l'aperçu, si bien qu'aucun jeton n'est émis pour une annulation qui ne peut pas s'exécuter, et le contrôle est refait lorsque vous confirmez.

redact_apply

Appliquer la dernière analyse d'un fichier issue de redact_file, moins les types d'entités que vous excluez, plus les termes toujours caviardés de la salle de données. Chaque lecteur, investisseurs compris, reçoit alors le document caviardé. redact_revert annule l'opération.

  • Portée : write. Membres de l'équipe de transaction, avec une offre payante, sur un fichier dont ils peuvent lire le contenu.
  • Entrées : file_id (obligatoire) ; exclude_types ; confirm_token.
  • Deux étapes. Sans confirm_token, rien ne change et vous obtenez un aperçu (les cibles comptées par type, jamais le texte) ainsi qu'un jeton. Rappelez l'outil avec les mêmes arguments et le jeton pour lancer la gravure. Si l'analyse, le fichier, les termes de la salle ou les cibles ont changé entre-temps, l'appel est refusé et vous refaites un aperçu.
  • Lorsque l'IA est désactivée pour votre organisation, seuls les termes toujours caviardés enregistrés pour la salle peuvent être appliqués, comme dans Waafir.