Objective-C

Conversation with Streaming Responses

See more AI Examples

Demonstrates an AI conversation with receiving streaming responses. Objective-C

#import <CkoAi.h>
#import <NSString.h>
#import <CkoStringBuilder.h>

BOOL success = NO;

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

CkoAi *ai = [[CkoAi alloc] init];

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

// Use your provider's API key.
ai.ApiKey = @"MY_API_KEY";

// Choose a model.
ai.Model = @"gemini-2.5-flash";

// Indicate streaming mode is to be used.
ai.Streaming = YES;

// Create a new conversation to be maintained locally in memory.
// If the conversation is the first to be created, it is also automatically selected.
NSString *systemMsg = @"You are a creative storyteller";
NSString *developerMsg = @"";
NSString *conversationName = @"test_conversation";
[ai NewConvo: conversationName sysMsg: systemMsg devMsg: developerMsg];

// 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."];

// Ask the AI for text output.
success = [ai Ask: @"text"];
if (success == NO) {
    NSLog(@"%@",ai.LastErrorText);
    return;
}

CkoStringBuilder *sbEventName = [[CkoStringBuilder alloc] init];
CkoStringBuilder *sbDelta = [[CkoStringBuilder alloc] init];
CkoStringBuilder *sbFullResponse = [[CkoStringBuilder alloc] init];
BOOL finished = NO;
BOOL abortFlag = NO;
int maxWaitMs = 5000;

while (!finished) {

    int result = [[ai PollAi: abortFlag] intValue];
    if (result == 1) {
        // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        success = [ai NextAiEvent: [NSNumber numberWithInt: maxWaitMs] sbName: sbEventName sbDelta: sbDelta];
        if (success == NO) {
            NSLog(@"%@",ai.LastErrorText);
            return;
        }

        // Some AI providers send many "empty" events.  Just ignore them.
        if (![sbEventName ContentsEqual: @"empty" caseSensitive: YES]) {

            // The delta contains the new output.  This could be emitted to a display or the terminal
            // as real-time output.
            if ([sbEventName ContentsEqual: @"delta" caseSensitive: YES]) {
                // This example will emit each delta to its own line.
                NSLog(@"%@",[sbDelta GetAsString]);

                // Accumulate the delta's so we can show the full response later.
                [sbFullResponse AppendSb: sbDelta];
            }
            else {
                // A streaming AI response is always terminated by a single "null_terminator" event.
                finished = [sbEventName ContentsEqual: @"null_terminator" caseSensitive: YES];
            }

        }

    }
    else {
        if (result == 0) {
            // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            [ai SleepMs: [NSNumber numberWithInt: 100]];
        }
        else {
            // Something failed..
            NSLog(@"%@",ai.LastErrorText);
            finished = YES;
        }

    }

}

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

// Show the accumulated (full) response.
NSLog(@"%@",@"----");
NSLog(@"%@",[sbFullResponse GetAsString]);
NSLog(@"%@",@"----");

// ----------------------------------------------------------------------------------------------------------
// 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."];
success = [ai Ask: @"text"];
if (success == NO) {
    NSLog(@"%@",ai.LastErrorText);
    return;
}

[sbFullResponse Clear];
finished = NO;

while (!finished) {

    int result = [[ai PollAi: abortFlag] intValue];
    if (result == 1) {
        // We have output waiting.  It should be instantly available.  The maxWaitMs is just-in-case.
        success = [ai NextAiEvent: [NSNumber numberWithInt: maxWaitMs] sbName: sbEventName sbDelta: sbDelta];
        if (success == NO) {
            NSLog(@"%@",ai.LastErrorText);
            return;
        }

        // Some AI providers send many "empty" events.  Just ignore them.
        if (![sbEventName ContentsEqual: @"empty" caseSensitive: YES]) {

            // The delta contains the new output.  This could be emitted to a display or the terminal
            // as real-time output.
            if ([sbEventName ContentsEqual: @"delta" caseSensitive: YES]) {
                // This example will emit each delta to its own line.
                NSLog(@"%@",[sbDelta GetAsString]);

                // Accumulate the delta's so we can show the full response later.
                [sbFullResponse AppendSb: sbDelta];
            }
            else {
                // A streaming AI response is always terminated by a single "null_terminator" event.
                finished = [sbEventName ContentsEqual: @"null_terminator" caseSensitive: YES];
            }

        }

    }
    else {
        if (result == 0) {
            // Nothing is immediately available. Sleep for 1/10 of a second before polling again.
            [ai SleepMs: [NSNumber numberWithInt: 100]];
        }
        else {
            // Something failed..
            NSLog(@"%@",ai.LastErrorText);
            finished = YES;
        }

    }

}

NSLog(@"%@",@"----");
NSLog(@"%@",[sbFullResponse GetAsString]);