Referencia de waafir-redact
El servidor waafir-redact expone la supresión de datos de Waafir a un
cliente de IA conectado, de dos formas:
redact_text— un bloque de texto, al que se aplica la supresión de datos en línea y que se devuelve de inmediato.redact_file/redact_file_status— un documento completo de una sala de datos, analizado en busca de PII y preparado para revisión humana.
Aplicar una supresión de datos a un documento deliberadamente no está disponible a través de MCP. Aplicarla cambia lo que ven todas las demás partes cuando abren el archivo, por lo que una persona debe aprobarla en la pantalla de revisión de Supresión de datos con IA. Ninguna herramienta de este servidor cambia lo que ve ningún lector.
Conexión: https://app.waafir.io/api/mcp/waafir, o el servidor de área
https://app.waafir.io/api/mcp/waafir-redact; los nombres de las herramientas
son los mismos en ambos — consulte
Configuración. redact_text solo requiere
un PAT con alcance read
(o superior): no afecta a ninguna sala de datos, por lo que no hay ninguna
comprobación por archivo ni por sala que superar (aun así requiere un plan de
pago y la IA habilitada, como toda herramienta que ejecuta un modelo).
Las dos herramientas de documentos son exclusivas del equipo de la operación. redact_file requiere el alcance write y pertenecer al
equipo de la operación de la sala de datos — y lo mismo ocurre con
redact_file_status, aunque solo lee: un PAT con alcance read es
necesario pero no suficiente, porque la existencia de un trabajo de supresión
de datos es en sí misma un dato sobre el documento. Quien llama sin
pertenecer al equipo de la operación recibe FORBIDDEN, sea cual sea el
alcance del token. El alcance del token es el límite del token; la
pertenencia al equipo de la operación es el de la persona: hay que superar
ambos.
redact_text
Aplica la supresión de datos personales (PII) en un bloque de texto. El texto lo procesa el agente de supresión de datos de su organización, y la herramienta devuelve el texto con la supresión aplicada junto con la lista de entidades que identificó. Opcionalmente, puede limitar el resultado a tipos de entidad concretos.
Entradas
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
text | string | sí | El texto al que aplicar la supresión de datos (no puede estar vacío). |
types | string[] | no | Limita la supresión de datos a estos tipos de PII. Omítalo para suprimir todo lo detectado. |
Salida
{ redacted_text, entities, truncated, processed_chars, total_chars, max_chars,
filtered_out_count, unclassified_redacted_count, unclassified_types,
filter_exact }redacted_text— el texto analizado con los fragmentos sensibles ocultos.entities— los datos personales que se eliminaron.typees la etiqueta que usó el modelo de supresión de datos;canonical_typees el tipo estándar al que corresponde, onullsi no se pudo clasificar.truncated/processed_chars/total_chars/max_chars— consulte Límite de tamaño.filtered_out_count/unclassified_redacted_count/unclassified_types/filter_exact— consulte Filtrar por tipo.
La supresión de datos se ejecuta con la propia configuración de supresión de datos de su organización, por lo que los resultados reflejan el mismo agente que usa el producto. Como todo en esta superficie, la llamada actúa como el propietario del token y se limita a esa organización.
Límite de tamaño
Solo se analizan los primeros 80.000 caracteres. Siempre ha sido así;
ahora el resultado se lo indica. Cuando truncated es true, el texto
posterior a processed_chars nunca se examinó: no trate la respuesta como
una supresión de datos de toda la entrada. Envíe el resto en una llamada
posterior.
Filtrar por tipo
types solo acepta estos valores:
name, email, phone, ssn, account, address, financial,
confidential, url, username
⚠️ Cambio incompatible (agosto de 2026). Antes,
typesaceptaba cualquier cadena. Ahora solo acepta los valores anteriores, y cualquier otro —"emails","PII","credit-card", o una capitalización distinta como"EMAIL"— devuelve un error de validación.Esto sustituye un fallo silencioso por uno visible. Antes, un valor no reconocido no coincidía con nada, por lo que la herramienta no suprimía nada y devolvía su texto original como
redacted_textdentro de una respuesta correcta. Si pasatypes, asigne sus valores a la lista anterior. Las llamadas que omitentypesno se ven afectadas.
Un tipo de entidad se suprime aunque no lo haya pedido. Si el modelo de supresión de datos etiqueta algo con un tipo que no podemos reconocer, esa entidad se suprime de todos modos en lugar de descartarse: no podemos demostrar que quede fuera de lo que usted pidió, y dejar datos personales en el texto es el error más grave. Cuando esto ocurre:
filter_exactesfalse(estruesiempre que el filtro se aplicó exactamente),unclassified_redacted_countindica a cuántas entidades afectó, yunclassified_typeslista las etiquetas implicadas.
Las entidades que usted excluyó deliberadamente se cuentan por separado, en
filtered_out_count.
Requisitos: un plan de pago y las funciones de IA de su organización habilitadas (activadas por defecto; un administrador de la organización puede desactivarlas en Configuración → IA e Integraciones). Las llamadas también se rechazan cuando su organización alcanza su límite diario de uso de IA, o mientras Waafir haya pausado la función; el mensaje de error indica cuál de los dos casos se da.
redact_file
Analiza un documento completo de una sala de datos en busca de PII. Esto
solo analiza: el documento no se modifica, y no cambia lo que nadie ve de
él. El análisis es asíncrono; consulte periódicamente redact_file_status.
Entradas
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
file_id | string | sí | El UUID del archivo. |
override_redacted | boolean | no | Vuelve a analizar un documento al que ya se aplicó la supresión de datos. Sin él, un archivo con la supresión ya aplicada se rechaza. |
Salida
{ file_id, job_id, status: "analysis_started", applied: false,
review_required: true, review_with, apply_via }No existe ninguna opción auto_apply, por diseño — consulte la nota al
principio de esta página. Los archivos de imagen no son compatibles.
Requisitos: un PAT con alcance write, pertenecer al equipo de la
operación de la sala de datos, un plan de pago y las funciones de IA de su organización habilitadas (activadas por defecto; un administrador de la organización puede desactivarlas en Configuración → IA e Integraciones).
Un archivo que aún se está comprobando. Si el archivo es una subida o
versión nueva que Waafir aún no ha terminado de comprobar, redact_file y
redact_apply responden UNAVAILABLE con error.reason: "ACTIVATION_PENDING"
y el mensaje This file is still being checked. Try again shortly. No se
analiza ni se aplica nada; vuelva a llamar tras una breve espera.
redact_file_status
Comprueba un análisis de supresión de datos de un documento.
Entradas
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
file_id | string | sí | El UUID del archivo. |
Salida
{ file_id, status, entity_count?, applied: false, apply_via }status— uno deidle,analyzing,applying,review_ready,completed,failed,error.applyingycompleteddescriben una supresión de datos que una persona está aplicando en la interfaz de Waafir: no puede llegar a ellos desde MCP, pero los verá si alguien aprueba la revisión mientras usted consulta el estado.entity_count— cuántas entidades de PII propuso el análisis, una vez que la revisión está lista.appliedsiempre esfalse: la aprobación y la aplicación de la supresión de datos se hacen en la interfaz de Waafir.
Trate un status no reconocido como "seguir consultando", no como un error. Los estados finales solo se conservan brevemente antes de que se
limpie el marcador del trabajo, por lo que quien consulta tarde ve idle (o
un review_ready reconstruido) en lugar del estado que esperaba — y idle
significa "ningún trabajo en curso", no "nunca pasó nada". Consulte hasta
obtener el estado que busca, con un plazo límite, en lugar de afirmar que el
valor pertenece a una lista fija.
redact_history
El último análisis de supresión de datos de un archivo, como recuentos por tipo de entidad. El texto suprimido nunca se devuelve.
- Alcance:
read. Miembros del equipo de la operación, sobre un archivo cuyo contenido pueden leer. - Entradas:
file_id(obligatorio). - Salida:
{ file_id, analysis }.analysises{ history_id, analysed_at, entities: { total, by_type } }, o null cuando el archivo nunca se ha analizado.
redact_list_terms
Los términos de supresión de datos de una sala de datos: frases que siempre se
suprimen (always) y frases que nunca se suprimen (never).
- Alcance:
read. Miembros del equipo de la operación. - Entradas:
dataroom_id(obligatorio). - Salida:
{ terms }, cada uno{ id, term, kind, created_at }.
redact_add_term
Añade un término a una sala de datos. Se aplica a la siguiente supresión de datos de un archivo de la sala y no modifica ningún archivo ahora.
- Alcance:
write. Miembros del equipo de la operación, con un plan de pago. - Entradas:
dataroom_id,term(ambos obligatorios);kind(alwaysonever, por defectoalways). - Salida:
{ term }.
redact_remove_term
Elimina un término de una sala de datos. No modifica ningún archivo ahora; volver a añadir el término lo deshace.
- Alcance:
write. Miembros del equipo de la operación. - Entradas:
dataroom_id,term_id(ambos obligatorios). - Salida:
{ removed, term_id }.
redact_revert
Deshace la supresión de datos de un archivo. A todos los lectores, inversores incluidos, se les vuelve a servir de inmediato el documento original. La versión con la supresión aplicada se conserva, por lo que puede volver a aplicarse.
- Alcance:
write. Miembros del equipo de la operación, sobre un archivo que pueden editar. - Entradas:
file_id(obligatorio);confirm_token. - Dos pasos. Sin
confirm_tokenno cambia nada y obtiene una vista previa más un token. Vuelva a llamar con los mismos argumentos y el token para revertir. - Un archivo sin supresión de datos aplicada se rechaza (
409). También uno con un análisis o una aplicación en curso (409): se le indica en la vista previa, de modo que no se emite ningún token para una reversión que no puede ejecutarse, y la comprobación se repite al confirmar.
redact_apply
Aplica el último análisis de un archivo obtenido con redact_file, menos los
tipos de entidad que usted excluya, más los términos de supresión permanente
de la sala de datos. A partir de ese momento, a todos los lectores, inversores
incluidos, se les sirve el documento con la supresión aplicada.
redact_revert lo deshace.
- Alcance:
write. Miembros del equipo de la operación, con un plan de pago, sobre un archivo cuyo contenido pueden leer. - Entradas:
file_id(obligatorio);exclude_types;confirm_token. - Dos pasos. Sin
confirm_tokenno cambia nada y obtiene una vista previa (los objetivos contados por tipo, nunca el texto) más un token. Vuelva a llamar con los mismos argumentos y el token para iniciar la aplicación. Si entretanto cambiaron el análisis, el archivo, los términos de la sala o los objetivos, la llamada se rechaza y debe volver a obtener la vista previa. - Con la IA desactivada para su organización, solo pueden aplicarse los términos de supresión permanente guardados de la sala, como en Waafir.