Tcl

Streaming AI with Automatic JavaScript AI Tool Function Calling

See more AI Examples

Demonstrates how to get AI responses in streaming mode, including possible tool function calling using Chilkat with embedded Chilkat.Js JavaScript. Automatic JavaScript tool calls are characterized by:

• Tool function implementations are in JavaScript.
• The JavaScript also provides a tool registry and permissions.
• The JavaScript runs embedded within your application using Chilkat.Js.
• Tool calls are handled entirely within Chilkat. Your application does not need to manually check for function calls in the AI response. Internal to the Ask function, Chilkat will handle function calls by calling your registered JavaScript tools and will send results back to the AI model until the final response is received.

Tcl

load ./chilkat.dll

set success 0

# ----------------------------------------------------------------------------------
# The Javascript file loaded here is shown at the bottom of this page.
# -----------------------------------------------------------------------------------

set sbJs [new_CkStringBuilder]

set success [CkStringBuilder_LoadFile $sbJs "qa_data/js_tools/horoscope_tools.js" "utf-8"]
if {$success == 0} then {
    puts [CkStringBuilder_lastErrorText $sbJs]
    delete_CkStringBuilder $sbJs
    exit
}

set ai [new_CkAi]

# Register the tools that will be made available to the AI.
set evalOnly 0
set allowAllKeyword 1
CkAi_RegisterJsTools $ai $sbJs $evalOnly $allowAllKeyword

# The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
CkAi_put_Provider $ai "openai"
# Use your provider's API key.
CkAi_put_ApiKey $ai "MY_API_KEY"
# Choose a model.
CkAi_put_Model $ai "gpt-5-mini"

# Tool function calling must always occur within a conversation.
set conversation_name "convo_astrology"
set sysMessage "You are a helpful astrologer"
set devMessage "Respond only with markdown."
CkAi_NewConvo $ai $conversation_name $sysMessage $devMessage

# Provide inputs
CkAi_InputAddText $ai "What is my horoscope? I am an Aquarius."

# Get the response in streaming mode.
CkAi_put_Streaming $ai 1

# In streaming mode, if we receive an AI event that is a request for tool use,
# we'll need to make the call to the JavaScript and then continue with a followup Ask,
# until the final response is received.

set sbEventName [new_CkStringBuilder]

set sbDelta [new_CkStringBuilder]

set sbFullResponse [new_CkStringBuilder]

# When PollAi returns with an event, it's highly unlikely the
# call to NextAiEvent does not immediately return.  Setting a max
# timeout is just a precaution..
set maxWaitMs 5000

set finished 0
set numAsks 0
# Set a max # of followup Asks to prevent any unexpected infinite looping.
while {expr !$finished  &&  [$numAsks < 10]} {

    # Send the request to the AI model.
    set success [CkAi_Ask $ai "text"]
    if {$success == 0} then {
        puts [CkAi_lastErrorText $ai]
        delete_CkStringBuilder $sbJs
        delete_CkAi $ai
        delete_CkStringBuilder $sbEventName
        delete_CkStringBuilder $sbDelta
        delete_CkStringBuilder $sbFullResponse
        exit
    }

    set madeFunctionCalls 0
    set streamingDone 0

    while {!$streamingDone} {
        set result [CkAi_PollAi $ai 0]
        if {$result < 0} then {
            puts [CkAi_lastErrorText $ai]
            puts "Failed."
            delete_CkStringBuilder $sbJs
            delete_CkAi $ai
            delete_CkStringBuilder $sbEventName
            delete_CkStringBuilder $sbDelta
            delete_CkStringBuilder $sbFullResponse
            exit
        }

        if {$result > 0} then {
            # We have an event..
            set success [CkAi_NextAiEvent $ai $maxWaitMs $sbEventName $sbDelta]
            if {$success == 0} then {
                puts [CkAi_lastErrorText $ai]
                delete_CkStringBuilder $sbJs
                delete_CkAi $ai
                delete_CkStringBuilder $sbEventName
                delete_CkStringBuilder $sbDelta
                delete_CkStringBuilder $sbFullResponse
                exit
            }

            # Is this an event where the AI is requesting a function call?
            if {D]CkStringBuilder_ContentsEqual $sbEventName "js_function_call" 1[/L} then {
                # Call the JavaScript function.
                # We don't need to find the exact function and make the call.  
                # We can simply pass the sbDelta (which contains information about the function to be called and the args).
                # Chilkat will find the registered JavaScript function, call it, and add the results to the conversation.
                # We indicate that function calls were made, which results in a followup Ask (in the outer loop).
                set success [CkAi_StreamingJsToolCall $ai $sbDelta]
                if {$success == 0} then {
                    # The JS function call failed.
                    set streamingDone 1
                }                 else {
                    set madeFunctionCalls 1
                }

            }             else {
                if {![CkStringBuilder_ContentsEqual $sbEventName "empty" 1]} then {
                    CkStringBuilder_AppendSb $sbFullResponse $sbDelta

                    if {D]CkStringBuilder_ContentsEqual $sbEventName "null_terminator" 1[/L} then {
                        set streamingDone 1
                    }

                }

            }

        }         else {
            # No event arrived, so wait a short time rather than spin in a loop..
            CkAi_SleepMs $ai 100
        }

    }

    if {!$madeFunctionCalls} then {
        set finished 1
    }

    set numAsks [expr $numAsks + 1]
}

puts "Full Response:"
puts [CkStringBuilder_getAsString $sbFullResponse]

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