Streaming

Beschreibt die Verarbeitung von Streaming-Antworten des Laravel Copilot SDK per CLI, SSE, WebSocket und Livewire.

​

Streaming

Wenn Sie in SessionConfig streaming: true angeben, empfangen Sie die Antworten von Copilot als Stream. Auch stdio- und TCP-Modus zeigen von Haus aus ein streaming-ähnliches Verhalten. Der Unterschied ist, dass zusätzlich ASSISTANT_MESSAGE_DELTA empfangen wird.

use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionEvent;

$config = new SessionConfig(
    streaming: true,
);

Copilot::start(function (CopilotSession $session) {
    $session->on(function (SessionEvent $event): void {
        if ($event->isAssistantMessageDelta()) {
            // Bei Delta trifft die Nachricht in kleinen Häppchen ein. Nützlich für Zwischenanzeigen. Auch möglich, ausschließlich damit zu arbeiten und so eine flüssige Anzeige zu erreichen.
            echo $event->deltaContent();
        } elseif ($event->isAssistantMessage()) {
            // Sind die zerteilten Deltas gesendet, kommt als ASSISTANT_MESSAGE eine Nachricht mit dem Volltext an.
            // Folgt eine weitere Nachricht, kommen erneut Deltas.
            // Da auf einen Prompt mehrere Nachrichten folgen können, wiederholt sich beim Streaming die Abfolge aus mehreren Deltas und einer Volltextnachricht.
        } elseif ($event->isAssistantReasoningDelta()) {
            // Auch Reasoning-Deltas kommen entsprechend in kleinen Häppchen an.
            echo $event->deltaContent();
        }
    });

    $session->sendAndWait(prompt: 'Tell me something about Laravel.');
}, config: $config);

• Für eine flüssige Anzeige geben Sie den Inhalt ohne zusätzliche Zeilenumbrüche direkt aus.
• Verwenden Sie spin() aus Laravel Prompts hier nicht, da die Darstellung sonst zerstört wird.

​

Konkrete Anwendungsmuster

​

Artisan-Command

Wie oben gezeigt geben Sie die Ausgabe direkt per echo oder $this->output->write() aus. Die Darstellung entspricht der der direkt genutzten Copilot CLI und ist daher intuitiv. Mit stream() aus Laravel Prompts erhalten Sie zusätzlich einen Fade-in-Effekt.

use function Laravel\Prompts\stream;

Artisan::command('copilot:streaming {--resume=}', function () {
    $config = new SessionConfig(
        streaming: true,
    );

    Copilot::start(function (CopilotSession $session) {
        info('Starting Copilot with streaming: '.$session->id());

        $stream = stream();

        $session->on(function (SessionEvent $event) use ($stream) {
            if ($event->isAssistantMessageDelta()) {
                // Deltas mit den zerteilten Nachrichten treffen ein. Mit stream() aus Laravel Prompts flüssig mit Fade-in ausgeben.
                $stream->append($event->deltaContent());
            } elseif ($event->isIdle()) {
                // Bei idle schließen. Da das Senden mehrerer Prompts innerhalb derselben Session sauber funktioniert, ist ein erneutes `$stream = stream()` nicht nötig.
                $stream->close();
            }
        });

        while (true) {
            $prompt = text(
                label: 'Enter your prompt',
                placeholder: 'Ask me anything...',
                required: true,
                hint: 'Ctrl+C to exit',
            );

            $session->sendAndWait($prompt);
        }
    }, config: $config, resume: $this->option('resume'));
})->purpose('Copilot streaming');

​

Auslieferung an eine Webseite als Server-Sent Events (SSE)

​

Variante mit response()->eventStream()

response()->eventStream() wurde kurz vor dem Release von Laravel 12 hinzugefügt. Da dieses Paket ausschließlich Laravel 12 und höher unterstützt, ist es nutzbar.

