C
C
Streaming AI with Manual AI Tool Function Calling
See more AI Examples
Demonstrates how to get AI responses in streaming mode, including manual tool function calls.Chilkat C Downloads
#include <C_CkJsonObject.h>
#include <C_CkAi.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObject jsonTools;
int toolIdx;
HCkAi ai;
const char *conversation_name;
const char *sysMessage;
const char *devMessage;
HCkStringBuilder sbEventName;
HCkStringBuilder sbDelta;
HCkStringBuilder sbFullResponse;
int maxWaitMs;
HCkJsonObject jsonFn;
BOOL finished;
int numAsks;
BOOL madeFunctionCalls;
BOOL streamingDone;
int result;
int numFnCalls;
int fn_idx;
HCkStringBuilder sbFnName;
const char *callId;
const char *zodiac_sign;
const char *applicationFnCallResult;
success = FALSE;
// Create the following JSON to define tool functions available for the AI to use.
// Note: You'll use the following JSON format regardless of the AI provider, whether
// it be ChatGPT, Gemini, Claude, Grok, etc. Chilkat automatically converts to the required
// format needed for a given AI provider.
// In this example, the application is providing a single function the AI may choose to call.
// {
// "tools": [
// {
// "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"
// }
// }
// }
// }
// ]
// }
jsonTools = CkJsonObject_Create();
toolIdx = 0;
CkJsonObject_putI(jsonTools,toolIdx);
CkJsonObject_UpdateString(jsonTools,"tools[i].name","get_horoscope");
CkJsonObject_UpdateString(jsonTools,"tools[i].description","Get today's horoscope for an astrological sign.");
CkJsonObject_UpdateString(jsonTools,"tools[i].parameters.properties.sign.type","string");
CkJsonObject_UpdateString(jsonTools,"tools[i].parameters.properties.sign.description","An astrological sign like Taurus or Aquarius");
// More tools can be added as desired..
CkJsonObject_putEmitCompact(jsonTools,FALSE);
printf("%s\n",CkJsonObject_emit(jsonTools));
ai = CkAi_Create();
// Register the tools that will be made available to the AI.
CkAi_RegisterManualTools(ai,jsonTools);
// The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
CkAi_putProvider(ai,"openai");
// Use your provider's API key.
CkAi_putApiKey(ai,"MY_API_KEY");
// Choose a model.
CkAi_putModel(ai,"gpt-5-mini");
// Tool function calling must always occur within a conversation.
conversation_name = "convo_astrology";
sysMessage = "You are a helpful astrologer";
devMessage = "Respond only with markdown.";
CkAi_NewConvo(ai,conversation_name,sysMessage,devMessage);
// Provide inputs
CkAi_InputAddText(ai,"What is my horoscope? I am an Aquarius.");
// Get the response in streaming mode.
CkAi_putStreaming(ai,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.
sbEventName = CkStringBuilder_Create();
sbDelta = CkStringBuilder_Create();
sbFullResponse = CkStringBuilder_Create();
// 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..
maxWaitMs = 5000;
jsonFn = CkJsonObject_Create();
finished = FALSE;
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 = CkAi_Ask(ai,"text");
if (success == FALSE) {
printf("%s\n",CkAi_lastErrorText(ai));
CkJsonObject_Dispose(jsonTools);
CkAi_Dispose(ai);
CkStringBuilder_Dispose(sbEventName);
CkStringBuilder_Dispose(sbDelta);
CkStringBuilder_Dispose(sbFullResponse);
CkJsonObject_Dispose(jsonFn);
return;
}
madeFunctionCalls = FALSE;
streamingDone = FALSE;
while (!streamingDone) {
result = CkAi_PollAi(ai,FALSE);
if (result < 0) {
printf("%s\n",CkAi_lastErrorText(ai));
printf("Failed.\n");
CkJsonObject_Dispose(jsonTools);
CkAi_Dispose(ai);
CkStringBuilder_Dispose(sbEventName);
CkStringBuilder_Dispose(sbDelta);
CkStringBuilder_Dispose(sbFullResponse);
CkJsonObject_Dispose(jsonFn);
return;
}
if (result > 0) {
// We have an event..
success = CkAi_NextAiEvent(ai,maxWaitMs,sbEventName,sbDelta);
if (success == FALSE) {
printf("%s\n",CkAi_lastErrorText(ai));
CkJsonObject_Dispose(jsonTools);
CkAi_Dispose(ai);
CkStringBuilder_Dispose(sbEventName);
CkStringBuilder_Dispose(sbDelta);
CkStringBuilder_Dispose(sbFullResponse);
CkJsonObject_Dispose(jsonFn);
return;
}
// Is this an event where the AI is requesting a function call?
if (CkStringBuilder_ContentsEqual(sbEventName,"function_call",TRUE)) {
CkJsonObject_LoadSb(jsonFn,sbDelta);
// Note: Chilkat will convert responses from all AI providers to this format:
// {
// "function_call": [
// {
// "name": "get_horoscope",
// "call_id": "call_RYmeysYQFocFc7Z2ofkv61dW",
// "arguments": "{\"sign\":\"Aquarius\"}",
// "args": {
// "sign": "Aquarius"
// }
// }
// ]
// }
numFnCalls = CkJsonObject_SizeOfArray(jsonFn,"function_call");
fn_idx = 0;
while ((fn_idx < numFnCalls)) {
CkJsonObject_putI(jsonFn,fn_idx);
sbFnName = CkStringBuilder_Create();
CkJsonObject_StringOfSb(jsonFn,"function_call[i].name",sbFnName);
callId = CkJsonObject_stringOf(jsonFn,"function_call[i].call_id");
if (CkStringBuilder_ContentsEqual(sbFnName,"get_horoscope",TRUE) == TRUE) {
// The get_horoscope function (as defined above) has one argument named "sign".
zodiac_sign = CkJsonObject_stringOf(jsonFn,"function_call[i].args.sign");
printf("zodiac_sign = %s\n",zodiac_sign);
// Insert application code here to call your app's get_horoscope function, passing the zodiac_sign to it..
// For this example, we'll pretend the app's get_horoscope function returned the following:
applicationFnCallResult = "Aquarius: Next Tuesday you will befriend a baby otter.";
// Provide the tool call result as an input for the followup Ask.
CkAi_InputAddFnResult(ai,callId,applicationFnCallResult);
madeFunctionCalls = TRUE;
}
// Your application would add code to check for and handle each possible function call.
fn_idx = fn_idx + 1;
}
}
else {
if (!CkStringBuilder_ContentsEqual(sbEventName,"empty",TRUE)) {
CkStringBuilder_AppendSb(sbFullResponse,sbDelta);
if (CkStringBuilder_ContentsEqual(sbEventName,"null_terminator",TRUE)) {
streamingDone = TRUE;
}
}
}
}
else {
// No event arrived, so wait a short time rather than spin in a loop..
CkAi_SleepMs(ai,100);
}
}
if (!madeFunctionCalls) {
finished = TRUE;
}
numAsks = numAsks + 1;
}
printf("Full Response:\n");
printf("%s\n",CkStringBuilder_getAsString(sbFullResponse));
CkJsonObject_Dispose(jsonTools);
CkAi_Dispose(ai);
CkStringBuilder_Dispose(sbEventName);
CkStringBuilder_Dispose(sbDelta);
CkStringBuilder_Dispose(sbFullResponse);
CkJsonObject_Dispose(jsonFn);
CkStringBuilder_Dispose(sbFnName);
}