Streaming

Découvrez comment traiter les réponses en streaming de Laravel Copilot SDK dans un CLI, en SSE, en WebSocket et avec Livewire.

​

Streaming

Avec streaming: true dans SessionConfig, vous recevez les réponses de Copilot en streaming. En mode stdio comme en mode TCP, le comportement est déjà proche du streaming ; la différence est que vous recevez ASSISTANT_MESSAGE_DELTA.

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()) {
            // Les messages arrivent par petits fragments. Utile pour l'affichage en direct. Vous pouvez aussi vous en contenter pour un rendu fluide.
            echo $event->deltaContent();
        } elseif ($event->isAssistantMessage()) {
            // Une fois les deltas terminés, un ASSISTANT_MESSAGE contenant le texte complet est envoyé.
            // S'il y a un message suivant, de nouveaux deltas arrivent.
            // Un prompt peut donner plusieurs messages : en streaming, on alterne plusieurs deltas et un texte complet.
        } elseif ($event->isAssistantReasoningDelta()) {
            // Les deltas de raisonnement arrivent aussi par petits fragments.
            echo $event->deltaContent();
        }
    });

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

• Pour un rendu fluide, affichez tel quel sans ajouter de retour à la ligne.
• N’utilisez pas spin() de Laravel Prompts en parallèle : l’affichage se casse.

​

Motifs concrets d’utilisation

​

Commande Artisan

Comme ci-dessus, affichez directement avec echo ou $this->output->write(). Le rendu est identique à celui du Copilot CLI, donc simple à comprendre. Avec stream() de Laravel Prompts, vous pouvez afficher avec un effet de fondu.

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()) {
                // Les messages arrivent par fragments. On les affiche avec l'effet fondu via stream() de Laravel Prompts.
                $stream->append($event->deltaContent());
            } elseif ($event->isIdle()) {
                // À l'état idle, on ferme. Cela fonctionne même si plusieurs prompts sont envoyés dans la même session, pas besoin de refaire `$stream = stream()`.
                $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');

​

Diffusion Server-Sent Events (SSE) côté Web

​

Avec response()->eventStream()

response()->eventStream() a été introduit peu avant la sortie de Laravel 12. Ce paquet ne prenant en charge que Laravel 12+, vous pouvez l’utiliser.

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');
});

​

Avec 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');
});

​

Exemple de code côté front

copilot.blade.php est un simple exemple. En production avec React ou Vue, il est recommandé d’utiliser les paquets npm officiels de Laravel : @laravel/stream-react ou @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>

​

Diffusion en WebSocket

En combinant les notifications, le broadcasting et Reverb de Laravel, vous pouvez diffuser les delta via WebSocket.

​

wire:stream de Livewire

Avec Livewire, la directive wire:stream permet également l’affichage en streaming.

<?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>

Pour les dernières informations, consultez le dépôt GitHub.