Tcl

Conversation with Streaming Responses

See more AI Examples

Demonstrates an AI conversation with receiving streaming responses. Tcl

load ./chilkat.dll

set success 0

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

set 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.
CkAi_put_Provider $ai "google"

#  Use your provider's API key.
CkAi_put_ApiKey $ai "MY_API_KEY"

#  Choose a model.
CkAi_put_Model $ai "gemini-3.6-flash"

#  Indicate streaming mode is to be used.
CkAi_put_Streaming $ai 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.
set systemMsg "You are a creative storyteller"
set developerMsg ""
set conversationName "test_conversation"
CkAi_NewConvo $ai $conversationName $systemMsg $developerMsg

#  Add a text input.
CkAi_InputAddText $ai "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.
set success [CkAi_Ask $ai "text"]
if {$success == 0} then {
    puts [CkAi_lastErrorText $ai]
    delete_CkAi $ai
    exit
}

set sbEventName [new_CkStringBuilder]

set sbDelta [new_CkStringBuilder]

set sbFullResponse [new_CkStringBuilder]

set finished 0
set abortFlag 0
set maxWaitMs 5000

while {!$finished} {

    set result [CkAi_PollAi $ai $abortFlag]
    if {$result == 1} then {
        #  We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        set success [CkAi_NextAiEvent $ai $maxWaitMs $sbEventName $sbDelta]
        if {$success == 0} then {
            puts [CkAi_lastErrorText $ai]
            delete_CkAi $ai
            delete_CkStringBuilder $sbEventName
            delete_CkStringBuilder $sbDelta
            delete_CkStringBuilder $sbFullResponse
            exit
        }

        #  Some AI providers send many "empty" events.  Just ignore them.
        if {![CkStringBuilder_ContentsEqual $sbEventName "empty" 1]} then {

            #  The delta contains the new output.  This could be emitted to a display or the terminal
            #  as real-time output.
            if {CkStringBuilder_ContentsEqual $sbEventName "delta" 1} then {
                #  This example will emit each delta to its own line.
                puts [CkStringBuilder_getAsString $sbDelta]

                #  Accumulate the delta's so we can show the full response later.
                CkStringBuilder_AppendSb $sbFullResponse $sbDelta
            }             else {
                #  A streaming AI response is always terminated by a single "null_terminator" event.
                set finished [CkStringBuilder_ContentsEqual $sbEventName "null_terminator" 1]
            }

        }

    }     else {
        if {$result == 0} then {
            #  Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            CkAi_SleepMs $ai 100
        }         else {
            #  Something failed..
            puts [CkAi_lastErrorText $ai]
            set finished 1
        }

    }

}

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

#  Show the accumulated (full) response.
puts "----"
puts [CkStringBuilder_getAsString $sbFullResponse]
puts "----"

#  ----------------------------------------------------------------------------------------------------------
#  For the 2nd request in this conversation, ask for a shorter version of the story.
CkAi_InputAddText $ai "Rewrite the story, but this time make it shorter, about one third as long."
set success [CkAi_Ask $ai "text"]
if {$success == 0} then {
    puts [CkAi_lastErrorText $ai]
    delete_CkAi $ai
    delete_CkStringBuilder $sbEventName
    delete_CkStringBuilder $sbDelta
    delete_CkStringBuilder $sbFullResponse
    exit
}

CkStringBuilder_Clear $sbFullResponse
set finished 0

while {!$finished} {

    set result [CkAi_PollAi $ai $abortFlag]
    if {$result == 1} then {
        #  We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        set success [CkAi_NextAiEvent $ai $maxWaitMs $sbEventName $sbDelta]
        if {$success == 0} then {
            puts [CkAi_lastErrorText $ai]
            delete_CkAi $ai
            delete_CkStringBuilder $sbEventName
            delete_CkStringBuilder $sbDelta
            delete_CkStringBuilder $sbFullResponse
            exit
        }

        #  Some AI providers send many "empty" events.  Just ignore them.
        if {![CkStringBuilder_ContentsEqual $sbEventName "empty" 1]} then {

            #  The delta contains the new output.  This could be emitted to a display or the terminal
            #  as real-time output.
            if {CkStringBuilder_ContentsEqual $sbEventName "delta" 1} then {
                #  This example will emit each delta to its own line.
                puts [CkStringBuilder_getAsString $sbDelta]

                #  Accumulate the delta's so we can show the full response later.
                CkStringBuilder_AppendSb $sbFullResponse $sbDelta
            }             else {
                #  A streaming AI response is always terminated by a single "null_terminator" event.
                set finished [CkStringBuilder_ContentsEqual $sbEventName "null_terminator" 1]
            }

        }

    }     else {
        if {$result == 0} then {
            #  Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            CkAi_SleepMs $ai 100
        }         else {
            #  Something failed..
            puts [CkAi_lastErrorText $ai]
            set finished 1
        }

    }

}

puts "----"
puts [CkStringBuilder_getAsString $sbFullResponse]

delete_CkAi $ai
delete_CkStringBuilder $sbEventName
delete_CkStringBuilder $sbDelta
delete_CkStringBuilder $sbFullResponse