(Visual Basic 6.0) 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

Dim success As Long
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 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"
'           }
'         }
'       }
'     }
'   ]
' }

Dim jsonTools As New ChilkatJsonObject

Dim toolIdx As Long
toolIdx = 0

jsonTools.I = toolIdx
success = jsonTools.UpdateString("tools[i].name","get_horoscope")
success = jsonTools.UpdateString("tools[i].description","Get today's horoscope for an astrological sign.")
success = jsonTools.UpdateString("tools[i].parameters.properties.sign.type","string")
success = jsonTools.UpdateString("tools[i].parameters.properties.sign.description","An astrological sign like Taurus or Aquarius")
' More tools can be added as desired..

jsonTools.EmitCompact = 0
Debug.Print jsonTools.Emit()

Dim ai As New ChilkatAi

' Register the tools that will be made available to the AI.
success = ai.RegisterManualTools(jsonTools)

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

' Tool function calling must always occur within a conversation.
Dim conversation_name As String
conversation_name = "convo_astrology"
Dim sysMessage As String
sysMessage = "You are a helpful astrologer"
Dim devMessage As String
devMessage = "Respond only with markdown."
success = ai.NewConvo(conversation_name,sysMessage,devMessage)

' Provide inputs
success = ai.InputAddText("What is my horoscope? I am an Aquarius.")

' Get the response in streaming mode.
ai.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.

Dim sbEventName As New ChilkatStringBuilder
Dim sbDelta As New ChilkatStringBuilder
Dim sbFullResponse As New ChilkatStringBuilder

' 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..
Dim maxWaitMs As Long
maxWaitMs = 5000

Dim jsonFn As New ChilkatJsonObject

Dim finished As Long
finished = 0
Dim numAsks As Long
numAsks = 0
' Set a max # of followup Asks to prevent any unexpected infinite looping.
Do While Not finished And (numAsks < 10)

    ' Send the request to the AI model.
    success = ai.Ask("text")
    If (success = 0) Then
        Debug.Print ai.LastErrorText
        Exit Sub
    End If

    Dim madeFunctionCalls As Long
    madeFunctionCalls = 0
    Dim streamingDone As Long
    streamingDone = 0

    Do While Not streamingDone
        Dim result As Long
        result = ai.PollAi(0)
        If (result < 0) Then
            Debug.Print ai.LastErrorText
            Debug.Print "Failed."
            Exit Sub
        End If

        If (result > 0) Then
            ' We have an event..
            success = ai.NextAiEvent(maxWaitMs,sbEventName,sbDelta)
            If (success = 0) Then
                Debug.Print ai.LastErrorText
                Exit Sub
            End If

            ' Is this an event where the AI is requesting a function call?
            If (sbEventName.ContentsEqual("function_call",1)) Then
                success = jsonFn.LoadSb(sbDelta)

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

                Dim numFnCalls As Long
                numFnCalls = jsonFn.SizeOfArray("function_call")
                Dim fn_idx As Long
                fn_idx = 0
                Do While (fn_idx < numFnCalls)
                    jsonFn.I = fn_idx

                    Dim sbFnName As New ChilkatStringBuilder
                    success = jsonFn.StringOfSb("function_call[i].name",sbFnName)
                    Dim callId As String
                    callId = jsonFn.StringOf("function_call[i].call_id")

                    If (sbFnName.ContentsEqual("get_horoscope",1) = 1) Then

                        ' The get_horoscope function (as defined above) has one argument named "sign".
                        Dim zodiac_sign As String
                        zodiac_sign = jsonFn.StringOf("function_call[i].args.sign")
                        Debug.Print "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:
                        Dim applicationFnCallResult As String
                        applicationFnCallResult = "Aquarius: Next Tuesday you will befriend a baby otter."

                        ' Provide the tool call result as an input for the followup Ask.
                        success = ai.InputAddFnResult(callId,applicationFnCallResult)

                        madeFunctionCalls = 1
                    End If

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

                    fn_idx = fn_idx + 1
                Loop

            Else
                If (Not sbEventName.ContentsEqual("empty",1)) Then
                    success = sbFullResponse.AppendSb(sbDelta)

                    If (sbEventName.ContentsEqual("null_terminator",1)) Then
                        streamingDone = 1
                    End If

                End If

            End If

        Else
            ' No event arrived, so wait a short time rather than spin in a loop..
            ai.SleepMs 100
        End If

    Loop

    If (Not madeFunctionCalls) Then
        finished = 1
    End If

    numAsks = numAsks + 1
Loop

Debug.Print "Full Response:"
Debug.Print sbFullResponse.GetAsString()