Skip to content

Commit 509e00e

Browse files
committed
document activity messages
1 parent d5f0474 commit 509e00e

File tree

4 files changed

+6
-304
lines changed

4 files changed

+6
-304
lines changed

docs/concepts/events.mdx

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -459,11 +459,12 @@ incrementally update it as new information arrives.
459459

460460
Delivers a complete snapshot of an activity message.
461461

462-
| Property | Description |
463-
| --------------- | ---------------------------------------------------------------- |
464-
| `messageId` | Identifier for the `ActivityMessage` this event updates |
465-
| `activityType` | Activity discriminator (for example `"PLAN"`, `"SEARCH"`) |
466-
| `content` | Structured JSON payload representing the full activity state |
462+
| Property | Description |
463+
| --------------- | -------------------------------------------------------------------------------------------- |
464+
| `messageId` | Identifier for the `ActivityMessage` this event updates |
465+
| `activityType` | Activity discriminator (for example `"PLAN"`, `"SEARCH"`) |
466+
| `content` | Structured JSON payload representing the full activity state |
467+
| `replace` | Optional. Defaults to `true`. When `false`, ignore the snapshot if the message already exists |
467468

468469
Frontends should either create a new `ActivityMessage` or replace the existing
469470
one with the payload supplied by the snapshot.
@@ -529,33 +530,6 @@ implementation across frontends and agents.
529530

530531
These events are currently in draft status and may change before finalization. They represent proposed extensions to the protocol that are under active development and discussion.
531532

532-
### Activity Events
533-
534-
<span style={{backgroundColor: '#3b82f6', color: 'white', padding: '2px 6px', borderRadius: '4px', fontSize: '0.75em', fontWeight: 'bold'}}>DRAFT</span> [View Proposal](/drafts/activity-events)
535-
536-
Activity events represent ongoing agent progress between chat messages, allowing frameworks to surface fine-grained activity updates chronologically.
537-
538-
#### ActivitySnapshotEvent
539-
540-
Provides the complete activity state at a point in time.
541-
542-
| Property | Description |
543-
| -------------- | ---------------------------------------------------- |
544-
| `messageId` | Unique identifier for the ActivityMessage |
545-
| `activityType` | Activity type (e.g., "PLAN", "SEARCH", "SCRAPE") |
546-
| `content` | Complete activity state at this point |
547-
| `replace` | `true` (default) replaces an existing activity message; `false` only creates a new one if none exists |
548-
549-
#### ActivityDeltaEvent
550-
551-
Provides incremental updates to the activity state using JSON Patch operations.
552-
553-
| Property | Description |
554-
| -------------- | ---------------------------------------------------- |
555-
| `messageId` | Unique identifier for the ActivityMessage |
556-
| `activityType` | Activity type (e.g., "PLAN", "SEARCH", "SCRAPE") |
557-
| `patch` | JSON Patch operations (RFC 6902) to apply |
558-
559533
### Reasoning Events
560534

561535
<span style={{backgroundColor: '#3b82f6', color: 'white', padding: '2px 6px', borderRadius: '4px', fontSize: '0.75em', fontWeight: 'bold'}}>DRAFT</span> [View Proposal](/drafts/reasoning)

docs/docs.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@
5151
"group": "Draft Proposals",
5252
"pages": [
5353
"drafts/overview",
54-
"drafts/activity-events",
5554
"drafts/reasoning",
5655
"drafts/multimodal-messages",
5756
"drafts/interrupts",

docs/drafts/activity-events.mdx

Lines changed: 0 additions & 262 deletions
This file was deleted.

docs/drafts/overview.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,6 @@ This section contains draft changes being considered for the AG-UI protocol. The
1010
## Current Drafts
1111

1212
<CardGroup cols={2}>
13-
<Card
14-
title="Activity Events"
15-
href="/drafts/activity-events"
16-
icon="file-lines"
17-
color="#3B82F6"
18-
iconType="light"
19-
>
20-
Represent ongoing agent progress between chat messages with fine-grained activity updates
21-
</Card>
2213
<Card
2314
title="Reasoning"
2415
href="/drafts/reasoning"

0 commit comments

Comments
 (0)