(DataFlex) Automatic JS AI Tool Function Calling using Chilkat within the JavaScript

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

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vSbJs
    Handle hoSbJs
    Handle hoAi
    Boolean iEvalOnly
    Boolean iAllowAllKeyword
    String sConversation_name
    String sSysMessage
    String sDevMessage
    Variant vSbResponse
    Handle hoSbResponse
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJs
    If (Not(IsComObjectCreated(hoSbJs))) Begin
        Send CreateComObject of hoSbJs
    End
    Get ComLoadFile Of hoSbJs "qa_data/js_tools/stock_quote_tools.js" "utf-8" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSbJs To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatAi)) To hoAi
    If (Not(IsComObjectCreated(hoAi))) Begin
        Send CreateComObject of hoAi
    End

    // Register the tools that will be made available to the AI.
    Move False To iEvalOnly

    Move False To iAllowAllKeyword

    // If we were to set allowAllKeyword = True, then we could
    // give all Chilkat classes permission, like this:
    // 
    // Example.toolPermissions = [
    // 	  {
    // 	    name: "all",
    // 	    perm: "sandbox",
    // 	  }
    // 	];

    Get pvComObject of hoSbJs to vSbJs
    Get ComRegisterJsTools Of hoAi vSbJs iEvalOnly iAllowAllKeyword To iSuccess

    // The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
    Set ComProvider Of hoAi To "openai"
    // Use your provider's API key.
    Set ComApiKey Of hoAi To "MY_API_KEY"
    // Choose a model.
    Set ComModel Of hoAi To "gpt-5-mini"

    // Tool function calling must always occur within a conversation.
    Move "convo_astrology" To sConversation_name
    Move "You are a helpful astrologer" To sSysMessage
    Move "Respond only with a horoscope generated by a tool. Use the tool output as the final answer." To sDevMessage
    Get ComNewConvo Of hoAi sConversation_name sSysMessage sDevMessage To iSuccess

    // Provide inputs
    Get ComInputAddText Of hoAi "What is my horoscope? I am an Aquarius." To iSuccess

    // Send inputs, tool functions, etc. and ask for a "text" response.
    // If the AI responds with tool calls, Chilkat automatically handles them by calling your JavaScript
    // tool functions as directed by the AI, and sending results back to the AI until the final
    // response is received.
    Get ComAsk Of hoAi "text" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoAi To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Get the AI response.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponse
    If (Not(IsComObjectCreated(hoSbResponse))) Begin
        Send CreateComObject of hoSbResponse
    End
    Get pvComObject of hoSbResponse to vSbResponse
    Get ComGetOutputTextSb Of hoAi vSbResponse To iSuccess
    Get ComGetAsString Of hoSbResponse To sTemp1
    Showln sTemp1


End_Procedure

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

// The function name used here must match the "name" in the toolRegistry below.
// Tool functions must ALWAYS have just a single argument, which is an object.
Example.get_stock_quote = function(arg) {
	
	var success = false;

	// Replace with your actual Finnhub API key.
	var apiKey = "YOUR_FINNHUB_API_KEY";
	var symbol = `${arg.symbol}`;

	var http = new CkHttp();

	// This is the URL without params.
	var urlWithoutParams = "https://finnhub.io/api/v1/quote";

	var req = new CkHttpRequest();

	// Add params that will be sent in the URL.
	req.AddParam("symbol",symbol);
	req.AddParam("token",apiKey);

	req.HttpVerb = "GET";

	// Send the request to get the JSON response.
	var resp = new CkHttpResponse();
	success = http.HttpReq(urlWithoutParams,req,resp);
	if (success == false) {
	    return http.LastErrorText;
	}

	var json = new CkJsonObject();
	resp.GetBodyJson(json);

	var statusCode = resp.StatusCode;

	// Sample result:

	// {
	//   "c": 248.8,
	//   "d": -4.09,
	//   "dp": -1.6173,
	//   "h": 255.493,
	//   "l": 248.07,
	//   "o": 253.9,
	//   "pc": 252.89,
	//   "t": 1774641600
	// }

	if (statusCode == 200) {
	    // Add the symbol to the top of the result.
	    json.AddStringAt(0,"symbol",symbol);

	    // Rename members for clarification.
	    json.Rename("c","currentPrice");
	    json.Rename("d","change");
	    json.Rename("dp","percentChange");
	    json.Rename("h","high");
	    json.Rename("l","low");
	    json.Rename("o","open");
	    json.Rename("pc","prevClose");
	    json.Delete("t");
	}

    return json.Emit();
}


// 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_stock_quote",
    description: "Get a current (live) stock quote.",
    parameters: {
      properties: {
		symbol: { type: "string", description: "The stock ticker symbol." }
      },
    }
  }
];


// Indicate the Chilkat objects allowed to be created and used.
// "sandbox" means the object can be used for its intended functionality (such as HTTP),
// but it cannot read or write to the local filesystem. 
 // Any Chilkat method that tries to interact with the local filesystem will fail.
 
 // The other possible permissions are:
 // "readOnly" -- Allows reading files in the local filesystem, and listing directories.
 // "writeOnly" -- Only allows writing files, renaming files, deleting files, but not reading files or getting directory listings.
 // "readWrite" -- Full local filesystem read/write permission.
 // 
 // A JavaScript exception will be thrown if there is an attempt to instantiate a Chilkat object without listed permissions.
 // The keyword "all" can be used for the name, but only if the application's call to RegisterJsTools allows the "all" keyword.
Example.toolPermissions = [
	  {
	    name: "CkHttp",
	    perm: "sandbox",
	  },
	  {
	    name: "CkHttpRequest",
	    perm: "sandbox",
	  },
	  {
	    name: "CkHttpResponse",
	    perm: "sandbox",
	  },
	  {
	    name: "CkDateTime",
	    perm: "sandbox",
	  },
	  {
	    name: "CkJsonObject",
	    perm: "sandbox",
	  }
	];
	
	
// Return the name of this toolset
// This tells Chilkat the namespace of this toolset.
"Example";