B4X Requires Chilkat v11.4.0+

Automatic JavaScript AI Tool Returning an Object

See more AI Examples

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.

B4X

Dim success As Boolean = 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.
Dim sbJs As ChilkatStringBuilder
sbJs.Initialize
success = sbJs.LoadFile("qa_data/js_tools/toolset_2.js", "utf-8")
If success = False Then
    Log(sbJs.LastErrorText)
    Return
End If


Dim ai As ChilkatAi
ai.Initialize("ai")

'  Register the tools that will be made available to the AI.
Dim evalOnly As Boolean = False
Dim allowAllKeyword As Boolean = 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.6-luna"

'  Tool function calling must always occur within a conversation.
Dim conversation_name As String = "convo_weather"
Dim sysMessage As String = "You are a helpful weather forecaster"
Dim devMessage As String = "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 Then
    Log(ai.LastErrorText)
    Return
End If


'  Get the AI response.
Dim sbResponse As ChilkatStringBuilder
sbResponse.Initialize
ai.GetOutputTextSb(sbResponse)
Log(sbResponse.GetAsString)

JavaScript

// The namespace for the AI tool functions in this JavaScript source file.
Example = {};

// Tool functions must have only one argument, which should be an object.

// The function names used here must match the "name" in the toolRegistry below.
Example.get_weather = function(arg) {
  return {
	  "temperature": 45,
	  "unit": "F",
	  "conditions": "Cloudy"
	};
}

Example.multiply_numbers = function(arg) {
  return arg.a * arg.b;
}

Example.get_horoscope = function(arg) {
  return  `${arg.sign} : Next Tuesday you will befriend a baby otter.`;
}

// The inputSchema.type must ALWAYS be "object".
Example.toolRegistry = [
  {
    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_weather",
    description: "Gets the weather at a location.",
    parameters: {
      properties: {
        location: { type: "string", description: "Location such as a city name." },
      }
    }
  },
  {
    name: "multiply_numbers",
    description: "Multiplies two numbers and returns the product.",
    parameters: {
      properties: {
        a: { type: "number", description: "First number" },
        b: { type: "number", description: "Second number" }
      }
    }
  }
];


Example.toolPermissions = [
	  {
	    name: "all",
	    perm: "sandbox",
	  }
	  		
	];
	
	
// Return the name of this toolset
// This tells Chilkat the namespace of this toolset.
"Example";