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

integer li_rc
integer li_Success
oleobject loo_SbJs
oleobject loo_Ai
integer li_EvalOnly
integer li_AllowAllKeyword
string ls_Conversation_name
string ls_SysMessage
string ls_DevMessage
oleobject loo_SbEventName
oleobject loo_SbDelta
oleobject loo_SbFullResponse
integer li_MaxWaitMs
integer li_Finished
integer li_NumAsks
integer li_MadeFunctionCalls
integer li_StreamingDone
integer li_Result

li_Success = 0

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

loo_SbJs = create oleobject
li_rc = loo_SbJs.ConnectToNewObject("Chilkat.StringBuilder")
if li_rc < 0 then
    destroy loo_SbJs
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_SbJs.LoadFile("qa_data/js_tools/horoscope_tools.js","utf-8")
if li_Success = 0 then
    Write-Debug loo_SbJs.LastErrorText
    destroy loo_SbJs
    return
end if

loo_Ai = create oleobject
li_rc = loo_Ai.ConnectToNewObject("Chilkat.Ai")

// Register the tools that will be made available to the AI.
li_EvalOnly = 0
li_AllowAllKeyword = 1
loo_Ai.RegisterJsTools(loo_SbJs,li_EvalOnly,li_AllowAllKeyword)

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

// Tool function calling must always occur within a conversation.
ls_Conversation_name = "convo_astrology"
ls_SysMessage = "You are a helpful astrologer"
ls_DevMessage = "Respond only with markdown."
loo_Ai.NewConvo(ls_Conversation_name,ls_SysMessage,ls_DevMessage)

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

// Get the response in streaming mode.
loo_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.

loo_SbEventName = create oleobject
li_rc = loo_SbEventName.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbDelta = create oleobject
li_rc = loo_SbDelta.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbFullResponse = create oleobject
li_rc = loo_SbFullResponse.ConnectToNewObject("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..
li_MaxWaitMs = 5000

li_Finished = 0
li_NumAsks = 0
// Set a max # of followup Asks to prevent any unexpected infinite looping.
do while not li_Finished AND (li_NumAsks < 10)

    // Send the request to the AI model.
    li_Success = loo_Ai.Ask("text")
    if li_Success = 0 then
        Write-Debug loo_Ai.LastErrorText
        destroy loo_SbJs
        destroy loo_Ai
        destroy loo_SbEventName
        destroy loo_SbDelta
        destroy loo_SbFullResponse
        return
    end if

    li_MadeFunctionCalls = 0
    li_StreamingDone = 0

    do while not li_StreamingDone
        li_Result = loo_Ai.PollAi(0)
        if li_Result < 0 then
            Write-Debug loo_Ai.LastErrorText
            Write-Debug "Failed."
            destroy loo_SbJs
            destroy loo_Ai
            destroy loo_SbEventName
            destroy loo_SbDelta
            destroy loo_SbFullResponse
            return
        end if

        if li_Result > 0 then
            // We have an event..
            li_Success = loo_Ai.NextAiEvent(li_MaxWaitMs,loo_SbEventName,loo_SbDelta)
            if li_Success = 0 then
                Write-Debug loo_Ai.LastErrorText
                destroy loo_SbJs
                destroy loo_Ai
                destroy loo_SbEventName
                destroy loo_SbDelta
                destroy loo_SbFullResponse
                return
            end if

            // Is this an event where the AI is requesting a function call?
            if loo_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).
                li_Success = loo_Ai.StreamingJsToolCall(loo_SbDelta)
                if li_Success = 0 then
                    // The JS function call failed.
                    li_StreamingDone = 1
                else
                    li_MadeFunctionCalls = 1
                end if

            else
                if not loo_SbEventName.ContentsEqual("empty",1) then
                    loo_SbFullResponse.AppendSb(loo_SbDelta)

                    if loo_SbEventName.ContentsEqual("null_terminator",1) then
                        li_StreamingDone = 1
                    end if

                end if

            end if

        else
            // No event arrived, so wait a short time rather than spin in a loop..
            loo_Ai.SleepMs(100)
        end if

    loop

    if not li_MadeFunctionCalls then
        li_Finished = 1
    end if

    li_NumAsks = li_NumAsks + 1
loop

Write-Debug "Full Response:"
Write-Debug loo_SbFullResponse.GetAsString()


destroy loo_SbJs
destroy loo_Ai
destroy loo_SbEventName
destroy loo_SbDelta
destroy loo_SbFullResponse

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