Tcl

Demonstrates Manual Tool Function Calls

See more AI Examples

Demonstrates how to do manual tool function calling using Chilkat. This is where your application manually checks for function calls in the AI's response, makes the function calls, and returns the function call results to the AI. Tcl

load ./chilkat.dll

set success 0

# Create the following JSON to define tool functions available for the AI to use.
# Note: You'll use the following JSON format regardless of the AI provider, whether
# it be ChatGPT, Gemini, Claude, Grok, etc.  Chilkat automatically converts to the required
# format needed for a given AI provider.

# In this example, the application is providing two functions the AI may choose to call.

# {
#   "tools": [
#     {
#       "name": "get_horoscope",
#       "description": "Get today's horoscope for an astrological sign.",
#       "parameters": {
#         "properties": {
#           "sign": {
#             "type": "string",
#             "description": "An astrological sign like Taurus or Aquarius"
#           }
#         }
#       }
#     },
#     {
#       "name": "get_compatibility",
#       "description": "Returns compatibility analysis between two zodiac signs, including a score and explanation.",
#       "parameters": {
#         "properties": {
#           "sign1": {
#             "type": "string",
#             "description": "The first zodiac sign (e.g., Aries, Taurus, Gemini)."
#           },
#           "sign2": {
#             "type": "string",
#             "description": "The second zodiac sign (e.g., Aries, Taurus, Gemini)."
#           },
#           "relationship_type": {
#             "type": "string",
#             "description": "Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)"
#           },
#           "detail_level": {
#             "type": "string",
#             "description": "Level of detail in the response. (e.g., short, medium, detailed)"
#           }
#         }
#       }
#     }
#   ]
# }

set jsonTools [new_CkJsonObject]

set toolIdx 0

CkJsonObject_put_I $jsonTools $toolIdx
CkJsonObject_UpdateString $jsonTools "tools[i].name" "get_horoscope"
CkJsonObject_UpdateString $jsonTools "tools[i].description" "Get today's horoscope for an astrological sign."
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign.type" "string"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign.description" "An astrological sign like Taurus or Aquarius"

set toolIdx [expr $toolIdx + 1]
CkJsonObject_put_I $jsonTools $toolIdx
CkJsonObject_UpdateString $jsonTools "tools[i].name" "get_compatibility"
CkJsonObject_UpdateString $jsonTools "tools[i].description" "Returns compatibility analysis between two zodiac signs, including a score and explanation."
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign1.type" "string"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign1.description" "The first zodiac sign (e.g., Aries, Taurus, Gemini)."
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign2.type" "string"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.sign2.description" "The second zodiac sign (e.g., Aries, Taurus, Gemini)."
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.relationship_type.type" "string"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.relationship_type.description" "Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.detail_level.type" "string"
CkJsonObject_UpdateString $jsonTools "tools[i].parameters.properties.detail_level.description" "Level of detail in the response. (e.g., short, medium, detailed)"

# More tools can be added as desired..

CkJsonObject_put_EmitCompact $jsonTools 0
puts [CkJsonObject_emit $jsonTools]

set ai [new_CkAi]

# Register the tools that will be made available to the AI.
CkAi_RegisterManualTools $ai $jsonTools

# 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 a horoscope generated by a tool. Use the tool output as the final answer."
CkAi_NewConvo $ai $conversation_name $sysMessage $devMessage

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

# Send inputs, tool functions, etc. and ask for a "text" response.
set success [CkAi_Ask $ai "text"]
if {$success == 0} then {
    puts [CkAi_lastErrorText $ai]
    delete_CkJsonObject $jsonTools
    delete_CkAi $ai
    exit
}

# Did the AI respond with requests for tool function calls?
if {[CkAi_get_HasFunctionCalls $ai] == 1} then {

    set jsonFn [new_CkJsonObject]

    CkJsonObject_put_EmitCompact $jsonFn 0

    CkAi_GetFunctionCalls $ai $jsonFn
    puts [CkJsonObject_emit $jsonFn]

    # Note: Chilkat will convert responses from all AI providers to this format:

    # {
    #   "function_call": [
    #     {
    #       "name": "get_horoscope",
    #       "call_id": "call_RYmeysYQFocFc7Z2ofkv61dW",
    #       "arguments": "{\"sign\":\"Aquarius\"}",
    #       "args": {
    #         "sign": "Aquarius"
    #       }
    #     }
    #   ]
    # }

    set numFnCalls [CkJsonObject_SizeOfArray $jsonFn "function_call"]
    set fn_idx 0
    while {$fn_idx < $numFnCalls} {
        CkJsonObject_put_I $jsonFn $fn_idx

        set sbFnName [new_CkStringBuilder]

        CkJsonObject_StringOfSb $jsonFn "function_call[i].name" $sbFnName
        set callId [CkJsonObject_stringOf $jsonFn "function_call[i].call_id"]

        if {[CkStringBuilder_ContentsEqual $sbFnName "get_horoscope" 1] == 1} then {

            # The get_horoscope function (as defined above) has one argument named "sign".
            set zodiac_sign [CkJsonObject_stringOf $jsonFn "function_call[i].args.sign"]
            puts "zodiac_sign = $zodiac_sign"

            # Insert application code here to call your app's get_horoscope function, passing the zodiac_sign to it..

            # For this example, we'll pretend the app's get_horoscope function returned the following:
            set applicationFnCallResult "Aquarius: Next Tuesday you will befriend a baby otter."

            # Provide the tool call result as an input for the followup Ask.
            CkAi_InputAddFnResult $ai $callId $applicationFnCallResult
        }

        # Your application would add code to check for and handle each possible function call.

        set fn_idx [expr $fn_idx + 1]
    }

    # After making the requested tool function calls, send the results back to the AI.
    set success [CkAi_Ask $ai "text"]
    if {$success == 0} then {
        puts [CkAi_lastErrorText $ai]
        delete_CkJsonObject $jsonTools
        delete_CkAi $ai
        delete_CkJsonObject $jsonFn
        delete_CkStringBuilder $sbFnName
        exit
    }

}

# Get the final AI response.
set sbResponse [new_CkStringBuilder]

CkAi_GetOutputTextSb $ai $sbResponse
puts [CkStringBuilder_getAsString $sbResponse]

delete_CkJsonObject $jsonTools
delete_CkAi $ai
delete_CkJsonObject $jsonFn
delete_CkStringBuilder $sbFnName
delete_CkStringBuilder $sbResponse