(Visual FoxPro) Streaming AI with Manual AI Tool Function Calling

See more AI Examples

Note: This example requires Chilkat v11.4.0 or greater.

For more information, see https://www.chilkatsoft.com/ai_tool_function_caling_briefly_explained.asp

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL lnSuccess
LOCAL loJsonTools
LOCAL lnToolIdx
LOCAL loAi
LOCAL lcConversation_name
LOCAL lcSysMessage
LOCAL lcDevMessage
LOCAL loSbEventName
LOCAL loSbDelta
LOCAL loSbFullResponse
LOCAL lnMaxWaitMs
LOCAL loJsonFn
LOCAL lnFinished
LOCAL lnNumAsks
LOCAL lnMadeFunctionCalls
LOCAL lnStreamingDone
LOCAL lnResult
LOCAL lnNumFnCalls
LOCAL lnFn_idx
LOCAL loSbFnName
LOCAL lcCallId
LOCAL lcZodiac_sign
LOCAL lcApplicationFnCallResult

lnSuccess = 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 a single function 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"
*           }
*         }
*       }
*     }
*   ]
* }

loJsonTools = CreateObject('Chilkat.JsonObject')

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")
* More tools can be added as desired..

loJsonTools.EmitCompact = 0
? loJsonTools.Emit()

loAi = CreateObject('Chilkat.Ai')

* 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 markdown."
loAi.NewConvo(lcConversation_name,lcSysMessage,lcDevMessage)

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

* Get the response in streaming mode.
loAi.Streaming = 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.

loSbEventName = CreateObject('Chilkat.StringBuilder')
loSbDelta = CreateObject('Chilkat.StringBuilder')
loSbFullResponse = CreateObject('Chilkat.StringBuilder')

* 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..
lnMaxWaitMs = 5000

loJsonFn = CreateObject('Chilkat.JsonObject')

lnFinished = 0
lnNumAsks = 0
* Set a max # of followup Asks to prevent any unexpected infinite looping.
DO WHILE NOT lnFinished AND (lnNumAsks < 10)

    * Send the request to the AI model.
    lnSuccess = loAi.Ask("text")
    IF (lnSuccess = 0) THEN
        ? loAi.LastErrorText
        RELEASE loJsonTools
        RELEASE loAi
        RELEASE loSbEventName
        RELEASE loSbDelta
        RELEASE loSbFullResponse
        RELEASE loJsonFn
        CANCEL
    ENDIF

    lnMadeFunctionCalls = 0
    lnStreamingDone = 0

    DO WHILE NOT lnStreamingDone
        lnResult = loAi.PollAi(0)
        IF (lnResult < 0) THEN
            ? loAi.LastErrorText
            ? "Failed."
            RELEASE loJsonTools
            RELEASE loAi
            RELEASE loSbEventName
            RELEASE loSbDelta
            RELEASE loSbFullResponse
            RELEASE loJsonFn
            CANCEL
        ENDIF

        IF (lnResult > 0) THEN
            * We have an event..
            lnSuccess = loAi.NextAiEvent(lnMaxWaitMs,loSbEventName,loSbDelta)
            IF (lnSuccess = 0) THEN
                ? loAi.LastErrorText
                RELEASE loJsonTools
                RELEASE loAi
                RELEASE loSbEventName
                RELEASE loSbDelta
                RELEASE loSbFullResponse
                RELEASE loJsonFn
                CANCEL
            ENDIF

            * Is this an event where the AI is requesting a function call?
            IF (loSbEventName.ContentsEqual("function_call",1)) THEN
                loJsonFn.LoadSb(loSbDelta)

                * 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('Chilkat.StringBuilder')
                    loJsonFn.StringOfSb("function_call[i].name",loSbFnName)
                    lcCallId = loJsonFn.StringOf("function_call[i].call_id")

                    IF (loSbFnName.ContentsEqual("get_horoscope",1) = 1) 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)

                        lnMadeFunctionCalls = 1
                    ENDIF

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

                    lnFn_idx = lnFn_idx + 1
                ENDDO

            ELSE
                IF (NOT loSbEventName.ContentsEqual("empty",1)) THEN
                    loSbFullResponse.AppendSb(loSbDelta)

                    IF (loSbEventName.ContentsEqual("null_terminator",1)) THEN
                        lnStreamingDone = 1
                    ENDIF

                ENDIF

            ENDIF

        ELSE
            * No event arrived, so wait a short time rather than spin in a loop..
            loAi.SleepMs(100)
        ENDIF

    ENDDO

    IF (NOT lnMadeFunctionCalls) THEN
        lnFinished = 1
    ENDIF

    lnNumAsks = lnNumAsks + 1
ENDDO

? "Full Response:"
? loSbFullResponse.GetAsString()

RELEASE loJsonTools
RELEASE loAi
RELEASE loSbEventName
RELEASE loSbDelta
RELEASE loSbFullResponse
RELEASE loJsonFn
RELEASE loSbFnName