Lua Requires Chilkat v11.4.0+

Demonstrates Manual Tool Function Calls

See more AI Examples

Demonstrates how to do manual tool function calling using Chilkat. This is where your application manually checks for function calls in the AI's response, makes the function calls, and returns the function call results to the AI. Lua

local chilkat = require("chilkat")

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

local jsonTools = chilkat.JsonObject.new()

local toolIdx = 0

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

toolIdx = toolIdx + 1
jsonTools.i = toolIdx
jsonTools:update_string("tools[i].name", "get_compatibility")
jsonTools:update_string("tools[i].description", "Returns compatibility analysis between two zodiac signs, including a score and explanation.")
jsonTools:update_string("tools[i].parameters.properties.sign1.type", "string")
jsonTools:update_string("tools[i].parameters.properties.sign1.description", "The first zodiac sign (e.g., Aries, Taurus, Gemini).")
jsonTools:update_string("tools[i].parameters.properties.sign2.type", "string")
jsonTools:update_string("tools[i].parameters.properties.sign2.description", "The second zodiac sign (e.g., Aries, Taurus, Gemini).")
jsonTools:update_string("tools[i].parameters.properties.relationship_type.type", "string")
jsonTools:update_string("tools[i].parameters.properties.relationship_type.description", "Type of compatibility to evaluate. (e.g., romantic, friendship, professional, general)")
jsonTools:update_string("tools[i].parameters.properties.detail_level.type", "string")
jsonTools:update_string("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.emit_compact = false
print(jsonTools:emit())

local ai = chilkat.Ai.new()

-- Register the tools that will be made available to the AI.
ai:register_manual_tools(jsonTools)

-- The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
ai.provider = "openai"
-- Use your provider's API key.
ai.api_key = "MY_API_KEY"
-- Choose a model.
ai.model = "gpt-5.6-luna"

-- Tool function calling must always occur within a conversation.
local conversation_name = "convo_astrology"
local sysMessage = "You are a helpful astrologer"
local devMessage = "Respond only with a horoscope generated by a tool. Use the tool output as the final answer."
ai:new_convo(conversation_name, sysMessage, devMessage)

-- Provide inputs
ai:input_add_text("What is my horoscope? I am an Aquarius.")

-- Send inputs, tool functions, etc. and ask for a "text" response.
local success = ai:ask("text")
if not success then
    print(ai.last_error_text)
    return
end

-- Did the AI respond with requests for tool function calls?
if ai.has_function_calls then
    local jsonFn = chilkat.JsonObject.new()
    jsonFn.emit_compact = false

    ai:get_function_calls(jsonFn)
    print(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"
    --       }
    --     }
    --   ]
    -- }

    local numFnCalls = jsonFn:size_of_array("function_call")
    local fn_idx = 0
    while fn_idx < numFnCalls do
        jsonFn.i = fn_idx

        local sbFnName = chilkat.StringBuilder.new()
        jsonFn:string_of_sb("function_call[i].name", sbFnName)
        local callId = jsonFn:string_of("function_call[i].call_id")

        if sbFnName:contents_equal("get_horoscope", true) then
            -- The get_horoscope function (as defined above) has one argument named "sign".
            local zodiac_sign = jsonFn:string_of("function_call[i].args.sign")
            print("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:
            local applicationFnCallResult = "Aquarius: Next Tuesday you will befriend a baby otter."

            -- Provide the tool call result as an input for the followup Ask.
            ai:input_add_fn_result(callId, applicationFnCallResult)
        end

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

        fn_idx = fn_idx + 1
    end

    -- After making the requested tool function calls, send the results back to the AI.
    success = ai:ask("text")
    if not success then
        print(ai.last_error_text)
        return
    end
end

-- Get the final AI response.
local sbResponse = chilkat.StringBuilder.new()
ai:get_output_text_sb(sbResponse)
print(sbResponse:get_as_string())