Perl

Conversation with Streaming Responses

See more AI Examples

Demonstrates an AI conversation with receiving streaming responses. Perl

use chilkat();

$success = 0;

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

$ai = chilkat::CkAi->new();

# 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(1);

# 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 == 0) {
    print $ai->lastErrorText() . "\r\n";
    exit;
}

$sbEventName = chilkat::CkStringBuilder->new();
$sbDelta = chilkat::CkStringBuilder->new();
$sbFullResponse = chilkat::CkStringBuilder->new();
$finished = 0;
$abortFlag = 0;
$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 == 0) {
            print $ai->lastErrorText() . "\r\n";
            exit;
        }

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

            # The delta contains the new output.  This could be emitted to a display or the terminal
            # as real-time output.
            if ($sbEventName->ContentsEqual("delta",1)) {
                # This example will emit each delta to its own line.
                print $sbDelta->getAsString() . "\r\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",1);
            }

        }

    }
    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() . "\r\n";
            $finished = 1;
        }

    }

}

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

# Show the accumulated (full) response.
print "----" . "\r\n";
print $sbFullResponse->getAsString() . "\r\n";
print "----" . "\r\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 == 0) {
    print $ai->lastErrorText() . "\r\n";
    exit;
}

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

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 == 0) {
            print $ai->lastErrorText() . "\r\n";
            exit;
        }

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

            # The delta contains the new output.  This could be emitted to a display or the terminal
            # as real-time output.
            if ($sbEventName->ContentsEqual("delta",1)) {
                # This example will emit each delta to its own line.
                print $sbDelta->getAsString() . "\r\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",1);
            }

        }

    }
    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() . "\r\n";
            $finished = 1;
        }

    }

}

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