(Visual Basic 6.0) Streaming AI with Automatic JavaScript AI Tool Function Calling

See more AI Examples

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

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

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

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

Dim success As Long
success = 0

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

Dim sbJs As New ChilkatStringBuilder
success = sbJs.LoadFile("qa_data/js_tools/horoscope_tools.js","utf-8")
If (success = 0) Then
    Debug.Print sbJs.LastErrorText
    Exit Sub
End If

Dim ai As New ChilkatAi

' Register the tools that will be made available to the AI.
Dim evalOnly As Long
evalOnly = 0
Dim allowAllKeyword As Long
allowAllKeyword = 1
success = ai.RegisterJsTools(sbJs,evalOnly,allowAllKeyword)

' 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 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("js_function_call",1)) 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).
                success = ai.StreamingJsToolCall(sbDelta)
                If (success = 0) Then
                    ' The JS function call failed.
                    streamingDone = 1
                Else
                    madeFunctionCalls = 1
                End If

            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()

// The namespace for the AI tool functions in this JavaScript source file.
// You must provide a namespace.
Example = {};

// ----------------------------
// Tool implementation functions
// -----------------------------
// Tool functions must ALWAYS have just a single argument, which is an object.

// The function name used here must match the "name" in the toolRegistry below.

// By grouping get_compatibility, get_horoscope, toolRegistry, and toolPermissions under the Example object, 
// you are "namespacing" them. This tells anyone reading the code (and the JavaScript engine itself) 
// that these tools belong together and prevents them from clashing with another function that might 
// also be named get_horoscope. 

Example.get_compatibility = function(arg) {
  return  `${arg.sign1} is compatible with ${arg.sign2} in a ${arg.relationship_type} way.`;
}

Example.get_horoscope = function(arg) {
  return  `${arg.sign} : Next Tuesday you will befriend a baby otter.`;
}


// -------------
// Tool Registry
// -------------
// The inputSchema.type must ALWAYS be "object".
// Use this format regardless of the AI provider (ChatGPT, Gemini, Claude, Grok, Mistral, etc.)
Example.toolRegistry = [
  {
    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)"
          }
        }
      }
  }
];

Example.toolPermissions = [
	  {
	    name: "all",
	    perm: "sandbox",
	  }
	  		
	];
	
// Return the name of this toolset
// This tells Chilkat the namespace of this toolset.
"Example";