SQL Server
SQL Server
Streaming AI with Automatic JavaScript AI Tool Function Calling
See more AI Examples
Demonstrates how to get AI responses in streaming mode, including possible tool function calling using Chilkat with embedded Chilkat.Js JavaScript. 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.
Chilkat SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
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/horoscope_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 = 1
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-mini'
-- 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 markdown.'
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.'
-- Get the response in streaming mode.
EXEC sp_OASetProperty @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.
DECLARE @sbEventName int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbEventName OUT
DECLARE @sbDelta int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbDelta OUT
DECLARE @sbFullResponse int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbFullResponse OUT
-- 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..
DECLARE @maxWaitMs int
SELECT @maxWaitMs = 5000
DECLARE @finished int
SELECT @finished = 0
DECLARE @numAsks int
SELECT @numAsks = 0
-- Set a max # of followup Asks to prevent any unexpected infinite looping.
WHILE Not @finished and (@numAsks < 10)
BEGIN
-- Send the request to the AI model.
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
EXEC @hr = sp_OADestroy @sbEventName
EXEC @hr = sp_OADestroy @sbDelta
EXEC @hr = sp_OADestroy @sbFullResponse
RETURN
END
DECLARE @madeFunctionCalls int
SELECT @madeFunctionCalls = 0
DECLARE @streamingDone int
SELECT @streamingDone = 0
WHILE Not @streamingDone
BEGIN
DECLARE @result int
EXEC sp_OAMethod @ai, 'PollAi', @result OUT, 0
IF @result < 0
BEGIN
EXEC sp_OAGetProperty @ai, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @sbJs
EXEC @hr = sp_OADestroy @ai
EXEC @hr = sp_OADestroy @sbEventName
EXEC @hr = sp_OADestroy @sbDelta
EXEC @hr = sp_OADestroy @sbFullResponse
RETURN
END
IF @result > 0
BEGIN
-- We have an event..
EXEC sp_OAMethod @ai, 'NextAiEvent', @success OUT, @maxWaitMs, @sbEventName, @sbDelta
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @ai, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @sbJs
EXEC @hr = sp_OADestroy @ai
EXEC @hr = sp_OADestroy @sbEventName
EXEC @hr = sp_OADestroy @sbDelta
EXEC @hr = sp_OADestroy @sbFullResponse
RETURN
END
-- Is this an event where the AI is requesting a function call?
EXEC sp_OAMethod @sbEventName, 'ContentsEqual', @iTmp0 OUT, 'js_function_call', 1
IF @iTmp0
BEGIN
-- 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).
EXEC sp_OAMethod @ai, 'StreamingJsToolCall', @success OUT, @sbDelta
IF @success = 0
BEGIN
-- The JS function call failed.
SELECT @streamingDone = 1
END
ELSE
BEGIN
SELECT @madeFunctionCalls = 1
END
END
ELSE
BEGIN
EXEC sp_OAMethod @sbEventName, 'ContentsEqual', @iTmp0 OUT, 'empty', 1
IF Not @iTmp0
BEGIN
EXEC sp_OAMethod @sbFullResponse, 'AppendSb', @success OUT, @sbDelta
EXEC sp_OAMethod @sbEventName, 'ContentsEqual', @iTmp0 OUT, 'null_terminator', 1
IF @iTmp0
BEGIN
SELECT @streamingDone = 1
END
END
END
END
ELSE
BEGIN
-- No event arrived, so wait a short time rather than spin in a loop..
EXEC sp_OAMethod @ai, 'SleepMs', NULL, 100
END
END
IF Not @madeFunctionCalls
BEGIN
SELECT @finished = 1
END
SELECT @numAsks = @numAsks + 1
END
PRINT 'Full Response:'
EXEC sp_OAMethod @sbFullResponse, 'GetAsString', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @sbJs
EXEC @hr = sp_OADestroy @ai
EXEC @hr = sp_OADestroy @sbEventName
EXEC @hr = sp_OADestroy @sbDelta
EXEC @hr = sp_OADestroy @sbFullResponse
END
GO