PHP Extension

Conversation with Streaming Responses

See more AI Examples

Demonstrates an AI conversation with receiving streaming responses. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$ai = new CkAi();

// The provider can be "openai", "google", "claude", "deepseek", "xai", or "perplexity".
// Support for additional providers will be added in future versions of Chilkat.
$ai->put_Provider('google');

// Use your provider's API key.
$ai->put_ApiKey('MY_API_KEY');

// Choose a model.
$ai->put_Model('gemini-2.5-flash');

// Indicate streaming mode is to be used.
$ai->put_Streaming(true);

// Create a new conversation to be maintained locally in memory.
// If the conversation is the first to be created, it is also automatically selected.
$systemMsg = 'You are a creative storyteller';
$developerMsg = '';
$conversationName = 'test_conversation';
$ai->NewConvo($conversationName,$systemMsg,$developerMsg);

// Add a text input.
$ai->InputAddText('Write a detailed story about a turtle who decides to run a bakery.  Describe the setting, the kinds of pastries, how the turtle feels, and include at least three paragraphs.');

// Ask the AI for text output.
$success = $ai->Ask('text');
if ($success == false) {
    print $ai->lastErrorText() . "\n";
    exit;
}

$sbEventName = new CkStringBuilder();
$sbDelta = new CkStringBuilder();
$sbFullResponse = new CkStringBuilder();
$finished = false;
$abortFlag = false;
$maxWaitMs = 5000;

while (!$finished) {

    $result = $ai->PollAi($abortFlag);
    if ($result == 1) {
        // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        $success = $ai->NextAiEvent($maxWaitMs,$sbEventName,$sbDelta);
        if ($success == false) {
            print $ai->lastErrorText() . "\n";
            exit;
        }

        // Some AI providers send many "empty" events.  Just ignore them.
        if (!$sbEventName->ContentsEqual('empty',true)) {

            // The delta contains the new output.  This could be emitted to a display or the terminal
            // as real-time output.
            if ($sbEventName->ContentsEqual('delta',true)) {
                // This example will emit each delta to its own line.
                print $sbDelta->getAsString() . "\n";

                // Accumulate the delta's so we can show the full response later.
                $sbFullResponse->AppendSb($sbDelta);
            }
            else {
                // A streaming AI response is always terminated by a single "null_terminator" event.
                $finished = $sbEventName->ContentsEqual('null_terminator',true);
            }

        }

    }
    else {
        if ($result == 0) {
            // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            $ai->SleepMs(100);
        }
        else {
            // Something failed..
            print $ai->lastErrorText() . "\n";
            $finished = true;
        }

    }

}

// -------------------------------------------------------------
// The response is in markdown format.
// Also see Markdown to HTML Conversion Examples.
// -------------------------------------------------------------

// Show the accumulated (full) response.
print '----' . "\n";
print $sbFullResponse->getAsString() . "\n";
print '----' . "\n";

// ----------------------------------------------------------------------------------------------------------
// For the 2nd request in this conversation, ask for a shorter version of the story.
$ai->InputAddText('Rewrite the story, but this time make it shorter, about one third as long.');
$success = $ai->Ask('text');
if ($success == false) {
    print $ai->lastErrorText() . "\n";
    exit;
}

$sbFullResponse->Clear();
$finished = false;

while (!$finished) {

    $result = $ai->PollAi($abortFlag);
    if ($result == 1) {
        // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        $success = $ai->NextAiEvent($maxWaitMs,$sbEventName,$sbDelta);
        if ($success == false) {
            print $ai->lastErrorText() . "\n";
            exit;
        }

        // Some AI providers send many "empty" events.  Just ignore them.
        if (!$sbEventName->ContentsEqual('empty',true)) {

            // The delta contains the new output.  This could be emitted to a display or the terminal
            // as real-time output.
            if ($sbEventName->ContentsEqual('delta',true)) {
                // This example will emit each delta to its own line.
                print $sbDelta->getAsString() . "\n";

                // Accumulate the delta's so we can show the full response later.
                $sbFullResponse->AppendSb($sbDelta);
            }
            else {
                // A streaming AI response is always terminated by a single "null_terminator" event.
                $finished = $sbEventName->ContentsEqual('null_terminator',true);
            }

        }

    }
    else {
        if ($result == 0) {
            // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            $ai->SleepMs(100);
        }
        else {
            // Something failed..
            print $ai->lastErrorText() . "\n";
            $finished = true;
        }

    }

}

print '----' . "\n";
print $sbFullResponse->getAsString() . "\n";

?>