Swift

Streaming AI with Automatic JavaScript AI Tool Function Calling

See more AI Examples

Demonstrates how to get AI responses in streaming mode, including possible tool function calling using Chilkat with embedded Chilkat.Js JavaScript. 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.

Swift

func chilkatTest() {
    var success: Bool = false

    // ----------------------------------------------------------------------------------
    // The Javascript file loaded here is shown at the bottom of this page.
    // -----------------------------------------------------------------------------------

    let sbJs = CkoStringBuilder()!
    success = sbJs.loadFile(path: "qa_data/js_tools/horoscope_tools.js", charset: "utf-8")
    if success == false {
        print("\(sbJs.lastErrorText!)")
        return
    }

    let ai = CkoAi()!

    // Register the tools that will be made available to the AI.
    var evalOnly: Bool = false
    var allowAllKeyword: Bool = true
    ai.registerJsTools(sb: sbJs, evalOnly: evalOnly, allowAllKeyword: 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: String? = "convo_astrology"
    var sysMessage: String? = "You are a helpful astrologer"
    var devMessage: String? = "Respond only with markdown."
    ai.newConvo(name: conversation_name, sysMsg: sysMessage, devMsg: devMessage)

    // Provide inputs
    ai.inputAddText(text: "What is my horoscope? I am an Aquarius.")

    // Get the response in streaming mode.
    ai.streaming = true

    // In streaming mode, if we receive an AI event that is a request for tool use,
    // we'll need to make the call to the JavaScript and then continue with a followup Ask,
    // until the final response is received.

    let sbEventName = CkoStringBuilder()!
    let sbDelta = CkoStringBuilder()!
    let sbFullResponse = CkoStringBuilder()!

    // When PollAi returns with an event, it's highly unlikely the
    // call to NextAiEvent does not immediately return.  Setting a max
    // timeout is just a precaution..
    var maxWaitMs: Int = 5000

    var finished: Bool = false
    var numAsks: Int = 0
    // Set a max # of followup Asks to prevent any unexpected infinite looping.
    while !finished && (numAsks < 10) {

        // Send the request to the AI model.
        success = ai.ask(outputType: "text")
        if success == false {
            print("\(ai.lastErrorText!)")
            return
        }

        var madeFunctionCalls: Bool = false
        var streamingDone: Bool = false

        while !streamingDone {
            var result: Int = ai.poll(abort: false).intValue
            if result < 0 {
                print("\(ai.lastErrorText!)")
                print("Failed.")
                return
            }

            if result > 0 {
                // We have an event..
                success = ai.nextEvent(maxWaitMs: maxWaitMs, sbName: sbEventName, sbDelta: sbDelta)
                if success == false {
                    print("\(ai.lastErrorText!)")
                    return
                }

                // Is this an event where the AI is requesting a function call?
                if sbEventName.contentsEqual(str: "js_function_call", caseSensitive: true) {
                    // Call the JavaScript function.
                    // We don't need to find the exact function and make the call.  
                    // We can simply pass the sbDelta (which contains information about the function to be called and the args).
                    // Chilkat will find the registered JavaScript function, call it, and add the results to the conversation.
                    // We indicate that function calls were made, which results in a followup Ask (in the outer loop).
                    success = ai.streamingJsToolCall(sb: sbDelta)
                    if success == false {
                        // The JS function call failed.
                        streamingDone = true
                    }
                    else {
                        madeFunctionCalls = true
                    }

                }
                else {
                    if !sbEventName.contentsEqual(str: "empty", caseSensitive: true) {
                        sbFullResponse.appendSb(sb: sbDelta)

                        if sbEventName.contentsEqual(str: "null_terminator", caseSensitive: true) {
                            streamingDone = true
                        }

                    }

                }

            }
            else {
                // No event arrived, so wait a short time rather than spin in a loop..
                ai.sleepMs(millisec: 100)
            }

        }

        if !madeFunctionCalls {
            finished = true
        }

        numAsks = numAsks + 1
    }

    print("Full Response:")
    print("\(sbFullResponse.getAsString()!)")

}