Route::get('/copilot/sse', function () {
    return response()->eventStream(function () {
        yield from Copilot::stream(function (CopilotSession $session) {
            foreach ($session->sendAndStream('Tell me something about Laravel.') as $event) {
                if ($event->isAssistantMessageDelta()) {
                    yield $event->deltaContent();
                }
            }
        }, config: new SessionConfig(streaming: true));
    });
});

Route::get('/copilot', function () {
    return view('copilot');
});

​

Variante mit response()->stream()

Route::get('/copilot/sse', function () {
    return response()->stream(function () {
        Copilot::start(function (CopilotSession $session) {
            $session->on(function (SessionEvent $event) {
                if ($event->isAssistantMessageDelta()) {
                    echo "event: update\n";
                    echo 'data: '.$event->deltaContent()."\n\n";
                    ob_flush();
                    flush();
                }
            });

            $session->sendAndWait('Tell me something about Laravel.');
        }, config: new SessionConfig(streaming: true));

        echo "event: update\n";
        echo "data: </stream>\n\n";
        ob_flush();
        flush();
    }, 200, [
        'Content-Type' => 'text/event-stream',
        'Cache-Control' => 'no-cache',
        'Connection' => 'keep-alive',
        'X-Accel-Buffering' => 'no',
    ]);
});

Route::get('/copilot', function () {
    return view('copilot');
});

​

Beispiel-Code der Frontend-Seite

copilot.blade.php dient nur der einfachen Anzeigeprüfung. Für den Produktivbetrieb mit React oder Vue empfehlen sich die offiziellen npm-Pakete von Laravel: @laravel/stream-react bzw. @laravel/stream-vue.

<html>
<body>

<script>
    const source = new EventSource('/copilot/sse');

    source.addEventListener('update', (event) => {
        if (event.data === '</stream>') {
            source.close();

            return;
        }

        console.log(event.data);
        document.getElementById("output").innerHTML += event.data;
    });
</script>

<h1>Copilot SSE Test</h1>
<div id="output"></div>
</body>
</html>

​

Auslieferung über WebSocket

Durch Kombination von Laravel-Notifications, Broadcasting und Reverb lassen sich delta-Ereignisse auch per WebSocket ausliefern.

​

wire:stream in Livewire

Auch in Livewire ist eine Streaming-Anzeige mit der Direktive wire:stream möglich.

<?php

use Livewire\Attributes\Layout;
use Livewire\Component;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Enums\SessionEventType;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionEvent;

new class extends Component
{
    public string $prompt = 'Tell me about Laravel Livewire.';
    public string $question = '';
    public string $answer = '';
    public ?string $sessionId = null;

    function submitPrompt(): void
    {
        $this->question = $this->prompt;

        $this->prompt = '';

        $this->answer = '';

        $this->js('$wire.copilot()');
    }

    public function copilot(): void
    {
        Copilot::start(function (CopilotSession $session) {
            $this->sessionId = $session->id();

            $session->on(SessionEventType::ASSISTANT_MESSAGE_DELTA, function (SessionEvent $event): void {

                $this->stream(
                    content: $event->deltaContent(),
                    to: 'answer',
                );
                $this->answer = $event->deltaContent();
            });

            $response = $session->sendAndWait(prompt: $this->question);
            $this->answer = $response->content();
        }, config: ['streaming' => true], resume: $this->sessionId);
    }
};
?>

<div>
    <div class="border border-gray-200 rounded-lg p-4 mb-6">
        @if ($question)
            <h3 class="font-extrabold mb-3">{{ $question }}</h3>

            <div wire:stream="answer">{{ $answer }}</div>
        @endif
    </div>

    <flux:input.group>
        <flux:input wire:model="prompt" placeholder="Ask Copilot"/>
        <flux:button wire:click="submitPrompt" icon="paper-airplane" icon:variant="outline"></flux:button>
    </flux:input.group>
</div>

Aktuelle Informationen finden Sie im GitHub-Repository.