Skip to content

Commit 8fc4bdf

Browse files
committed
fix: use native AG-UI reasoning events instead of CustomEvent
Address review feedback from @robinsk: - Replace CustomEvent(name="text_reasoning") with the protocol-defined ReasoningStartEvent, ReasoningMessageStartEvent, ReasoningMessageContentEvent, ReasoningMessageEndEvent, ReasoningEndEvent sequence so AG-UI consumers like CopilotKit can render reasoning natively. - Remove unused `flow` parameter from `_emit_text_reasoning` (addresses @moonbox3 feedback). - Use only content.text for display; protected_data is no longer conflated with visible text.
1 parent 8122740 commit 8fc4bdf

1 file changed

Lines changed: 30 additions & 17 deletions

File tree

‎python/packages/ag-ui/agent_framework_ag_ui/_run_common.py‎

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@
1212
from ag_ui.core import (
1313
BaseEvent,
1414
CustomEvent,
15+
ReasoningEndEvent,
16+
ReasoningMessageContentEvent,
17+
ReasoningMessageEndEvent,
18+
ReasoningMessageStartEvent,
19+
ReasoningStartEvent,
1520
RunFinishedEvent,
1621
StateSnapshotEvent,
1722
TextMessageContentEvent,
@@ -458,29 +463,37 @@ def _emit_mcp_tool_result(content: Content, flow: FlowState) -> list[BaseEvent]:
458463

459464

460465
def _emit_text_reasoning(content: Content) -> list[BaseEvent]:
461-
"""Emit a custom event for text_reasoning content.
462-
463-
AG-UI protocol does not define a dedicated reasoning event type, so we emit
464-
a ``CustomEvent`` with ``name="text_reasoning"``. This makes reasoning /
465-
chain-of-thought progress visible to frontends that listen for custom events,
466-
following the same pattern used by ``_emit_usage``.
466+
"""Emit AG-UI reasoning events for text_reasoning content.
467+
468+
Uses the protocol-defined reasoning event types (``ReasoningStartEvent``,
469+
``ReasoningMessageStartEvent``, ``ReasoningMessageContentEvent``,
470+
``ReasoningMessageEndEvent``, ``ReasoningEndEvent``) so that AG-UI consumers
471+
such as CopilotKit can render reasoning natively.
472+
473+
Only ``content.text`` is used for the visible reasoning message. If
474+
``content.protected_data`` is present it is forwarded as the
475+
``encrypted_value`` field on the ``ReasoningMessageEndEvent`` so that
476+
consumers can persist it for state continuity without conflating it
477+
with display text.
467478
"""
468-
# Only emit user-visible text from content.text. Do not fall back to
469-
# protected_data as text, since protected_data may contain non-display
470-
# payloads such as provider-specific reasoning metadata.
471479
text = content.text or ""
472480
if not text and content.protected_data is None:
473481
return []
474482

475-
value: dict[str, Any] = {"text": text}
476-
# Expose protected_data under a separate key so consumers can decide
477-
# whether/how to render it, without conflating it with display text.
478-
if content.protected_data is not None:
479-
value["protected_data"] = content.protected_data
480-
if content.id:
481-
value["id"] = content.id
483+
message_id = content.id or generate_event_id()
484+
485+
events: list[BaseEvent] = [
486+
ReasoningStartEvent(),
487+
ReasoningMessageStartEvent(message_id=message_id, role="reasoning"),
488+
]
489+
490+
if text:
491+
events.append(ReasoningMessageContentEvent(message_id=message_id, delta=text))
482492

483-
return [CustomEvent(name="text_reasoning", value=value)]
493+
events.append(ReasoningMessageEndEvent(message_id=message_id))
494+
events.append(ReasoningEndEvent())
495+
496+
return events
484497

485498

486499
def _emit_content(

0 commit comments

Comments
 (0)