Kroki strumieniowe

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 2cc7b2b

Kroki strumieniowe pozwalają workflow generować dane stopniowo. Każdy wygenerowany fragment jest natychmiast zapisywany w bazie danych, więc jeśli krok zakończy się niepowodzeniem w trakcie przesyłania strumienia, wcześniej zapisane fragmenty przetrwają i będą dostępne przy ponowieniu.

Przydaje się to w przypadku odpowiedzi strumieniowych modeli LLM, przetwarzania dużych plików i wszelkich sytuacji, w których nie należy utracić częściowych postępów.

Interfejs StreamingStep

Krok strumieniowy implementuje Queuety\Contracts\StreamingStep:

PHP

namespace Queuety\Contracts;

interface StreamingStep {
    public function stream( array $state, array $existing_chunks = [] ): \Generator;
    public function on_complete( array $chunks, array $state ): array;
    public function config(): array;
}

Metoda	Opis
`stream( $state, $existing_chunks )`	Generator zwracający fragmenty tekstu. Każde zwrócenie fragmentu powoduje natychmiastowy zapis do DB.
`on_complete( $chunks, $state )`	Wywoływana po zakończeniu strumienia. Otrzymuje wszystkie fragmenty (wcześniejsze i nowe) i zwraca dane do połączenia ze stanem workflow.
`config()`	Opcjonalna konfiguracja. Obsługuje klucze `max_attempts` i `backoff`; `backoff` przyjmuje nazwę strategii (`exponential`, `linear`, `fixed`), ponieważ lista opóźnień jest obecnie pomijana (#16).

Jak zapisywane są fragmenty

Za każdym razem, gdy generator zwróci wartość, Queuety wywołuje ChunkStore::append_chunk(), aby zapisać ją w tabeli queuety_chunks. Nie ma grupowania ani buforowania. Jedno zwrócenie oznacza jeden INSERT.

Wiersz fragmentu przechowuje job_id, workflow_id, step_index, chunk_index (indeksowany od zera) oraz ciąg znaków content.

Wznawianie

Gdy krok strumieniowy zostanie ponowiony po błędzie, worker wczytuje wszystkie wcześniej zapisane fragmenty i przekazuje je jako parametr $existing_chunks. To Twoja implementacja decyduje, jak wznowić działanie:

Pomiń przetworzone już elementy, sprawdzając liczbę istniejących fragmentów
Przejdź do odpowiedniej pozycji w stronicowanym API, używając liczby fragmentów jako przesunięcia strony
Zacznij od początku, całkowicie ignorując $existing_chunks (fragmenty z poprzedniej próby nadal znajdują się w DB i zostaną dodane na początku)

PHP

public function stream( array $state, array $existing_chunks = [] ): \Generator {
    $offset = count( $existing_chunks );

    $pages = $this->client->paginate( $state['query'], offset: $offset );

    foreach ( $pages as $page ) {
        yield json_encode( $page );
    }
}

Sygnały kontrolne podczas strumieniowania

Długotrwałe strumienie powinny wysyłać sygnały kontrolne, aby zapobiec przejęciu zadania przez detektor nieaktywnych zadań. Wywołaj Heartbeat::beat() w pętli generatora:

PHP

use Queuety\Heartbeat;

public function stream( array $state, array $existing_chunks = [] ): \Generator {
    foreach ( $this->client->stream( $state['prompt'] ) as $i => $chunk ) {
        Heartbeat::beat( [ 'chunks' => $i + 1 ] );
        yield $chunk;
    }
}

Szczegóły znajdziesz w sekcji Sygnały kontrolne, dotyczącej interfejsu Heartbeat API.

Czyszczenie fragmentów

Gdy strumień zakończy się powodzeniem i funkcja on_complete() zwróci wynik, worker wywołuje ChunkStore::clear_chunks(), aby usunąć wszystkie fragmenty zadania. Połączony wynik z on_complete() stanowi trwały zapis. Fragmenty są z założenia tymczasowe.

Jeśli krok zakończy się niepowodzeniem i zostanie ponowiony, fragmenty nie są usuwane. Przy następnej próbie zostaną przekazane za pośrednictwem $existing_chunks.

Pełny przykład: strumieniowanie LLM

PHP

use Queuety\Contracts\StreamingStep;
use Queuety\Heartbeat;

class StreamLLMResponse implements StreamingStep {

    public function stream( array $state, array $existing_chunks = [] ): \Generator {
        // If we have existing chunks from a previous attempt, we can skip
        // re-requesting. The on_complete method will concatenate everything.
        if ( ! empty( $existing_chunks ) ) {
            return;
        }

        $response = OpenAI::chat()->createStreamed( [
            'model'    => 'gpt-4',
            'messages' => $state['messages'],
        ] );

        foreach ( $response as $i => $chunk ) {
            $text = $chunk->choices[0]->delta->content ?? '';
            if ( '' !== $text ) {
                Heartbeat::beat( [ 'tokens' => $i ] );
                yield $text;
            }
        }
    }

    public function on_complete( array $chunks, array $state ): array {
        return [
            'llm_response' => implode( '', $chunks ),
        ];
    }

    public function config(): array {
        return [ 'max_attempts' => 5 ];
    }
}

Użyj tego w workflow tak jak każdego innego kroku:

PHP

use Queuety\Queuety;

Queuety::workflow( 'ai_chat' )
    ->then( BuildPromptHandler::class )
    ->then( StreamLLMResponse::class )
    ->then( SaveResponseHandler::class )
    ->dispatch( [ 'user_input' => $input ] );

Pełny przykład: przetwarzanie plików

PHP

use Queuety\Contracts\StreamingStep;
use Queuety\Heartbeat;

class ProcessCSVRows implements StreamingStep {

    public function stream( array $state, array $existing_chunks = [] ): \Generator {
        $file   = fopen( $state['csv_path'], 'r' );
        $offset = count( $existing_chunks );
        $row    = 0;

        // Skip the header.
        fgetcsv( $file );

        while ( $line = fgetcsv( $file ) ) {
            $row++;

            // Skip rows already processed in a previous attempt.
            if ( $row <= $offset ) {
                continue;
            }

            $result = $this->process_row( $line );
            Heartbeat::beat( [ 'row' => $row ] );
            yield json_encode( $result );
        }

        fclose( $file );
    }

    public function on_complete( array $chunks, array $state ): array {
        $results = array_map( 'json_decode', $chunks );
        return [
            'processed_count' => count( $results ),
            'results'         => $results,
        ];
    }

    public function config(): array {
        return [];
    }

    private function process_row( array $line ): array {
        // Your row processing logic here.
        return [ 'id' => $line[0], 'status' => 'ok' ];
    }
}

Klasa ChunkStore API

Klasa ChunkStore zarządza trwałym zapisem fragmentów. Uzyskaj do niej dostęp przez Queuety::chunk_store().

PHP

$store = Queuety::chunk_store();

Metoda	Zwraca	Opis
`get_chunks( int $job_id )`	`string[]`	Pobiera wszystkie fragmenty zadania, uporządkowane według indeksu fragmentu
`append_chunk( int $job_id, int $chunk_index, string $content, ?int $workflow_id, ?int $step_index )`	`void`	Dodaje pojedynczy fragment
`clear_chunks( int $job_id )`	`void`	Usuwa wszystkie fragmenty zadania
`chunk_count( int $job_id )`	`int`	Zlicza fragmenty zadania
`get_accumulated( int $job_id )`	`string`	Łączy wszystkie fragmenty w jeden ciąg znaków

Zwykle nie trzeba wywoływać bezpośrednio ChunkStore. Worker automatycznie obsługuje trwały zapis i czyszczenie podczas przetwarzania obiektu StreamingStep. API jest dostępny w zaawansowanych zastosowaniach, takich jak sprawdzanie trwającego zapisu fragmentów lub ręczne czyszczenie.