Referenz zu waafir-redact
Der Server waafir-redact stellt einem verbundenen KI-Client die
Schwärzung von Waafir in zwei Formen bereit:
redact_text— ein Textblock, inline geschwärzt und sofort zurückgegeben.redact_file/redact_file_status— ein ganzes Dokument in einem Datenraum, auf PII analysiert und für die Prüfung durch einen Menschen vorbereitet.
Das Anwenden einer Schwärzung auf ein Dokument ist bewusst nicht über MCP verfügbar. Das Anwenden ändert, was jede andere Partei beim Öffnen der Datei sieht, daher muss ein Mensch es im Prüfbildschirm der KI-Schwärzung freigeben. Kein Tool auf diesem Server ändert, was ein Leser sieht.
Verbindung: https://app.waafir.io/api/mcp/waafir oder der Bereichsserver
https://app.waafir.io/api/mcp/waafir-redact; die Tool-Namen sind auf beiden gleich — siehe
Einrichtung. redact_text benötigt nur ein
PAT mit dem Scope read (oder höher) — es berührt
keinen Datenraum, daher gibt es keine Prüfung pro Datei oder pro Raum (es benötigt aber
wie jedes Tool, das ein Modell ausführt, einen kostenpflichtigen Tarif und aktivierte KI).
Beide Dokument-Tools sind nur für das Deal-Team. redact_file benötigt den Scope write
und die Mitgliedschaft im Deal-Team des Datenraums — und ebenso
redact_file_status, obwohl es nur liest: Ein PAT mit Scope read ist
notwendig, aber nicht ausreichend, denn schon die Existenz eines Schwärzungsauftrags ist
eine Tatsache über das Dokument. Ein Aufrufer außerhalb des Deal-Teams erhält
FORBIDDEN, unabhängig vom Scope des Tokens. Der Token-Scope ist die Obergrenze des Tokens;
die Deal-Team-Mitgliedschaft ist die der Person — beide müssen erfüllt sein.
redact_text
Schwärzt PII in einem Textblock. Der Text wird vom Schwärzungsagenten Ihrer Organisation verarbeitet, und das Tool gibt den geschwärzten Text zusammen mit der Liste der erkannten Entitäten zurück. Optional können Sie das Ergebnis auf bestimmte Entitätstypen eingrenzen.
Eingaben
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
text | string | ja | Der zu schwärzende Text (darf nicht leer sein). |
types | string[] | nein | Beschränkt die Schwärzung auf diese PII-Typen. Weglassen, um alles Erkannte zu schwärzen. |
Ausgabe
{ redacted_text, entities, truncated, processed_chars, total_chars, max_chars,
filtered_out_count, unclassified_redacted_count, unclassified_types,
filter_exact }redacted_text— der analysierte Text mit geschwärzten sensiblen Abschnitten.entities— die entfernten PII.typeist die Bezeichnung, die das Schwärzungsmodell verwendet hat;canonical_typeist der Standardtyp, dem sie zugeordnet ist, odernull, wenn sie nicht klassifiziert werden konnte.truncated/processed_chars/total_chars/max_chars— siehe Größenlimit.filtered_out_count/unclassified_redacted_count/unclassified_types/filter_exact— siehe Filtern nach Typ.
Die Schwärzung läuft mit der eigenen Schwärzungskonfiguration Ihrer Organisation, daher spiegeln die Ergebnisse denselben Agenten wider, den das Produkt verwendet. Wie bei allem auf dieser Oberfläche handelt der Aufruf als Eigentümer des Tokens und ist auf diese Organisation beschränkt.
Größenlimit
Nur die ersten 80.000 Zeichen werden analysiert. Das war schon immer
so; das Ergebnis teilt es Ihnen jetzt mit. Wenn truncated den Wert true hat, wurde der Text nach
processed_chars nie untersucht — behandeln Sie die Antwort nicht als
Schwärzung der gesamten Eingabe. Senden Sie den Rest in einem weiteren Aufruf.
Filtern nach Typ
types akzeptiert nur diese Werte:
name, email, phone, ssn, account, address, financial,
confidential, url, username
⚠️ Inkompatible Änderung (August 2026).
typesakzeptierte bisher jede beliebige Zeichenkette. Jetzt akzeptiert es nur die oben genannten Werte, und alles andere —"emails","PII","credit-card"oder eine abweichende Groß-/Kleinschreibung wie"EMAIL"— liefert einen Validierungsfehler.Damit wird ein stiller Fehler durch einen deutlich sichtbaren ersetzt. Ein unbekannter Wert traf früher auf nichts zu, sodass das Tool nichts schwärzte und Ihren Originaltext als
redacted_textin einer erfolgreichen Antwort zurückgab. Wenn Sietypesübergeben, ordnen Sie Ihre Werte der obigen Liste zu. Aufrufe ohnetypessind nicht betroffen.
Ein Entitätstyp wird geschwärzt, auch wenn Sie ihn nicht angefordert haben. Wenn das Schwärzungsmodell etwas mit einem Typ kennzeichnet, den wir nicht erkennen können, wird diese Entität trotzdem geschwärzt, statt verworfen zu werden — wir können nicht nachweisen, dass sie außerhalb dessen liegt, was Sie angefordert haben, und PII im Text zu belassen ist der schwerere Fehler. Wenn das passiert:
filter_exactistfalse(es isttrue, wann immer der Filter exakt angewendet wurde),unclassified_redacted_countgibt an, wie viele Entitäten betroffen waren, undunclassified_typeslistet die beteiligten Bezeichnungen auf.
Entitäten, die Sie bewusst herausgefiltert haben, werden separat gezählt, in
filtered_out_count.
Voraussetzungen: ein kostenpflichtiger Tarif und aktivierte KI-Funktionen Ihrer Organisation (standardmäßig eingeschaltet; ein Organisationsadministrator kann sie unter Einstellungen → KI & Integrationen ausschalten). Aufrufe werden außerdem abgelehnt, sobald Ihre Organisation ihr tägliches KI-Nutzungslimit erreicht hat oder solange Waafir die Funktion pausiert hat; die Fehlermeldung nennt den Grund.
redact_file
Analysiert ein ganzes Dokument in einem Datenraum auf PII. Das Tool analysiert nur — das
Dokument wird nicht verändert, und niemandes Ansicht davon ändert sich. Die Analyse ist
asynchron; fragen Sie redact_file_status ab.
Eingaben
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file_id | string | ja | Die UUID der Datei. |
override_redacted | boolean | nein | Analysiert ein bereits geschwärztes Dokument erneut. Ohne diesen Parameter wird eine bereits geschwärzte Datei abgelehnt. |
Ausgabe
{ file_id, job_id, status: "analysis_started", applied: false,
review_required: true, review_with, apply_via }Es gibt bewusst keine Option auto_apply — siehe den Hinweis oben auf dieser
Seite. Bilddateien werden nicht unterstützt.
Voraussetzungen: ein PAT mit Scope write, Mitgliedschaft im Deal-Team des Datenraums,
ein kostenpflichtiger Tarif und aktivierte KI-Funktionen Ihrer Organisation (standardmäßig eingeschaltet; ein Organisationsadministrator kann sie unter Einstellungen → KI & Integrationen ausschalten).
Eine Datei, die noch geprüft wird. Ist die Datei ein neuer Upload oder eine
neue Version, deren Prüfung Waafir noch nicht abgeschlossen hat, antworten
redact_file und redact_apply mit UNAVAILABLE,
error.reason: "ACTIVATION_PENDING" und der Meldung
This file is still being checked. Try again shortly. Es wird nichts analysiert
oder angewendet; rufen Sie das Tool nach kurzer Wartezeit erneut auf.
redact_file_status
Prüft eine Schwärzungsanalyse eines Dokuments.
Eingaben
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file_id | string | ja | Die UUID der Datei. |
Ausgabe
{ file_id, status, entity_count?, applied: false, apply_via }status— einer vonidle,analyzing,applying,review_ready,completed,failed,error.applyingundcompletedbeschreiben eine Schwärzung, die von einer Person in der Waafir-Oberfläche angewendet wird — Sie können sie nicht über MCP auslösen, sehen sie aber, wenn jemand die Prüfung freigibt, während Sie abfragen.entity_count— wie viele PII-Entitäten die Analyse vorgeschlagen hat, sobald die Prüfung bereit ist.appliedist immerfalse: Das Freigeben und Anwenden der Schwärzung erfolgt in der Waafir-Oberfläche.
Behandeln Sie einen unbekannten status als „weiter abfragen“, nicht als Fehler. Die
Endzustände werden nur kurz vorgehalten, bevor die Auftragsmarkierung bereinigt wird, daher sieht
ein verspätet abfragender Client idle (oder ein rekonstruiertes review_ready) statt
des Zustands, auf den er gewartet hat — und idle bedeutet „kein Auftrag in Bearbeitung“, nicht
„es ist nie etwas passiert“. Fragen Sie mit einer Frist nach dem gewünschten Zustand ab, statt
zu verlangen, dass der Wert aus einer festen Liste stammt.
redact_history
Die neueste Schwärzungsanalyse einer Datei, als Anzahl je Entitätstyp. Der geschwärzte Text selbst wird nie zurückgegeben.
- Scope:
read. Deal-Team-Mitglieder, für eine Datei, deren Inhalt sie lesen dürfen. - Eingaben:
file_id(erforderlich). - Ausgabe:
{ file_id, analysis }.analysisist{ history_id, analysed_at, entities: { total, by_type } }oder null, wenn die Datei noch nie analysiert wurde.
redact_list_terms
Die Schwärzungsbegriffe eines Datenraums: Formulierungen, die immer geschwärzt werden (always), und Formulierungen,
die nie geschwärzt werden (never).
- Scope:
read. Deal-Team-Mitglieder. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ terms }, jeweils{ id, term, kind, created_at }.
redact_add_term
Fügt einem Datenraum einen Begriff hinzu. Er gilt für die nächste Schwärzung einer Datei im Raum und ändert jetzt keine Datei.
- Scope:
write. Deal-Team-Mitglieder, mit kostenpflichtigem Tarif. - Eingaben:
dataroom_id,term(beide erforderlich);kind(alwaysodernever, Standardalways). - Ausgabe:
{ term }.
redact_remove_term
Entfernt einen Begriff aus einem Datenraum. Es ändert jetzt keine Datei; erneutes Hinzufügen des Begriffs macht es rückgängig.
- Scope:
write. Deal-Team-Mitglieder. - Eingaben:
dataroom_id,term_id(beide erforderlich). - Ausgabe:
{ removed, term_id }.
redact_revert
Hebt die Schwärzung einer Datei auf. Jedem Leser, auch Investoren, wird sofort wieder das Originaldokument ausgeliefert. Die geschwärzte Version bleibt erhalten, sodass sie erneut angewendet werden kann.
- Scope:
write. Deal-Team-Mitglieder, für eine Datei, die sie bearbeiten dürfen. - Eingaben:
file_id(erforderlich);confirm_token. - Zwei Schritte. Ohne
confirm_tokenändert sich nichts, und Sie erhalten eine Vorschau plus ein Token. Rufen Sie das Tool mit denselben Argumenten und dem Token erneut auf, um zurückzusetzen. - Eine nicht geschwärzte Datei wird abgelehnt (
409). Ebenso eine, bei der eine Analyse oder ein Einbrennen läuft (409): Das wird Ihnen bereits bei der Vorschau mitgeteilt, sodass für ein Zurücksetzen, das nicht ausgeführt werden kann, kein Token ausgestellt wird, und die Prüfung läuft bei Ihrer Bestätigung erneut.
redact_apply
Wendet die neueste Analyse einer Datei aus redact_file an, abzüglich der Entitätstypen, die Sie
ausschließen, zuzüglich der Immer-schwärzen-Begriffe des Datenraums. Jedem Leser, auch
Investoren, wird danach das geschwärzte Dokument ausgeliefert. redact_revert macht es rückgängig.
- Scope:
write. Deal-Team-Mitglieder, mit kostenpflichtigem Tarif, für eine Datei, deren Inhalt sie lesen dürfen. - Eingaben:
file_id(erforderlich);exclude_types;confirm_token. - Zwei Schritte. Ohne
confirm_tokenändert sich nichts, und Sie erhalten eine Vorschau (die Ziele nach Typ gezählt, nie der Text) plus ein Token. Rufen Sie das Tool mit denselben Argumenten und dem Token erneut auf, um das Einbrennen zu starten. Wenn sich die Analyse, die Datei, die Begriffe des Raums oder die Ziele zwischenzeitlich geändert haben, wird der Aufruf abgelehnt, und Sie erstellen erneut eine Vorschau. - Wenn KI für Ihre Organisation ausgeschaltet ist, können nur die gespeicherten Immer-schwärzen-Begriffe des Raums angewendet werden, wie in Waafir.