(JavaScript) Automatic JavaScript AI Tool Returning an Object
Demonstrates an automatic JavaScript tool function that returns an object. 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.
Note: This example requires Chilkat v11.4.0 or greater. For more information, see https://www.chilkatsoft.com/automatic_ai_javascript_tool_function_calling.asp
var success = false;
// ----------------------------------------------------------------------------------
// The Javascript file loaded here is shown at the bottom of this page.
// -----------------------------------------------------------------------------------
// In this example, we'll load the Javascript tool functions and registry from a file.
// It doesn't need to come from a file. It could just as easily be loaded from a string.
var sbJs = new CkStringBuilder();
success = sbJs.LoadFile("qa_data/js_tools/toolset_2.js","utf-8");
if (success == false) {
console.log(sbJs.LastErrorText);
return;
}
var ai = new CkAi();
// Register the tools that will be made available to the AI.
var evalOnly = false;
var allowAllKeyword = true;
ai.RegisterJsTools(sbJs,evalOnly,allowAllKeyword);
// 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_weather";
var sysMessage = "You are a helpful weather forecaster";
var devMessage = "Respond only with a weather forecast generated by a tool.";
ai.NewConvo(conversation_name,sysMessage,devMessage);
// Provide inputs
ai.InputAddText("What's the weather in Chicago?");
// 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.
success = ai.Ask("text");
if (success == false) {
console.log(ai.LastErrorText);
return;
}
// Get the AI response.
var sbResponse = new CkStringBuilder();
ai.GetOutputTextSb(sbResponse);
console.log(sbResponse.GetAsString());
|