Skip to content
Draft
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions enterprise/streaming-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
You don't need to run an OTEL collector to use this feature. Events are delivered directly to your S3 bucket where you can:

- Query them directly using Athena, BigQuery, or similar tools
- Ingest into your data lake (Snowflake, Databricks, etc.)

Check warning on line 21 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L21

Did you really mean 'Databricks'?
- Forward to any OTEL-compatible backend for visualization and alerting

<Note>Enterprise customers can enable PII redaction to automatically protect sensitive information in logs. Contact your Account Manager to learn more.</Note>
Expand Down Expand Up @@ -282,6 +282,15 @@
| `relevance_ai.event.agent_id` | string | Yes | ID of the agent being published |
| `relevance_ai.event.version_id` | string | Yes | ID of the version now live |

### Conversation events

**`conversation_deleted`** - Emitted when an agent conversation is permanently deleted, either individually or as part of a bulk deletion. Each deleted conversation produces a separate event.

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `relevance_ai.event.conversation_id` | string | Yes | ID of the deleted conversation. Matches `gen_ai.conversation.id` on `invoke_agent` spans |
| `relevance_ai.event.agent_id` | string | No | ID of the agent the conversation belonged to, when known |

### Tool events

**`tool_created`** - Emitted when a new tool is created (from scratch or cloned).
Expand Down Expand Up @@ -329,6 +338,13 @@
| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `relevance_ai.event.workforce_id` | string | Yes | ID of the deleted workforce |
| `relevance_ai.event.workforce_type` | string | No | The workforce's configured type, when known. `chat` workforces are auto-created wrappers around a single chat task and are deleted together with it, so their deletion is a side effect of deleting the task rather than a user action on the workforce itself |

**`workforce_task_deleted`** - Emitted when a workforce task is deleted, once per task (a bulk delete emits one event per task). Fires for deletions from the Workforce UI, deletions from the chat interface, and deletions performed by automated data retention policies. A workforce task is a single run of a workforce, which is distinct from an agent conversation.

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `relevance_ai.event.workforce_task_id` | string | Yes | ID of the deleted workforce task. Equals the `relevance_ai.workforce.workforce_task_id` attribute on multi-agent-system execution spans |

**`workforce_draft_saved`** - Emitted when work-in-progress changes are saved to a workforce.

Expand All @@ -344,6 +360,24 @@
| `relevance_ai.event.workforce_id` | string | Yes | ID of the workforce being published |
| `relevance_ai.event.version_id` | string | No | ID of the version now live |

### Trigger events

**`trigger_deleted`** - Emitted when a trigger is deleted from the project.

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `relevance_ai.event.trigger_id` | string | Yes | ID of the deleted trigger |
| `relevance_ai.event.trigger_type` | string | Yes | The trigger's configured type, for example `recurring`, `tool_trigger`, or `external_relay` |
| `relevance_ai.event.trigger_provider` | string | No | For triggers backed by an integration, the integration provider, for example `slack` or `gmail` |

### Knowledge events

**`knowledge_table_deleted`** - Emitted when a knowledge table is permanently deleted, once per table.

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `relevance_ai.event.knowledge_table_id` | string | Yes | ID of the deleted knowledge table. Matches entries in `relevance_ai.agent.knowledge_used` on `invoke_agent` spans |

### Permission events

**`project_user_role_updated`** - Emitted when a user's role within a project is updated. This occurs when an admin changes another user's access level in the project settings.
Expand Down Expand Up @@ -503,7 +537,7 @@

**Name**: `chat {model_name}`

<Warning>This span was previously named `llm_completion`. If you have existing dashboards or queries filtering on `gen_ai.operation.name = "llm_completion"` or span names containing `llm_completion`, update them to use `"chat"`. The rename aligns with the [OpenTelemetry GenAI semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/).</Warning>

Check warning on line 540 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L540

Did you really mean 'llm_completion'?

Check warning on line 540 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L540

Did you really mean 'llm_completion'?

Check warning on line 540 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L540

Did you really mean 'llm_completion'?

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
Expand All @@ -523,7 +557,7 @@

**Attribute**: `gen_ai.tool.definitions`

<Warning>`gen_ai.tool.definitions` was previously an array type (`arrayValue`). It is now a JSON string (`stringValue`). If you consume this field in your pipeline or queries, you need to call `JSON.parse()` on the value to work with the tool definitions as structured data. The content is identical - the same tool definitions are present, just serialized as a string for better compatibility across OTEL exporters and backends.</Warning>

Check warning on line 560 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L560

Did you really mean 'arrayValue'?

Check warning on line 560 in enterprise/streaming-events.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

enterprise/streaming-events.mdx#L560

Did you really mean 'stringValue'?

### `multi_agent_system_trigger`

Expand Down
Loading