Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

feat(agent): stream Agent V2 text output in plain runs (#43986)

Yunlu Wencfc2d96b56a3
diff --git a/api/core/workflow/nodes/agent_v2/agent_node.py b/api/core/workflow/nodes/agent_v2/agent_node.py
index 8d5c30a33b1..f74d44e5012 100644
--- a/api/core/workflow/nodes/agent_v2/agent_node.py
+++ b/api/core/workflow/nodes/agent_v2/agent_node.py
@@ -32,7 +32,7 @@ from graphon.enums import (
WorkflowNodeExecutionStatus,
)
from graphon.graph_events import NodeRunPauseRequestedEvent
-from graphon.node_events import NodeEventBase, NodeRunResult, StreamCompletedEvent
+from graphon.node_events import NodeEventBase, NodeRunResult, StreamChunkEvent, StreamCompletedEvent
from graphon.nodes.base.node import Node
from graphon.nodes.base.variable_template_parser import VariableTemplateParser
from models.agent_config_entities import WorkflowNodeJobConfig, WorkflowOutputRoutes
@@ -64,7 +64,8 @@ logger = logging.getLogger(__name__)
# Stage 4 §5+§7: the terminal events that `_consume_event_stream` may return.
-# Stream + started events are filtered out before we yield; transport errors
+# Stream + started events are filtered out (plain-run text deltas are yielded
+# as stream chunks instead); transport errors
# are surfaced as a separate StreamCompletedEvent in the second tuple slot.
type _TerminalAgentBackendEvent = (
AgentBackendRunSucceededInternalEvent | AgentBackendRunFailedInternalEvent | AgentBackendRunCancelledInternalEvent
@@ -302,11 +303,14 @@ class DifyAgentNode(Node[DifyAgentNodeData]):
"status": create_response.status,
}
- terminal_event, exhausted = self._consume_event_stream(
+ terminal_event, exhausted = yield from self._consume_event_stream(
create_response.run_id,
inputs=inputs,
process_data=process_data,
metadata=metadata,
+ stream_text=not custom_outputs
+ and not node_job.output_routes.enabled
+ and self.error_strategy != ErrorStrategy.DEFAULT_VALUE,
)
# None means no post-exit snapshot was produced; leave the previously stored session snapshot untouched.
if (
@@ -436,12 +440,25 @@ class DifyAgentNode(Node[DifyAgentNodeData]):
inputs: dict[str, Any],
process_data: dict[str, Any],
metadata: dict[str, Any],
- ) -> tuple[
- _TerminalAgentBackendEvent | None,
- StreamCompletedEvent | None,
+ stream_text: bool,
+ ) -> Generator[
+ StreamChunkEvent,
+ None,
+ tuple[_TerminalAgentBackendEvent | None, StreamCompletedEvent | None],
]:
"""Consume the SSE stream for one Agent backend run.
+ When ``stream_text`` is set (plain runs whose final string becomes the
+ ``text`` output), agent-message deltas are yielded as ``text`` stream
+ chunks so Answer nodes can stream them. The stream is closed only after
+ at least one chunk was sent; otherwise the response coordinator falls
+ back to the final ``text`` variable. Structured runs keep deltas as
+ metadata because their ``text`` comes from the structured output.
+ Plain runs with the default-value error strategy stay buffered too:
+ once a selector has stream chunks, the response filter no longer reads
+ the variable pool, so a configured fallback ``text`` would be dropped
+ after a partial stream.
+
Returns a 2-tuple ``(terminal_event, transport_failure)``:
- ``terminal_event``: the first non-stream/non-started internal event,
or ``None`` if the stream ended without one.
@@ -450,6 +467,30 @@ class DifyAgentNode(Node[DifyAgentNodeData]):
terminal may accompany it so the caller can persist the final session
snapshot while preserving the original transport failure.
"""
+ result = yield from self._read_event_stream(
+ run_id,
+ inputs=inputs,
+ process_data=process_data,
+ metadata=metadata,
+ stream_text=stream_text,
+ )
+ if stream_text and (metadata.get("agent_backend") or {}).get("agent_message_delta_count"):
+ yield StreamChunkEvent(selector=[self._node_id, "text"], chunk="", is_final=True)
+ return result
+
+ def _read_event_stream(
+ self,
+ run_id: str,
+ *,
+ inputs: dict[str, Any],
+ process_data: dict[str, Any],
+ metadata: dict[str, Any],
+ stream_text: bool,
+ ) -> Generator[
+ StreamChunkEvent,
+ None,
+ tuple[_TerminalAgentBackendEvent | None, StreamCompletedEvent | None],
+ ]:
stream_event_count = 0
last_event_id: str | None = None
try:
@@ -470,6 +511,12 @@ class DifyAgentNode(Node[DifyAgentNodeData]):
if internal_event.type == AgentBackendInternalEventType.AGENT_MESSAGE_DELTA:
if isinstance(internal_event, AgentBackendAgentMessageDeltaInternalEvent):
self._record_agent_message_delta_metadata(metadata, internal_event)
+ if stream_text:
+ yield StreamChunkEvent(
+ selector=[self._node_id, "text"],
+ chunk=internal_event.delta,
+ is_final=False,
+ )
continue
metadata["agent_backend"] = {
**dict(metadata.get("agent_backend") or {}),
diff --git a/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_agent_node.py b/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_agent_node.py
index ddf64c31d6b..9b94d9da4c0 100644
--- a/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_agent_node.py
+++ b/api/tests/unit_tests/core/workflow/nodes/agent_v2/test_agent_node.py
@@ -56,7 +56,7 @@ from graphon.enums import (
WorkflowNodeExecutionStatus,
)
from graphon.file import File, FileTransferMethod, FileType
-from graphon.node_events import StreamCompletedEvent
+from graphon.node_events import StreamChunkEvent, StreamCompletedEvent
from graphon.runtime import GraphRuntimeState
from graphon.variables.segments import ArrayFileSegment, FileSegment, StringSegment
from models.agent import Agent, AgentConfigSnapshot, WorkflowAgentNodeBinding
@@ -393,6 +393,21 @@ class CancelFailingStreamBackendClient(FailingStreamBackendClient):
raise RuntimeError(f"failed to cancel {run_id}")
+def _drain_event_stream(node: DifyAgentNode):
+ stream = node._consume_event_stream(
+ "run-1",
+ inputs={},
+ process_data={"workflow_agent_binding_id": "binding-1"},
+ metadata={"agent_backend": {}},
+ stream_text=False,
+ )
+ while True:
+ try:
+ next(stream)
+ except StopIteration as stop:
+ return stop.value
+
+
def _node(
*,
scenario: FakeAgentBackendScenario = FakeAgentBackendScenario.SUCCESS,
@@ -626,11 +641,15 @@ def test_agent_node_passes_execution_id_to_session_store_and_runtime_request_bui
assert context.node_execution_id == execution_id
-def test_agent_node_run_ignores_agent_message_delta_until_terminal_result():
+def test_agent_node_run_streams_agent_message_delta_as_text_chunks():
events = list(_node(agent_backend_client=AgentMessageDeltaBackendClient())._run())
- assert len(events) == 1
- result = cast(StreamCompletedEvent, events[0]).node_run_result
+ assert events[:2] == [
+ StreamChunkEvent(selector=["agent-node", "text"], chunk="hello ", is_final=False),
+ StreamChunkEvent(selector=["agent-node", "text"], chunk="", is_final=True),
+ ]
+ assert len(events) == 3
+ result = cast(StreamCompletedEvent, events[2]).node_run_result
assert result.status == WorkflowNodeExecutionStatus.SUCCEEDED
assert result.outputs == {"text": "hello agent"}
agent_backend = result.metadata[WorkflowNodeExecutionMetadataKey.AGENT_LOG]["agent_backend"]
@@ -639,6 +658,36 @@ def test_agent_node_run_ignores_agent_message_delta_until_terminal_result():
assert agent_backend["agent_message_delta_length"] == len("hello ")
+def test_agent_node_structured_run_keeps_agent_message_delta_out_of_text_stream():
+ events = list(
+ _node(
+ declared_outputs=[{"name": "summary", "type": DeclaredOutputType.STRING}],
+ agent_backend_client=AgentMessageDeltaBackendClient(),
+ )._run()
+ )
+
+ assert len(events) == 1
+ result = cast(StreamCompletedEvent, events[0]).node_run_result
+ agent_backend = result.metadata[WorkflowNodeExecutionMetadataKey.AGENT_LOG]["agent_backend"]
+ assert agent_backend["agent_message_delta_count"] == 1
+
+
+def test_agent_node_default_value_plain_run_keeps_agent_message_delta_out_of_text_stream():
+ events = list(
+ _node(
+ error_strategy=ErrorStrategy.DEFAULT_VALUE,
+ agent_backend_client=AgentMessageDeltaBackendClient(),
+ )._run()
+ )
+
+ assert not any(isinstance(event, StreamChunkEvent) for event in events)
+ assert len(events) == 1
+ result = cast(StreamCompletedEvent, events[0]).node_run_result
+ assert result.outputs == {"text": "hello agent"}
+ agent_backend = result.metadata[WorkflowNodeExecutionMetadataKey.AGENT_LOG]["agent_backend"]
+ assert agent_backend["agent_message_delta_count"] == 1
+
+
def test_agent_node_run_normalizes_declared_file_output_with_canonical_mapping():
tool_reference = build_file_reference(record_id="tool-file-1")
with patch(
@@ -855,12 +904,7 @@ def test_agent_node_cancels_backend_run_when_stream_fails():
client = FailingStreamBackendClient()
node = _node(agent_backend_client=client)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert isinstance(terminal, AgentBackendRunCancelledInternalEvent)
assert failure is not None
@@ -874,12 +918,7 @@ def test_agent_node_forwards_last_stream_cursor_when_cancelling_after_failure()
client = FailingAfterStartedStreamBackendClient()
node = _node(agent_backend_client=client)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert isinstance(terminal, AgentBackendRunCancelledInternalEvent)
assert failure is not None
@@ -891,12 +930,7 @@ def test_agent_node_cancels_backend_run_when_stream_ends_without_terminal_event(
client = EmptyStreamBackendClient()
node = _node(agent_backend_client=client)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert isinstance(terminal, AgentBackendRunCancelledInternalEvent)
assert failure is None
@@ -908,12 +942,7 @@ def test_agent_node_cancels_backend_run_when_stream_raises_unexpected_error():
client = GenericFailingStreamBackendClient()
node = _node(agent_backend_client=client)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert isinstance(terminal, AgentBackendRunCancelledInternalEvent)
assert failure is not None
@@ -928,12 +957,7 @@ def test_agent_node_uses_graph_abort_reason_when_cancel_request_fails(caplog):
node = _node(agent_backend_client=client)
node.graph_runtime_state.graph_execution = SimpleNamespace(aborted=True)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert terminal is None
assert failure is not None
@@ -954,12 +978,7 @@ def test_agent_node_cancels_backend_run_for_unexpected_internal_event():
return_value=[SimpleNamespace(type=AgentBackendInternalEventType.RUN_FAILED)]
)
- terminal, failure = node._consume_event_stream(
- "run-1",
- inputs={},
- process_data={"workflow_agent_binding_id": "binding-1"},
- metadata={"agent_backend": {}},
- )
+ terminal, failure = _drain_event_stream(node)
assert terminal is None
assert failure is not None