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

LOCAL lnSuccess
LOCAL loSbJs
LOCAL loAi
LOCAL lnEvalOnly
LOCAL lnAllowAllKeyword
LOCAL lcConversation_name
LOCAL lcSysMessage
LOCAL lcDevMessage
LOCAL loSbEventName
LOCAL loSbDelta
LOCAL loSbFullResponse
LOCAL lnMaxWaitMs
LOCAL lnFinished
LOCAL lnNumAsks
LOCAL lnMadeFunctionCalls
LOCAL lnStreamingDone
LOCAL lnResult

lnSuccess = 0

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

loSbJs = CreateObject('Chilkat.StringBuilder')
lnSuccess = loSbJs.LoadFile("qa_data/js_tools/horoscope_tools.js","utf-8")
IF (lnSuccess = 0) THEN
    ? loSbJs.LastErrorText
    RELEASE loSbJs
    CANCEL
ENDIF

loAi = CreateObject('Chilkat.Ai')

* Register the tools that will be made available to the AI.
lnEvalOnly = 0
lnAllowAllKeyword = 1
loAi.RegisterJsTools(loSbJs,lnEvalOnly,lnAllowAllKeyword)

* 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

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 loSbJs
        RELEASE loAi
        RELEASE loSbEventName
        RELEASE loSbDelta
        RELEASE loSbFullResponse
        CANCEL
    ENDIF

    lnMadeFunctionCalls = 0
    lnStreamingDone = 0

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

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

            * Is this an event where the AI is requesting a function call?
            IF (loSbEventName.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).
                lnSuccess = loAi.StreamingJsToolCall(loSbDelta)
                IF (lnSuccess = 0) THEN
                    * The JS function call failed.
                    lnStreamingDone = 1
                ELSE
                    lnMadeFunctionCalls = 1
                ENDIF

            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 loSbJs
RELEASE loAi
RELEASE loSbEventName
RELEASE loSbDelta
RELEASE loSbFullResponse

// 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";