Ruby

AI: Simple Stateless Streaming Response

See more AI Examples

Shows a simple stateless query and receives the response in streaming mode. Ruby

require 'chilkat'

success = false

#  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("openai")

#  Use your provider's API key.
ai.put_ApiKey("MY_API_KEY")

#  Choose a model.
ai.put_Model("gpt-5.6-terra")

#  Indicate streaming mode is to be used.
ai.put_Streaming(true)

#  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
end

sbEventName = Chilkat::CkStringBuilder.new()
sbDelta = Chilkat::CkStringBuilder.new()
sbFullResponse = Chilkat::CkStringBuilder.new()
finished = false
abortFlag = false
maxWaitMs = 5000

while finished == false

    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
        end

        #  Some AI providers send many "empty" events.  Just ignore them.
        if (sbEventName.ContentsEqual("empty",true) == false)
            #  Log the non-empty events.
            print sbEventName.getAsString() + "\n";

            #  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) == true)
                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)
            end

        end

    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
        end

    end

end

#  Show the accumulated (full) response.
print "----" + "\n";
print sbFullResponse.getAsString() + "\n";

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