Java

Automatic JavaScript AI Tool Returning an Array

See more AI Examples

Demonstrates an automatic JavaScript tool function that returns an array. 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.

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean 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.
    CkStringBuilder sbJs = new CkStringBuilder();
    success = sbJs.LoadFile("qa_data/js_tools/toolset_3.js","utf-8");
    if (success == false) {
        System.out.println(sbJs.lastErrorText());
        return;
        }

    CkAi ai = new CkAi();

    // Register the tools that will be made available to the AI.
    boolean evalOnly = false;
    boolean allowAllKeyword = true;
    ai.RegisterJsTools(sbJs,evalOnly,allowAllKeyword);

    // The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
    ai.put_Provider("openai");
    // Use your provider's API key.
    ai.put_ApiKey("MY_API_KEY");
    // Choose a model.
    ai.put_Model("gpt-5-mini");

    // Tool function calling must always occur within a conversation.
    String conversation_name = "convo_3";
    String sysMessage = "You are a helpful system admin";
    String devMessage = "Respond only with markdown.";
    ai.NewConvo(conversation_name,sysMessage,devMessage);

    // Provide inputs
    ai.InputAddText("List the files in the directory c:/temp/abc");

    // 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) {
        System.out.println(ai.lastErrorText());
        return;
        }

    // Get the AI response.
    CkStringBuilder sbResponse = new CkStringBuilder();
    ai.GetOutputTextSb(sbResponse);
    System.out.println(sbResponse.getAsString());
  }
}