Zig Requires Chilkat v11.2.0+

Conversation with Streaming Responses

See more AI Examples

Demonstrates an AI conversation with receiving streaming responses. Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    const ai = try chilkat.Ai.init();
    defer ai.deinit();

    // The provider can be "openai", "google", "claude", "deepseek", "xai", or "perplexity".
    // Support for additional providers will be added in future versions of Chilkat.
    ai.setProvider("google");

    // Use your provider's API key.
    ai.setApiKey("MY_API_KEY");

    // Choose a model.
    ai.setModel("gemini-3.6-flash");

    // Indicate streaming mode is to be used.
    ai.setStreaming(true);

    // Create a new conversation to be maintained locally in memory.
    // If the conversation is the first to be created, it is also automatically selected.
    const system_msg = "You are a creative storyteller";
    const developer_msg = "";
    const conversation_name = "test_conversation";
    ai.newConvo(conversation_name, system_msg, developer_msg) catch {};

    // Add a text input.
    ai.inputAddText("Write a detailed story about a turtle who decides to run a bakery.  Describe the setting, the kinds of pastries, how the turtle feels, and include at least three paragraphs.") catch {};

    // Ask the AI for text output.
    ai.ask("text") catch {
        std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
        return;
    };

    const sb_event_name = try chilkat.StringBuilder.init();
    defer sb_event_name.deinit();
    const sb_delta = try chilkat.StringBuilder.init();
    defer sb_delta.deinit();
    const sb_full_response = try chilkat.StringBuilder.init();
    defer sb_full_response.deinit();
    var finished: bool = false;
    const abort_flag = false;
    const max_wait_ms = 5000;

    while (!finished) {
        const result = ai.pollAi(abort_flag);
        if (result == 1) {
            // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
            ai.nextAiEvent(max_wait_ms, sb_event_name, sb_delta) catch {
                std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
                return;
            };

            // Some AI providers send many "empty" events.  Just ignore them.
            if (!sb_event_name.contentsEqual("empty", true)) {
                // The delta contains the new output.  This could be emitted to a display or the terminal
                // as real-time output.
                if (sb_event_name.contentsEqual("delta", true)) {
                    // This example will emit each delta to its own line.
                    std.debug.print("{s}\n", .{try sb_delta.getAsString(alloc)});

                    // Accumulate the delta's so we can show the full response later.
                    sb_full_response.appendSb(sb_delta) catch {};
                } else {
                    // A streaming AI response is always terminated by a single "null_terminator" event.
                    finished = sb_event_name.contentsEqual("null_terminator", true);
                }
            }
        } else {
            if (result == 0) {
                // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
                ai.sleepMs(100);
            } else {
                // Something failed..
                std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
                finished = true;
            }
        }
    }

    // -------------------------------------------------------------
    // The response is in markdown format.
    // Also see Markdown to HTML Conversion Examples.
    // -------------------------------------------------------------

    // Show the accumulated (full) response.
    std.debug.print("----\n", .{});
    std.debug.print("{s}\n", .{try sb_full_response.getAsString(alloc)});
    std.debug.print("----\n", .{});

    // ----------------------------------------------------------------------------------------------------------
    // For the 2nd request in this conversation, ask for a shorter version of the story.
    ai.inputAddText("Rewrite the story, but this time make it shorter, about one third as long.") catch {};
    ai.ask("text") catch {
        std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
        return;
    };

    sb_full_response.clear();
    finished = false;

    while (!finished) {
        const result = ai.pollAi(abort_flag);
        if (result == 1) {
            // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
            ai.nextAiEvent(max_wait_ms, sb_event_name, sb_delta) catch {
                std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
                return;
            };

            // Some AI providers send many "empty" events.  Just ignore them.
            if (!sb_event_name.contentsEqual("empty", true)) {
                // The delta contains the new output.  This could be emitted to a display or the terminal
                // as real-time output.
                if (sb_event_name.contentsEqual("delta", true)) {
                    // This example will emit each delta to its own line.
                    std.debug.print("{s}\n", .{try sb_delta.getAsString(alloc)});

                    // Accumulate the delta's so we can show the full response later.
                    sb_full_response.appendSb(sb_delta) catch {};
                } else {
                    // A streaming AI response is always terminated by a single "null_terminator" event.
                    finished = sb_event_name.contentsEqual("null_terminator", true);
                }
            }
        } else {
            if (result == 0) {
                // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
                ai.sleepMs(100);
            } else {
                // Something failed..
                std.debug.print("{s}\n", .{try ai.getLastErrorText(alloc)});
                finished = true;
            }
        }
    }

    std.debug.print("----\n", .{});
    std.debug.print("{s}\n", .{try sb_full_response.getAsString(alloc)});
}