Skip to content

docs(TSP-1348): add deletion audit events to streaming-events page#722

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1348
Open

docs(TSP-1348): add deletion audit events to streaming-events page#722
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1348

Conversation

@claude

@claude claude Bot commented Jul 15, 2026

Copy link
Copy Markdown

Summary

  • Adds new conversation_deleted audit event — fires when an agent conversation is deleted (single deletions from the chat app and bulk deletions)
  • Adds new workforce_task_deleted audit event — now covers chat-app deletions in addition to the previously documented bulk Workforce UI deletions
  • Adds workforce_type field to the workforce_deleted event — distinguishes direct deletions from cascade deletions triggered by deleting a chat task

Context

PR relevance-api-node#16143 closed major gaps in customer-facing OpenTelemetry audit event coverage for deletion operations. Customers with active OTel integrations were previously missing these events. This docs update reflects the new coverage.

Linear: https://linear.app/relevance/issue/TSP-1348/

Test plan

  • Verify conversation_deleted section follows the same structure as other event types
  • Verify workforce_task_deleted appears under Workforce events
  • Verify workforce_type is correctly added to the workforce_deleted table
  • Check all headings are sentence case
  • No broken links introduced

🤖 Generated with Claude Code

- Add new `conversation_deleted` event (single and bulk, chat app)
- Add new `workforce_task_deleted` event (now covers chat app deletions, not just bulk Workforce UI deletes)
- Add `workforce_type` field to `workforce_deleted` event (direct vs cascade)

Closes gap where customers with active OTel integrations were missing deletion events.
References: TSP-1348, RelevanceAI/relevance-api-node#16143

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Jul 15, 2026
@linear

linear Bot commented Jul 15, 2026

Copy link
Copy Markdown

TSP-1348

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Title and sidebarTitle use title case; ## PII Redaction heading has wrong casing; "agent", "tool", and "workforce" appear lowercase throughout event and span descriptions when they should be capitalized as Relevance AI product terms.
🟢 Technical clarity 8/10 The jsonl_to_otel_json transformation is listed as a PII redaction prerequisite with no explanation of what it is or how to apply it. Setup section asks readers to contact support without a link to /get-started/support.
🟢 Non-technical clarity 8/10 The "scrub before delivery" analogy and the PII/prompt injection plain-English intros are effective. Opening OTEL explanation is sufficient for most readers.
🟡 Structure 7/10 PII redaction section puts Prerequisites after detailed content (entity list, redaction actions). Two numbered bold-text labels (**1. Structured fields**, **2. Unstructured text**) should be proper headings. <CardGroup> used for a technical entity-type reference list where it adds no value.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The page is a solid, comprehensive technical reference — it covers setup, PII redaction, prompt injection detection, and span/log schemas with enough detail for an engineering team to get up and running. The main gaps are capitalization consistency (agent/tool/workforce product terms are lowercase throughout the new deletion-event sections) and a couple of structural choices that make the PII section harder to scan than it needs to be.

🔧 Issues (6)
  • enterprise/streaming-events.mdx:2 — Title "Event Streaming for Observability (OpenTelemetry)" uses title case → sentence case: "Event streaming for observability (OpenTelemetry)". "OpenTelemetry" stays capitalized as a product name.
  • enterprise/streaming-events.mdx:3 — sidebarTitle "Event Streaming (OpenTelemetry)""Event streaming (OpenTelemetry)"
  • enterprise/streaming-events.mdx:88 — Heading ## PII Redaction (Enterprise feature)## PII redaction (Enterprise feature). "Redaction" is not a proper noun.
  • enterprise/streaming-events.mdx:250–563 — "agent", "tool", and "workforce" appear consistently lowercase in event and span descriptions (e.g. "Emitted when a new agent is created", "a tool is permanently deleted", "Records a complete workforce execution"). These refer to Relevance AI product features and should be "Agent", "Tool", "Workforce". This pattern runs through every event description in the Agent events, Tool events, Workforce events, and Traces sections, as well as line 415 ("Traces track execution flows for agents, workforces").
  • enterprise/streaming-events.mdx:76 — "Contact your Relevance team for the region-specific IAM role ARN" — link to /get-started/support rather than leaving the contact method implicit.
  • enterprise/streaming-events.mdx:148–150 — PII redaction Prerequisites lists "jsonl_to_otel_json transformation" with no explanation of what it is, how to apply it, or where to find documentation for it. This will block readers who haven't been walked through setup by the Relevance team.
🧩 Component suggestions (2)
  • enterprise/streaming-events.mdx:120–131<CardGroup cols={3}> is used to list ten PII entity type identifiers (EMAIL_ADDRESS, PHONE_NUMBER, PERSON, etc.). These are named constants in a technical reference, not navigable destinations or feature choices. <CardGroup> is appropriate for parallel navigable items; a bulleted code list or two-column table (entity type + example) would be more appropriate here and less visually noisy.

  • enterprise/streaming-events.mdx:100,108**1. Structured fields (always scrubbed automatically)** and **2. Unstructured text (scrubbed when PII redaction is enabled for your org)** are bold labels acting as section headers. CLAUDE.md says not to mix bold with heading formats for section titles — use #### headings instead.

🏗️ Page structure (1)
  • enterprise/streaming-events.mdx:98–162 — The PII redaction section follows this order: What gets redacted → Supported PII entities → Redaction actions → Prerequisites → Configuration. Prerequisites appear after three subsections of content they're supposed to gate. Move ### Prerequisites to the top of the ## PII redaction section so readers know upfront what they need before absorbing the entity-type details.
✅ Clean files (0)

No fully clean files — only one file reviewed.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~1,001

Files read: enterprise/streaming-events.mdx (612 lines), enterprise/data-retention.mdx (389 lines — linked page), enterprise/analytics.mdx (166 lines — sibling)

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jul 15, 2026, 4:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟡 Building Jul 15, 2026, 4:43 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant