(JavaScript) Demonstrates Manual Tool Function Calls

See more AI Examples

Note: This example requires Chilkat v11.4.0 or greater.

For more information, see https://www.chilkatsoft.com/ai_tool_function_caling_briefly_explained.asp

var 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 two functions 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"
//           }
//         }
//       }
//     },
//     {
//       "name": "get_compatibility",
//       "description": "Returns compatibility analysis between two zodiac signs, including a score and explanation.",
//       "parameters": {
//         "properties": {
//           "sign1": {
//             "type": "string",
//             "description": "The first zodiac sign (e.g., Aries, Taurus, Gemini)."
//           },
//           "sign2": {
//             "type": "string",
//             "description": "The second zodiac sign (e.g., Aries, Taurus, Gemini)."
//           },
//           "relationship_type": {
//             "type": "string",
//             "description": "Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)"
//           },
//           "detail_level": {
//             "type": "string",
//             "description": "Level of detail in the response. (e.g., short, medium, detailed)"
//           }
//         }
//       }
//     }
//   ]
// }

var jsonTools = new CkJsonObject();

var toolIdx = 0;

jsonTools.I = toolIdx;
jsonTools.UpdateString("tools[i].name","get_horoscope");
jsonTools.UpdateString("tools[i].description","Get today's horoscope for an astrological sign.");
jsonTools.UpdateString("tools[i].parameters.properties.sign.type","string");
jsonTools.UpdateString("tools[i].parameters.properties.sign.description","An astrological sign like Taurus or Aquarius");

toolIdx = toolIdx+1;
jsonTools.I = toolIdx;
jsonTools.UpdateString("tools[i].name","get_compatibility");
jsonTools.UpdateString("tools[i].description","Returns compatibility analysis between two zodiac signs, including a score and explanation.");
jsonTools.UpdateString("tools[i].parameters.properties.sign1.type","string");
jsonTools.UpdateString("tools[i].parameters.properties.sign1.description","The first zodiac sign (e.g., Aries, Taurus, Gemini).");
jsonTools.UpdateString("tools[i].parameters.properties.sign2.type","string");
jsonTools.UpdateString("tools[i].parameters.properties.sign2.description","The second zodiac sign (e.g., Aries, Taurus, Gemini).");
jsonTools.UpdateString("tools[i].parameters.properties.relationship_type.type","string");
jsonTools.UpdateString("tools[i].parameters.properties.relationship_type.description","Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)");
jsonTools.UpdateString("tools[i].parameters.properties.detail_level.type","string");
jsonTools.UpdateString("tools[i].parameters.properties.detail_level.description","Level of detail in the response. (e.g., short, medium, detailed)");

// More tools can be added as desired..

jsonTools.EmitCompact = false;
console.log(jsonTools.Emit());

var ai = new CkAi();

// Register the tools that will be made available to the AI.
ai.RegisterManualTools(jsonTools);

// 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 a horoscope generated by a tool. Use the tool output as the final answer.";
ai.NewConvo(conversation_name,sysMessage,devMessage);

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

// Send inputs, tool functions, etc. and ask for a "text" response.
success = ai.Ask("text");
if (success == false) {
    console.log(ai.LastErrorText);
    return;
}

// Did the AI respond with requests for tool function calls?
if (ai.HasFunctionCalls == true) {

    var jsonFn = new CkJsonObject();
    jsonFn.EmitCompact = false;

    ai.GetFunctionCalls(jsonFn);
    console.log(jsonFn.Emit());

    // 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"
    //       }
    //     }
    //   ]
    // }

    var numFnCalls = jsonFn.SizeOfArray("function_call");
    var fn_idx = 0;
    while ((fn_idx < numFnCalls)) {
        jsonFn.I = fn_idx;

        var sbFnName = new CkStringBuilder();
        jsonFn.StringOfSb("function_call[i].name",sbFnName);
        var callId = jsonFn.StringOf("function_call[i].call_id");

        if (sbFnName.ContentsEqual("get_horoscope",true) == true) {

            // The get_horoscope function (as defined above) has one argument named "sign".
            var zodiac_sign = jsonFn.StringOf("function_call[i].args.sign");
            console.log("zodiac_sign = " + 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:
            var applicationFnCallResult = "Aquarius: Next Tuesday you will befriend a baby otter.";

            // Provide the tool call result as an input for the followup Ask.
            ai.InputAddFnResult(callId,applicationFnCallResult);
        }

        // Your application would add code to check for and handle each possible function call.

        fn_idx = fn_idx+1;
    }

    // After making the requested tool function calls, send the results back to the AI.
    success = ai.Ask("text");
    if (success == false) {
        console.log(ai.LastErrorText);
        return;
    }

}

// Get the final AI response.
var sbResponse = new CkStringBuilder();
ai.GetOutputTextSb(sbResponse);
console.log(sbResponse.GetAsString());