Skip to content

Commit 1f4500f

Browse files
committed
wip
1 parent 954b18a commit 1f4500f

File tree

7 files changed

+7
-103
lines changed

7 files changed

+7
-103
lines changed

docs/drafts/activity-events.mdx

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ AG-UI is extended with **ActivityEvents** and **ActivityMessages** to represent
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Background
2222

@@ -154,10 +154,6 @@ Python SDK additions:
154154
- **Workflow Systems**: Can surface step-by-step workflow progress as ActivityEvents
155155
- **Other frameworks**: May emit ActivityEvents freely; AG-UI will serialize them like other events
156156
157-
## Breaking Changes
158-
159-
None. This is an additive change that maintains backward compatibility.
160-
161157
## Examples and Use Cases
162158
163159
### Example 1: Web Search Activity
@@ -205,13 +201,6 @@ Each step appears inline with chat, giving users real-time feedback.
205201
- E2E tests in AG-UI Dojo demonstrating activity rendering
206202
- Performance benchmarks for high-frequency activity updates
207203

208-
## Open Questions
209-
210-
1. Should we enforce a schema for common activity types (e.g., standardized "PLAN" format)?
211-
2. How should activities behave across run boundaries?
212-
3. Should there be a maximum number of patches before requiring a new snapshot?
213-
4. How do activities interact with message editing/regeneration?
214-
215204
## References
216205

