Skip to content

docs(TSP-1339): add conversation_deleted and workforce_task_deleted audit events#709

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

docs(TSP-1339): add conversation_deleted and workforce_task_deleted audit events#709
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1339

Conversation

@claude

@claude claude Bot commented Jul 10, 2026

Copy link
Copy Markdown

Summary

  • Added conversation_deleted OTEL audit log event under Agent events: fires when agent conversations are deleted individually or in bulk (each deletion is a separate event). Gated by existing per-org customer_otel configuration.
  • Added workforce_task_deleted OTEL audit log event under Workforce events: fires when workforce tasks are deleted via the workforce UI, the chat interface, or automated data retention policies. Also gated by customer_otel configuration.

Both are fire-and-forget events. Changes are based on PR #16143 in relevance-api-node.

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

…udit events

Add conversation_deleted OTEL audit event that fires when agent conversations are
deleted (single or bulk). Also document workforce_task_deleted, which now fires
from the workforce UI, the chat interface, and automated data retention policies.

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

linear Bot commented Jul 10, 2026

Copy link
Copy Markdown

TSP-1339

@mintlify

mintlify Bot commented Jul 10, 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 10, 2026, 4:57 AM

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

@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 6/10 Title and sidebarTitle use title case instead of sentence case; ## PII Redaction heading has wrong case; Agent, Tool, and Workforce are consistently lowercased throughout event descriptions despite being Relevance AI product terms.
🟢 Technical clarity 8/10 One genuine gap: the jsonl_to_otel_json prerequisite is mentioned with no explanation or path to configure it. Everything else is sharp.
🟢 Non-technical clarity 8/10 Intro and OTEL explanation are clear. PII prerequisites section will confuse non-technical admins who hit jsonl_to_otel_json with no context.
🟡 Structure 7/10 Event subsections ("Agent events", "Tool events", etc.) and span subsections (invoke_agent, chat, etc.) are at the same heading level as their parent sections — hierarchy is broken. CardGroup is misused for a flat entity-name reference list.

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

Overall vibe: The content itself is genuinely good — clear technical descriptions, well-structured attribute tables, and the migration warnings for the llm_completion rename and gen_ai.tool.definitions type change are exactly the right calls. The issues are mechanical: heading casing needs a pass (title, sidebarTitle, and one section heading), product terms need consistent capitalization throughout the event descriptions, and the heading hierarchy under "Supported events" and "Supported spans" needs a level bump to properly nest the subsections.

🔧 Issues (5)
  • enterprise/streaming-events.mdx:2 — title "Event Streaming for Observability (OpenTelemetry)" violates sentence case. Should be "Event streaming for observability (OpenTelemetry)". ("OpenTelemetry" stays capitalized as a proper noun.)

  • enterprise/streaming-events.mdx:3 — sidebarTitle "Event Streaming (OpenTelemetry)""Event streaming (OpenTelemetry)"

  • enterprise/streaming-events.mdx:88## PII Redaction (Enterprise feature)## PII redaction (Enterprise feature). "Redaction" is not a proper noun.

  • enterprise/streaming-events.mdx:250–411 — Agent, Tool, and Workforce are Relevance AI product terms and must be capitalized when referring to the product features. Throughout the event descriptions, they're consistently lowercased: "Emitted when a new agent is created" (line 250), "Emitted when an agent's configuration is updated" (259), "Emitted when a tool is permanently deleted" (303), "Emitted when a workforce task is deleted" (354), "Traces track execution flows for agents, workforces" (411), and so on. This is pervasive — every event description in the Logs section and the Traces intro is affected. Fix all instances.

  • enterprise/streaming-events.mdx:149 — The PII Redaction prerequisite "jsonl_to_otel_json transformation is applied" drops a jargon term with no explanation of what this transformation is, how to enable it, or where it's configured. A reader setting up PII redaction for the first time has no path forward. Either explain it inline or link to the relevant configuration step.

🧩 Component suggestions (3)
  • enterprise/streaming-events.mdx:120–131<CardGroup cols={3}> is used for 10 PII entity type names (EMAIL_ADDRESS, PHONE_NUMBER, etc.) with only an icon and no description on any card. These are a flat technical reference list, not navigable options or feature choices — exactly the use case CLAUDE.md says CardGroup is not appropriate for. Replace with a simple bullet list or a single-column table. A bullet list is probably all this needs: readers are scanning for whether their entity type is supported, not choosing between options.

  • enterprise/streaming-events.mdx:247–289### Agent events, ### Tool events, ### Workforce events, and ### Permission events are ### (h3), the same level as their parent ### Supported events (line 245). They're clearly subsections. Demote to #### so the hierarchy reads: h2 Logs → h3 Supported events → h4 Agent events → h4 Tool events, etc.

  • enterprise/streaming-events.mdx:491–578 — Same problem under ### Supported spans (line 489): ### \invoke_agent`, ### `chat`, ### `multi_agent_system_trigger`, and ### `condition_trigger`are all h3 alongside their parent. Demote to####`.

⚠️ Contradictions (0)

No contradictions found. The 30-day staging bucket purge description in streaming-events.mdx:28 is consistent with the matching description in data-retention.mdx:312 and data-retention.mdx:354.

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

Files read: enterprise/streaming-events.mdx (608 lines), enterprise/data-retention.mdx (389 lines), enterprise/analytics.mdx (166 lines)

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