Lianja

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. Lianja

llSuccess = .F.

// 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)"
//           }
//         }
//       }
//     }
//   ]
// }

loJsonTools = createobject("CkJsonObject")

lnToolIdx = 0

loJsonTools.I = lnToolIdx
loJsonTools.UpdateString("tools[i].name","get_horoscope")
loJsonTools.UpdateString("tools[i].description","Get today's horoscope for an astrological sign.")
loJsonTools.UpdateString("tools[i].parameters.properties.sign.type","string")
loJsonTools.UpdateString("tools[i].parameters.properties.sign.description","An astrological sign like Taurus or Aquarius")

lnToolIdx = lnToolIdx + 1
loJsonTools.I = lnToolIdx
loJsonTools.UpdateString("tools[i].name","get_compatibility")
loJsonTools.UpdateString("tools[i].description","Returns compatibility analysis between two zodiac signs, including a score and explanation.")
loJsonTools.UpdateString("tools[i].parameters.properties.sign1.type","string")
loJsonTools.UpdateString("tools[i].parameters.properties.sign1.description","The first zodiac sign (e.g., Aries, Taurus, Gemini).")
loJsonTools.UpdateString("tools[i].parameters.properties.sign2.type","string")
loJsonTools.UpdateString("tools[i].parameters.properties.sign2.description","The second zodiac sign (e.g., Aries, Taurus, Gemini).")
loJsonTools.UpdateString("tools[i].parameters.properties.relationship_type.type","string")
loJsonTools.UpdateString("tools[i].parameters.properties.relationship_type.description","Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)")
loJsonTools.UpdateString("tools[i].parameters.properties.detail_level.type","string")
loJsonTools.UpdateString("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..

loJsonTools.EmitCompact = .F.
? loJsonTools.Emit()

loAi = createobject("CkAi")

// Register the tools that will be made available to the AI.
loAi.RegisterManualTools(loJsonTools)

// The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
loAi.Provider = "openai"
// Use your provider's API key.
loAi.ApiKey = "MY_API_KEY"
// Choose a model.
loAi.Model = "gpt-5-mini"

// Tool function calling must always occur within a conversation.
lcConversation_name = "convo_astrology"
lcSysMessage = "You are a helpful astrologer"
lcDevMessage = "Respond only with a horoscope generated by a tool. Use the tool output as the final answer."
loAi.NewConvo(lcConversation_name,lcSysMessage,lcDevMessage)

// Provide inputs
loAi.InputAddText("What is my horoscope? I am an Aquarius.")

// Send inputs, tool functions, etc. and ask for a "text" response.
llSuccess = loAi.Ask("text")
if (llSuccess = .F.) then
    ? loAi.LastErrorText
    release loJsonTools
    release loAi
    return
endif

// Did the AI respond with requests for tool function calls?
if (loAi.HasFunctionCalls = .T.) then

    loJsonFn = createobject("CkJsonObject")
    loJsonFn.EmitCompact = .F.

    loAi.GetFunctionCalls(loJsonFn)
    ? loJsonFn.Emit()

    // 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"
    //       }
    //     }
    //   ]
    // }

    lnNumFnCalls = loJsonFn.SizeOfArray("function_call")
    lnFn_idx = 0
    do while (lnFn_idx < lnNumFnCalls)
        loJsonFn.I = lnFn_idx

        loSbFnName = createobject("CkStringBuilder")
        loJsonFn.StringOfSb("function_call[i].name",loSbFnName)
        lcCallId = loJsonFn.StringOf("function_call[i].call_id")

        if (loSbFnName.ContentsEqual("get_horoscope",.T.) = .T.) then

            // The get_horoscope function (as defined above) has one argument named "sign".
            lcZodiac_sign = loJsonFn.StringOf("function_call[i].args.sign")
            ? "zodiac_sign = " + lcZodiac_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:
            lcApplicationFnCallResult = "Aquarius: Next Tuesday you will befriend a baby otter."

            // Provide the tool call result as an input for the followup Ask.
            loAi.InputAddFnResult(lcCallId,lcApplicationFnCallResult)
        endif

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

        lnFn_idx = lnFn_idx + 1
    enddo

    // After making the requested tool function calls, send the results back to the AI.
    llSuccess = loAi.Ask("text")
    if (llSuccess = .F.) then
        ? loAi.LastErrorText
        release loJsonTools
        release loAi
        release loJsonFn
        release loSbFnName
        return
    endif

endif

// Get the final AI response.
loSbResponse = createobject("CkStringBuilder")
loAi.GetOutputTextSb(loSbResponse)
? loSbResponse.GetAsString()


release loJsonTools
release loAi
release loJsonFn
release loSbFnName
release loSbResponse