From 106a5dcb2a72f14ca65757abbd216e3a3df510ee Mon Sep 17 00:00:00 2001 From: Bryan Bednarski Date: Tue, 21 Jul 2026 23:48:05 -0600 Subject: [PATCH] docs: document trajectory-context metadata limitation Signed-off-by: Bryan Bednarski --- .../about-nemo-relay/release-notes/known-issues.mdx | 9 +++++++++ .../pii-redaction/configuration.mdx | 13 +++++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/about-nemo-relay/release-notes/known-issues.mdx b/docs/about-nemo-relay/release-notes/known-issues.mdx index ad638d561..93c626c18 100644 --- a/docs/about-nemo-relay/release-notes/known-issues.mdx +++ b/docs/about-nemo-relay/release-notes/known-issues.mdx @@ -56,6 +56,15 @@ The following limitations and migration steps apply to NVIDIA NeMo Relay 0.6. 3.11 or newer and `nemoguardrails==0.22.0`. - The PII redaction plugin currently supports its deterministic local backend. Local-model backend configuration is reserved for future work. +- The `trajectory_context` PII preset can replace string-valued classification + fields in generic scope metadata when those fields are not part of its + analytical allowlist. Affected fields include `nemo_relay_scope_role`, + `hook_event_name`, and harness-provided `agent_kind`. This can make explicit + agent-role or harness classification unavailable even though the event keys + and scope topology remain. `custom_mark_payload_policy` does not control + scope metadata, and profile-array mode cannot exclude generic scopes while + retaining both LLM and tool sanitization. Track the correction in + [GitHub issue #528](https://github.com/NVIDIA/NeMo-Relay/issues/528). - Pricing and optimization estimates are only as complete as the model name, token data, pricing source, and freshness evidence that Relay receives. When evidence is missing or inconsistent, cost fields remain partial or absent diff --git a/docs/configure-plugins/pii-redaction/configuration.mdx b/docs/configure-plugins/pii-redaction/configuration.mdx index 329f78892..e94f62c01 100644 --- a/docs/configure-plugins/pii-redaction/configuration.mdx +++ b/docs/configure-plugins/pii-redaction/configuration.mdx @@ -173,6 +173,19 @@ surface flags. Profile-array configurations intentionally do not expose those flags: every enabled profile owns the complete pre-subscriber sanitization boundary. + +The `trajectory_context` preset currently applies its analytical-field +allowlist to generic scope metadata. String-valued classification fields that +are not on that allowlist, including `nemo_relay_scope_role`, +`hook_event_name`, and harness-provided `agent_kind`, can be replaced with the +configured redaction token. `custom_mark_payload_policy` affects unknown +custom Mark payloads, not Scope metadata. + +Profile-array mode does not currently provide a way to preserve generic scope +metadata while retaining both LLM and tool sanitization. Track this limitation +in [GitHub issue #528](https://github.com/NVIDIA/NeMo-Relay/issues/528). + + ### CLI Editor Support The NeMo Relay CLI plugin editor now exposes `pii_redaction` directly through