> For the complete documentation index, see [llms.txt](https://docs.neuron-ai.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neuron-ai.dev/neuron-v3-zh/gong-zuo-liu/streaming.md).

# 流式传输

在工作流执行期间流式传输实时更新

工作流可能很复杂，它们旨在处理复杂的、分支式的、可迭代的逻辑，这意味着它们可能需要一些时间才能完全执行。为了让用户获得良好的体验，你可能希望通过在事件发生时流式传输事件来提供进度提示。工作流对此提供了内置支持，并且可以直接在节点内部完成。

### 从节点发出事件

让我们设置一个新事件，用于在执行过程中流式传输我们的进度：

```php
namespace App\Neuron;

class ProgressEvent implements Event 
{
    public function __construct(protected string $msg){}
}
```

我们将使用前一个教程中的多个节点示例 MyWorkflow，并修改这些节点，使其流式输出更新，而不是直接回显输出。

{% hint style="warning" %}
**注意**: 要从节点流式传输事件，你需要添加 `\Generator` 作为以下内容的附加返回类型 `__invoke` 方法中列出的相同顺序运行这些后处理器。
{% endhint %}

```php
namespace App\Neuron;

use Generator;
use NeuronAI\Workflow\Node;
use NeuronAI\Workflow\StartEvent;
use NeuronAI\Workflow\StopEvent;

class InitialNode extends Node
{
    public function __invoke(
        StartEvent $event, 
        WorkflowState $state,
        WorkflowResources $resources
    ): Generator|FirstEvent {
        yield new ProgressEvent("处理 StartEvent");
        
        return new FirstEvent("InitialNode 完成");
    }
}

class NodeOne extends Node
{
    public function __invoke(
        FirstEvent $event, 
        WorkflowState $state,
        WorkflowResources $resources
    ): Generator|SecondEvent {
        yield new ProgressEvent($event->firstMsg);
        
        return new SecondEvent("NodeOne 完成");
    }
}

class NodeTwo extends Node
{
    public function __invoke(
        SecondEvent $event, 
        WorkflowState $state,
        WorkflowResources $resources
    ): Generator|StopEvent {
        yield new ProgressEvent($event->secondMsg);
        
        yield new ProgressEvent("节点二已完成");
        
        $state->set('message', '流式传输结束');
        
        return new StopEvent();
    }
}
```

要真正获得这些输出，我们需要启动工作流并监听这些事件，如下所示：

```php
$workflow = Workflow::make()
    ->setWorkflowId('wk_id')
    ->addNodes([
        new InitialNode(),
        new NodeOne(),
        new NodeTwo(),
    ]);

$stream = $workflow->events();

foreach ($stream as $event) {
    if ($event instanceof ProgressEvent) {
        echo "\n- ".$event->message;
    }
}

$finalState = $stream->getResult();

// 它会打印“流式传输结束”
echo "\n- ".$finalState->get('message');
```

完整输出将是：

```
- 处理 StartEvent
- InitialNode 完成
- NodeOne 完成
- NodeTwo 完成
- 流式传输结束
```

### 流式代理输出

在节点内部运行代理是使用工作流时最常见的用例之一。你可能会希望直接将内部代理的输出流式传输给客户端，以便对底层生成过程提供实时反馈。你可以通过直接在节点内部流式传输代理的输出来实现这一点。

```php
class InitialNode extends Node
{
    public function __invoke(
        StartEvent $event, 
        WorkflowState $state,
        WorkflowResources $resources
    ): Generator|FirstEvent {
        // 以流式方式运行代理
        yield from Agent::make()
            ->stream(new UserMessage($state->get('prompt')));
        
        return new FirstEvent("InitialNode 完成");
    }
}
```

要获取此输出，你可以像往常一样监听工作流事件：

```php
$workflow = MyWorkflow::make()->setWorkflowId('wk_id');

foreach ($workflow->events() as $event) {
    echo match($event::class) {
        TextChunk::class => "\n- ".$event->content,
        ...
    }
}
```

### 监控与调试

你使用 Neuron 构建的许多应用都会包含多个步骤以及多次 LLM 调用。随着这些应用变得越来越复杂，能够检查你的代理系统内部究竟发生了什么变得至关重要。做到这一点的最佳方式是使用 [Inspector](https://inspector.dev/).

{% embed url="<https://docs.inspector.dev/guides/neuron-ai>" %}
