Skip to content

docs: describe trajectory-context trusted metadata #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bbednarski9 wants to merge 1 commit into from
+22 −0
Closed

docs: describe trajectory-context trusted metadata #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/about-nemo-relay/release-notes/known-issues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 13 additions & 0 deletions docs/configure-plugins/pii-redaction/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Warning>
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).
</Warning>

### CLI Editor Support

The NeMo Relay CLI plugin editor now exposes `pii_redaction` directly through
Expand Down
Loading