C

AI: Diagnosing an Ask Failure

See more AI Examples

Demonstrates how to get information about why a request to the AI provider failed. C

#include <C_CkAi.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkAi ai;
    HCkJsonObject json;
    HCkStringBuilder sbResponse;

    success = FALSE;

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

    ai = CkAi_Create();

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

    // In this case, we're going to cause an intentional failure by using an invalid API key.
    CkAi_putApiKey(ai,"sk-11111111111111111111111111111111111111111111111k");

    // Choose a model.
    CkAi_putModel(ai,"gpt-4o");

    // Add a text input.
    CkAi_InputAddText(ai,"Say Hello.");

    // Ask the AI for text output.
    success = CkAi_Ask(ai,"text");
    if (success == FALSE) {
        // If the response status code equals 0, it means the error occurred before receiving the HTTP response.
        // For this case look at the LastErrorText.
        if (CkAi_getResponseStatusCode(ai) == 0) {
            printf("%s\n",CkAi_lastErrorText(ai));
        }
        else {
            // If we received an error response, the status code will be >= 400.
            // (Ask would've returned TRUE if the response status code was 200.)
            printf("Response status code: %d\n",CkAi_getResponseStatusCode(ai));

            // The error response (JSON) is available in the LastJsonData.
            json = CkJsonObject_Create();
            CkJsonObject_putEmitCompact(json,FALSE);
            CkAi_GetLastJsonData(ai,json);
            printf("%s\n",CkJsonObject_emit(json));

            // Sample output:
            // {
            //   "error": {
            //     "message": "Incorrect API key provided: sk-11111***************************************111k. You can find your API key at https://platform.openai.com/account/api-keys.",
            //     "type": "invalid_request_error",
            //     "param": null,
            //     "code": "invalid_api_key"
            //   }
            // }
        }

        CkAi_Dispose(ai);
        CkJsonObject_Dispose(json);
        return;
    }

    // Get the text response.
    sbResponse = CkStringBuilder_Create();
    CkAi_GetOutputTextSb(ai,sbResponse);
    printf("%s\n",CkStringBuilder_getAsString(sbResponse));


    CkAi_Dispose(ai);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponse);

    }