(JavaScript) 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/automatic_ai_javascript_tool_function_calling.asp

var success = false;

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

var sbJs = new CkStringBuilder();
success = sbJs.LoadFile("qa_data/js_tools/horoscope_tools.js","utf-8");
if (success == false) {
    console.log(sbJs.LastErrorText);
    return;
}

var ai = new CkAi();

// Register the tools that will be made available to the AI.
var evalOnly = false;
var allowAllKeyword = true;
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.
var conversation_name = "convo_astrology";
var sysMessage = "You are a helpful astrologer";
var devMessage = "Respond only with markdown.";
ai.NewConvo(conversation_name,sysMessage,devMessage);

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

// Get the response in streaming mode.
ai.Streaming = true;

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

var sbEventName = new CkStringBuilder();
var sbDelta = new CkStringBuilder();
var sbFullResponse = new CkStringBuilder();

// 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..
var maxWaitMs = 5000;

var finished = false;
var numAsks = 0;
// Set a max # of followup Asks to prevent any unexpected infinite looping.
while (!finished && (numAsks < 10)) {

    // Send the request to the AI model.
    success = ai.Ask("text");
    if (success == false) {
        console.log(ai.LastErrorText);
        return;
    }

    var madeFunctionCalls = false;
    var streamingDone = false;

    while (!streamingDone) {
        var result = ai.PollAi(false);
        if (result < 0) {
            console.log(ai.LastErrorText);
            console.log("Failed.");
            return;
        }

        if (result > 0) {
            // We have an event..
            success = ai.NextAiEvent(maxWaitMs,sbEventName,sbDelta);
            if (success == false) {
                console.log(ai.LastErrorText);
                return;
            }

            // Is this an event where the AI is requesting a function call?
            if (sbEventName.ContentsEqual("js_function_call",true)) {
                // 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 == false) {
                    // The JS function call failed.
                    streamingDone = true;
                }
                else {
                    madeFunctionCalls = true;
                }

            }
            else {
                if (!sbEventName.ContentsEqual("empty",true)) {
                    sbFullResponse.AppendSb(sbDelta);

                    if (sbEventName.ContentsEqual("null_terminator",true)) {
                        streamingDone = true;
                    }

                }

            }

        }
        else {
            // No event arrived, so wait a short time rather than spin in a loop..
            ai.SleepMs(100);
        }

    }

    if (!madeFunctionCalls) {
        finished = true;
    }

    numAsks = numAsks+1;
}

console.log("Full Response:");
console.log(sbFullResponse.GetAsString());