217206
- [JSON Patch RFC 6902](https://tools.ietf.org/html/rfc6902)

docs/drafts/generative-ui.mdx

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This draft describes an AG-UI extension that addresses **generative user interfa
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Challenges and Limitations
2222

@@ -275,10 +275,6 @@ Python SDK additions:
275275
- Frameworks emit standard tool calls; client handles UI generation
276276
- Backward compatible with existing tool-based UI approaches
277277

278-
## Breaking Changes
279-
280-
None. This is an additive change that maintains backward compatibility.
281-
282278
## Use Cases
283279

284280
### Dynamic Forms
@@ -301,14 +297,6 @@ Generate different UI layouts based on user preferences or device capabilities.
301297
- Performance benchmarks comparing single vs. two-step generation
302298
- Cross-provider compatibility testing
303299

304-
## Open Questions
305-
306-
1. Should we standardize a set of common UI generators?
307-
2. How to handle UI state management across regenerations?
308-
3. Should generators support streaming UI updates?
309-
4. What's the optimal size/capability for the secondary generation model?
310-
5. How to ensure generated UIs are accessible and follow best practices?
311-
312300
## References
313301

314302
- [AG-UI Tools Documentation](/concepts/tools)

docs/drafts/interrupts.mdx

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Support **human-in-the-loop pauses** (and related mechanisms) natively in AG-UI
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Overview
2222

@@ -210,12 +210,6 @@ Python SDK:
210210
- Clear indication of pending interrupts
211211
- History of interrupt/resume actions
212212

213-
## Breaking Changes
214-
215-
None. This is an additive change with backward compatibility:
216-
- Omitting `outcome` field maintains existing behavior
217-
- Clients not supporting interrupts can treat them as regular run completions
218-
219213
## Testing Strategy
220214

221215
- Unit tests for interrupt/resume serialization
@@ -224,15 +218,6 @@ None. This is an additive change with backward compatibility:
224218
- State consistency tests across interrupt boundaries
225219
- Performance tests for rapid interrupt/resume cycles
226220

227-
## Open Questions
228-
229-
1. Should we define standard interrupt reasons (enum vs. free string)?
230-
2. How to handle timeout for unanswered interrupts?
231-
3. Should interrupts support priority levels?
232-
4. Can multiple interrupts be pending simultaneously?
233-
5. How to handle interrupt cancellation?
234-
6. Should we support batch approval of multiple interrupts?
235-
236221
## References
237222

238223
- [AG-UI Events Documentation](/concepts/events)

docs/drafts/meta-events.mdx

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ AG-UI is extended with **MetaEvents**, a new class of events that can occur at a
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Detailed Specification
2222

@@ -215,29 +215,13 @@ Python SDK:
215215
- Consider permissions for who can create certain meta event types
216216
- Sanitize payload content to prevent injection attacks
217217
218-
## Breaking Changes
219-
220-
None. This is an additive change:
221-
- New event type doesn't affect existing event processing
222-
- Clients not handling MetaEvents can safely ignore them
223-
- No changes to existing event schemas
224-
225218
## Testing Strategy
226219
227220
- Unit tests for MetaEvent creation and validation
228221
- Integration tests with mixed event streams
229222
- Performance tests with high-volume meta events
230223
- Security tests for payload validation
231224
232-
## Open Questions
233-
234-
1. Should we define a standard set of metaType values?
235-
2. How to handle MetaEvent permissions and authorization?
236-
3. Should MetaEvents support references to multiple entities?
237-
4. What's the maximum payload size for MetaEvents?
238-
5. Should we support MetaEvent versioning?
239-
6. How to handle MetaEvent conflicts (e.g., multiple ratings)?
240-
241225
## References
242226
243227
- [AG-UI Events Documentation](/concepts/events)

docs/drafts/multimodal-messages.mdx

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Evolve AG-UI to support **multimodal input messages** without breaking existing
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Detailed Specification
2222

@@ -231,13 +231,6 @@ Frameworks need to:
231231
- Sanitize URLs to prevent SSRF attacks
232232
- Consider content scanning for malicious files
233233

234-
## Breaking Changes
235-
236-
None. This is a backward-compatible change:
237-
- String content continues to work as before
238-
- Clients not supporting multimodal content can treat array content as text-only
239-
- Frameworks can gracefully degrade for unsupported content types
240-
241234
## Use Cases
242235

243236
### Visual Question Answering
@@ -263,15 +256,6 @@ Share screenshots for UI/UX feedback or debugging assistance.
263256
- Performance tests for large binary payloads
264257
- Security tests for content validation and sanitization
265258

266-
## Open Questions
267-
268-
1. Should we define a maximum size for inline base64 content?
269-
2. How to handle content type negotiation with different LLM providers?
270-
3. Should we support streaming for large binary content?
271-
4. What MIME types should be officially supported?
272-
5. How to handle content expiration for URL references?
273-
6. Should we support content compression?
274-
275259
## References
276260

277261
- [OpenAI Vision API](https://platform.openai.com/docs/guides/vision)

docs/drafts/reasoning.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ AG-UI should support **LLM reasoning** without breaking existing apps.
1919
## Status
2020

2121
- **Status**: Draft
22-
- **Author(s)**: AG-UI Team
22+
- **Author(s)**: Markus Ecker ([email protected])
2323

2424
## Detailed Specification
2525

@@ -254,16 +254,7 @@ Meet data retention requirements while preserving reasoning capabilities.
254254
- Encryption/decryption roundtrip tests
255255
- Performance tests for reasoning event streaming
256256

257-
## Open Questions
258-
259-
1. Should reasoning messages be included in `MESSAGES_SNAPSHOT` by default?
260-
2. How to handle partial reasoning in case of interruptions?
261-
3. Should we support different reasoning visibility levels (none, summary, full)?
262-
4. What's the maximum size for encrypted reasoning content?
263-
5. Should reasoning events support metadata (e.g., reasoning type, complexity)?
264-
265257
## References
266258

267259
- [AG-UI Events Documentation](/concepts/events)
268260
- [AG-UI Messages Documentation](/concepts/messages)
269-
- [Chain-of-Thought Prompting](https://arxiv.org/abs/2201.11903)

docs/drafts/serialization.mdx

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ AG-UI adds **stream serialization** to reload chat history and attach to active
1616
## Status
1717

1818
- **Status**: Draft
19-
- **Author(s)**: AG-UI Team
19+
- **Author(s)**: Markus Ecker ([email protected])
2020

2121
## Detailed Specification
2222

@@ -222,14 +222,6 @@ Python SDK:
222222
- Compression support for serialized streams
223223
- Indexing strategies for quick access
224224

225-
## Breaking Changes
226-
227-
None. This is an additive change:
228-
- Existing events remain valid
229-
- New fields are optional
230-
- Compaction is opt-in
231-
- Backward compatible with existing streams
232-
233225
## Testing Strategy
234226

235227
- Unit tests for compaction algorithm
@@ -238,15 +230,6 @@ None. This is an additive change:
238230
- Performance benchmarks for large event streams
239231
- Storage adapter integration tests
240232

241-
## Open Questions
242-
243-
1. Should compaction be automatic or explicit?
244-
2. What's the optimal compaction strategy for different use cases?
245-
3. How to handle conflicts in branched conversations?
246-
4. Should we support custom compaction rules?
247-
5. How to handle event versioning for long-term storage?
248-
6. Should we provide built-in storage adapters?
249-
250233
## References
251234

252235
- [Event Sourcing](https://martinfowler.com/eaaDev/EventSourcing.html)

0 commit comments

Comments
 (0)