JavaScript

AI: Diagnosing an Ask Failure

See more AI Examples

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

var success = false;

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

var ai = new CkAi();

// 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 = "openai";

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

// Choose a model.
ai.Model = "gpt-4o";

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

// Ask the AI for text output.
success = ai.Ask("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 (ai.ResponseStatusCode == 0) {
        console.log(ai.LastErrorText);
    }
    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.)
        console.log("Response status code: " + ai.ResponseStatusCode);

        // The error response (JSON) is available in the LastJsonData.
        var json = new CkJsonObject();
        json.EmitCompact = false;
        ai.GetLastJsonData(json);
        console.log(json.Emit());

        // 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"
        //   }
        // }
    }

    return;
}

// Get the text response.
var sbResponse = new CkStringBuilder();
ai.GetOutputTextSb(sbResponse);
console.log(sbResponse.GetAsString());