(Android™) 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

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkJsonObject jsonTools = new CkJsonObject();

    int toolIdx = 0;

    jsonTools.put_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.put_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.put_EmitCompact(false);
    Log.i(TAG, jsonTools.emit());

    CkAi 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.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_astrology";
    String sysMessage = "You are a helpful astrologer";
    String 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) {
        Log.i(TAG, ai.lastErrorText());
        return;
        }

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

        CkJsonObject jsonFn = new CkJsonObject();
        jsonFn.put_EmitCompact(false);

        ai.GetFunctionCalls(jsonFn);
        Log.i(TAG, 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"
        //       }
        //     }
        //   ]
        // }

        int numFnCalls = jsonFn.SizeOfArray("function_call");
        int fn_idx = 0;
        while ((fn_idx < numFnCalls)) {
            jsonFn.put_I(fn_idx);

            CkStringBuilder sbFnName = new CkStringBuilder();
            jsonFn.StringOfSb("function_call[i].name",sbFnName);
            String 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".
                String zodiac_sign = jsonFn.stringOf("function_call[i].args.sign");
                Log.i(TAG, "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:
                String 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) {
            Log.i(TAG, ai.lastErrorText());
            return;
            }

        }

    // Get the final AI response.
    CkStringBuilder sbResponse = new CkStringBuilder();
    ai.GetOutputTextSb(sbResponse);
    Log.i(TAG, sbResponse.getAsString());

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}