Waafir
Эта страница переведена машинным способом и ожидает проверки человеком. Возможны неточности.

Справочник waafir-redact

Сервер waafir-redact предоставляет подключённому ИИ-клиенту функцию скрытия данных Waafir в двух формах:

  • redact_text — фрагмент текста, в котором данные скрываются прямо в запросе, а результат возвращается немедленно.
  • redact_file / redact_file_status — целый документ в комнате данных, который анализируется на наличие PII и готовится к проверке человеком.

Применение скрытия данных к документу намеренно недоступно через MCP. Применение меняет то, что видит каждая другая сторона при открытии файла, поэтому его должен одобрить человек на экране проверки ИИ-скрытия данных. Ни один инструмент этого сервера не меняет то, что видит какой-либо читатель.

Подключение: https://app.waafir.io/api/mcp/waafir или сервер области https://app.waafir.io/api/mcp/waafir-redact; имена инструментов на обоих одинаковые — см. Настройка. Для redact_text достаточно PAT с областью доступа read (или выше) — он не затрагивает ни одну комнату данных, поэтому проверок на уровне файла или комнаты нет (но, как и любому инструменту, запускающему модель, ему по-прежнему нужен платный тариф и включённый ИИ).

Оба инструмента для документов доступны только команде сделки. redact_file требует области доступа write и членства в команде сделки комнаты данных — как и redact_file_status, хотя он только читает: PAT с областью доступа read необходим, но недостаточен, потому что само существование задания скрытия данных — это факт о документе. Вызывающий вне команды сделки получает FORBIDDEN, какую бы область доступа ни нёс токен. Область доступа токена — потолок токена; членство в команде сделки — потолок человека, и пройти нужно оба.

redact_text

Скрытие данных PII во фрагменте текста. Текст обрабатывается агентом скрытия данных вашей организации, и инструмент возвращает текст со скрытыми данными вместе со списком выявленных сущностей. При желании результат можно ограничить определёнными типами сущностей.

Входные данные

ПолеТипОбязательноОписание
textstringдаТекст, в котором нужно скрыть данные (не должен быть пустым).
typesstring[]нетОграничить скрытие данных этими типами PII. Не указывайте, чтобы скрыть всё обнаруженное.

Выходные данные

{ redacted_text, entities, truncated, processed_chars, total_chars, max_chars,
  filtered_out_count, unclassified_redacted_count, unclassified_types,
  filter_exact }
  • redacted_text — проанализированный текст с затёртыми чувствительными фрагментами.
  • entities — удалённые PII. type — метка, которую использовала модель скрытия данных; canonical_type — стандартный тип, которому она соответствует, или null, если её не удалось классифицировать.
  • truncated / processed_chars / total_chars / max_chars — см. Ограничение размера.
  • filtered_out_count / unclassified_redacted_count / unclassified_types / filter_exact — см. Фильтрация по типу.

Скрытие данных выполняется по собственной конфигурации скрытия данных вашей организации, поэтому результаты отражают того же агента, что используется в продукте. Как и всё на этой поверхности, вызов выполняется от имени владельца токена и ограничен его организацией.

Ограничение размера

Анализируются только первые 80 000 символов. Так было всегда; теперь результат сообщает вам об этом. Когда truncated равно true, текст за пределами processed_chars вообще не проверялся — не считайте ответ скрытием данных во всём входном тексте. Отправьте остаток в следующем вызове.

Фильтрация по типу

types принимает только эти значения:

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

⚠️ Несовместимое изменение (август 2026 г.). Раньше types принимал любую строку. Теперь он принимает только перечисленные выше значения, а всё остальное — "emails", "PII", "credit-card" или другой регистр, например "EMAIL", — возвращает ошибку валидации.

Это заменяет тихий сбой явным. Раньше нераспознанное значение ни с чем не совпадало, поэтому инструмент ничего не скрывал и возвращал ваш исходный текст как redacted_text внутри успешного ответа. Если вы передаёте types, сопоставьте свои значения со списком выше. Вызовов без types это не касается.

Один тип сущностей скрывается, даже если вы его не запрашивали. Если модель скрытия данных помечает что-либо типом, который мы не можем распознать, эта сущность всё равно скрывается, а не отбрасывается — мы не можем доказать, что она выходит за рамки запрошенного, а оставить PII в тексте — худшая ошибка. Когда это происходит:

  • filter_exact равно false (оно равно true всякий раз, когда фильтр применён точно),
  • unclassified_redacted_count сообщает, скольких сущностей это коснулось, и
  • unclassified_types перечисляет соответствующие метки.

Сущности, которые вы намеренно отфильтровали, учитываются отдельно — в filtered_out_count.

Требования: платный тариф и включённые ИИ-функции вашей организации (по умолчанию включены; администратор организации может отключить их в разделе «Настройки → ИИ и интеграции»). Вызовы также отклоняются, когда ваша организация достигает дневного лимита использования ИИ или пока Waafir приостановил эту функцию; сообщение об ошибке указывает, что именно произошло.

redact_file

Анализ целого документа в комнате данных на наличие PII. Инструмент только анализирует — документ не меняется, и ничьё представление о нём тоже. Анализ асинхронный; опрашивайте redact_file_status.

Входные данные

