SQL Server

Automatic JS AI Tool Function Calling using Chilkat within the JavaScript

See more AI Examples

Demonstrates how to use Chilkat classes within the JavaScript in AI tool calls. Automatic JavaScript tool calls are characterized by:

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

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    DECLARE @sbJs int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJs OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @sbJs, 'LoadFile', @success OUT, 'qa_data/js_tools/stock_quote_tools.js', 'utf-8'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sbJs, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbJs
        RETURN
      END

    DECLARE @ai int
    EXEC @hr = sp_OACreate 'Chilkat.Ai', @ai OUT

    --  Register the tools that will be made available to the AI.
    DECLARE @evalOnly int
    SELECT @evalOnly = 0

    DECLARE @allowAllKeyword int
    SELECT @allowAllKeyword = 0

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

    EXEC sp_OAMethod @ai, 'RegisterJsTools', @success OUT, @sbJs, @evalOnly, @allowAllKeyword

    --  The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
    EXEC sp_OASetProperty @ai, 'Provider', 'openai'
    --  Use your provider's API key.
    EXEC sp_OASetProperty @ai, 'ApiKey', 'MY_API_KEY'
    --  Choose a model.
    EXEC sp_OASetProperty @ai, 'Model', 'gpt-5.6-luna'

    --  Tool function calling must always occur within a conversation.
    DECLARE @conversation_name nvarchar(4000)
    SELECT @conversation_name = 'convo_astrology'
    DECLARE @sysMessage nvarchar(4000)
    SELECT @sysMessage = 'You are a helpful astrologer'
    DECLARE @devMessage nvarchar(4000)
    SELECT @devMessage = 'Respond only with a horoscope generated by a tool. Use the tool output as the final answer.'
    EXEC sp_OAMethod @ai, 'NewConvo', @success OUT, @conversation_name, @sysMessage, @devMessage

    --  Provide inputs
    EXEC sp_OAMethod @ai, 'InputAddText', @success OUT, 'What is my horoscope? I am an Aquarius.'

    --  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.
    EXEC sp_OAMethod @ai, 'Ask', @success OUT, 'text'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ai, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbJs
        EXEC @hr = sp_OADestroy @ai
        RETURN
      END

    --  Get the AI response.
    DECLARE @sbResponse int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponse OUT

    EXEC sp_OAMethod @ai, 'GetOutputTextSb', @success OUT, @sbResponse
    EXEC sp_OAMethod @sbResponse, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @sbJs
    EXEC @hr = sp_OADestroy @ai
    EXEC @hr = sp_OADestroy @sbResponse


END
GO

JavaScript

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