# Voogedastuse sammud

Voogedastuse sammud võimaldavad töövool väljastada tulemit järk-järgult. Iga väljastatud osa kirjutatakse kohe andmebaasi, nii et kui samm voo keskel ebaõnnestub, säilivad juba püsisalvestatud osad ja need on korduskatsel saadaval.

See on kasulik LLM-i voogvastuste, suurte failide töötlemise ja kõigi olukordade puhul, kus osaline edenemine ei tohiks kaduma minna.

## StreamingStep-liides

Voogedastuse samm rakendab liidest `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;
}
```

| Meetod | Kirjeldus |
|---|---|
| `stream( $state, $existing_chunks )` | Generaator, mis väljastab stringijuppe. Iga väljastuse järel tehakse kohe andmebaasikirjutus. |
| `on_complete( $chunks, $state )` | Kutsutakse välja pärast voo lõppu. Saab kõik osad (varasemad + uued) ja tagastab andmed töövoo olekuga liitmiseks. |
| `config()` | Valikuline seadistus. Toetab võtmeid `max_attempts` ja `backoff`; `backoff` võtab strateegia nime (`exponential`, `linear`, `fixed`), sest viivituste loend jäetakse praegu kõrvale ([#16](https://github.com/inline0/queuety/issues/16)). |

## Kuidas osad püsivalt salvestatakse

Iga kord, kui generaator väljastab väärtuse, kutsub Queuety välja `ChunkStore::append_chunk()`, et kirjutada see tabelisse `queuety_chunks`. Pakettideks koondamist ega puhverdust ei toimu. Üks väljastus võrdub ühe INSERT-iga.

Osarea salvestab väärtused `job_id`, `workflow_id`, `step_index`, `chunk_index` (nullpõhine) ja stringi `content`.

## Jätkatavus

Kui voogedastuse sammu proovitakse pärast tõrget uuesti, laadib töötaja kõik varem püsivalt salvestatud osad ja edastab need parameetrina `$existing_chunks`. Teie teostus määrab, kuidas jätkata:

- **Jätke juba töödeldud üksused vahele**, kontrollides olemasolevate osade arvu
- **Liikuge lehekülgede kaupa esitatavas API-is edasi**, kasutades lehekülje nihkena osade arvu
- **Alustage otsast peale**, eirates täielikult väärtust `$existing_chunks` (eelmise katse osad on endiselt andmebaasis ja lisatakse ette)

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

## Südamerütmisignaalid voogedastuse ajal

Pikad vood peaksid saatma südamerütmisignaale, et vältida aegunud töö tuvastajal töö ülevõtmist. Kutsuge generaatori tsüklis välja `Heartbeat::beat()`:

```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;
    }
}
```

Lisateavet leiate jaotisest [Südamerütmisignaalid](https://queuety.inline0.dev/et/docs/features/heartbeats) liidese Heartbeat API kohta.

## Osade puhastamine

Kui voog lõpeb edukalt ja `on_complete()` tagastab tulemuse, kutsub töötaja välja `ChunkStore::clear_chunks()`, et kustutada kõik selle töö osad. Liidetud tulemus objektist `on_complete()` on püsiv kirje. Osad on kavandatud ajutiseks.

Kui samm ebaõnnestub ja seda proovitakse uuesti, osi ei kustutata. Järgmisel katsel edastatakse need tagasi parameetri `$existing_chunks` kaudu.

## Täielik näide: LLM-i voogedastus

```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 ];
    }
}
```

Kasutage seda töövoos nagu iga muud sammu:

```php
use Queuety\Queuety;

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

## Täielik näide: failide töötlemine

```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' ];
    }
}
```

## ChunkStore'i API

`ChunkStore` klass haldab osade püsisalvestust. Juurdepääs sellele käib `Queuety::chunk_store()` kaudu.

```php
$store = Queuety::chunk_store();
```

| Meetod | Tagastab | Kirjeldus |
|---|---|---|
| `get_chunks( int $job_id )` | `string[]` | Toob kõik töö osad osanumbri järgi järjestatuna |
| `append_chunk( int $job_id, int $chunk_index, string $content, ?int $workflow_id, ?int $step_index )` | `void` | Lisab ühe osa |
| `clear_chunks( int $job_id )` | `void` | Kustutab kõik töö osad |
| `chunk_count( int $job_id )` | `int` | Loendab töö osad |
| `get_accumulated( int $job_id )` | `string` | Liidab kõik osad üheks stringiks |

Tavaliselt pole vaja `ChunkStore`-i otse välja kutsuda. Töötaja haldab püsisalvestust ja puhastamist automaatselt `StreamingStep` töötlemisel. API on saadaval täpsemate kasutusjuhtude jaoks, näiteks pooleliolevate osade uurimiseks või käsitsi puhastamiseks.