ПолеТипОбязательноОписание
file_idstringдаUUID файла.
override_redactedbooleanнетПовторно проанализировать документ, в котором данные уже скрыты. Без этого параметра файл, в котором данные уже скрыты, отклоняется.

Выходные данные

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

Параметра auto_apply нет — так задумано; см. примечание в начале этой страницы. Файлы изображений не поддерживаются.

Требования: PAT с областью доступа write, членство в команде сделки комнаты данных, платный тариф и включённые ИИ-функции вашей организации (по умолчанию включены; администратор организации может отключить их в разделе «Настройки → ИИ и интеграции»).

Файл, который ещё проверяется. Если файл — новая загрузка или новая версия, проверку которой Waafir ещё не завершил, redact_file и redact_apply отвечают UNAVAILABLE с error.reason: "ACTIVATION_PENDING" и сообщением This file is still being checked. Try again shortly. Ничего не анализируется и не применяется; вызовите инструмент снова после короткой паузы.

redact_file_status

Проверка анализа скрытия данных в документе.

Входные данные

ПолеТипОбязательноОписание
file_idstringдаUUID файла.

Выходные данные

{ file_id, status, entity_count?, applied: false, apply_via }
  • status — одно из значений idle, analyzing, applying, review_ready, completed, failed, error. applying и completed описывают скрытие данных, которое применяет человек в интерфейсе Waafir, — из MCP вы не можете их вызвать, но увидите их, если кто-то одобрит проверку, пока вы опрашиваете статус.
  • entity_count — сколько сущностей PII предложил анализ, когда проверка готова.
  • applied всегда равно false: одобрение и применение скрытия данных происходят в интерфейсе Waafir.

Считайте нераспознанный status сигналом «продолжайте опрос», а не ошибкой. Конечные состояния хранятся лишь недолго, после чего маркер задания очищается, поэтому опрашивающий клиент, пришедший поздно, видит idle (или восстановленный review_ready), а не состояние, которого он ждал, — и idle означает «нет выполняющегося задания», а не «ничего никогда не происходило». Опрашивайте до нужного состояния с крайним сроком, а не проверяйте, входит ли значение в фиксированный список.

redact_history

Последний анализ скрытия данных файла в виде количества по типам сущностей. Сам текст со скрытыми данными никогда не возвращается.

  • Область доступа: read. Участники команды сделки, для файла, содержимое которого им разрешено читать.
  • Входные данные: file_id (обязательно).
  • Выходные данные: { file_id, analysis }. analysis — это { history_id, analysed_at, entities: { total, by_type } } или null, если файл никогда не анализировался.

redact_list_terms

Термины скрытия данных комнаты данных: фразы, которые скрываются всегда (always), и фразы, которые не скрываются никогда (never).

  • Область доступа: read. Участники команды сделки.
  • Входные данные: dataroom_id (обязательно).
  • Выходные данные: { terms }, каждый — { id, term, kind, created_at }.

redact_add_term

Добавление термина в комнату данных. Он применяется при следующем скрытии данных в файле этой комнаты и сейчас ни один файл не меняет.

  • Область доступа: write. Участники команды сделки, на платном тарифе.
  • Входные данные: dataroom_id, term (оба обязательны); kind (always или never, по умолчанию always).
  • Выходные данные: { term }.

redact_remove_term

Удаление термина из комнаты данных. Сейчас это не меняет ни одного файла; повторное добавление термина отменяет удаление.

  • Область доступа: write. Участники команды сделки.
  • Входные данные: dataroom_id, term_id (оба обязательны).
  • Выходные данные: { removed, term_id }.

redact_revert

Отмена скрытия данных в файле. Каждому читателю, включая инвесторов, сразу же снова отдаётся исходный документ. Версия со скрытыми данными сохраняется, поэтому её можно применить повторно.

  • Область доступа: write. Участники команды сделки, для файла, который им разрешено редактировать.
  • Входные данные: file_id (обязательно); confirm_token.
  • Два шага. Без confirm_token ничего не меняется, и вы получаете предпросмотр и токен. Вызовите инструмент снова с теми же аргументами и токеном, чтобы выполнить отмену.
  • Файл, в котором данные не скрыты, отклоняется (409). Так же отклоняется файл, для которого выполняется анализ или выжигание (409): вам сообщают об этом на этапе предпросмотра, поэтому токен для отмены, которая не может быть выполнена, не выдаётся, а проверка повторяется при подтверждении.

redact_apply

Применение последнего анализа файла из redact_file за вычетом исключённых вами типов сущностей и с добавлением терминов «скрывать всегда» комнаты данных. После этого каждому читателю, включая инвесторов, отдаётся документ со скрытыми данными. redact_revert отменяет это.

  • Область доступа: write. Участники команды сделки, на платном тарифе, для файла, содержимое которого им разрешено читать.
  • Входные данные: file_id (обязательно); exclude_types; confirm_token.
  • Два шага. Без confirm_token ничего не меняется, и вы получаете предпросмотр (цели, подсчитанные по типам, — никогда не сам текст) и токен. Вызовите инструмент снова с теми же аргументами и токеном, чтобы запустить выжигание. Если за это время изменились анализ, файл, термины комнаты или цели, вызов отклоняется, и вы снова получаете предпросмотр.
  • Если ИИ отключён для вашей организации, применить можно только сохранённые термины «скрывать всегда» комнаты, как и в Waafir.