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#

bool success = false;

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

Chilkat.Ai ai = new Chilkat.Ai();

//  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) {
        Debug.WriteLine(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.)
        Debug.WriteLine("Response status code: " + Convert.ToString(ai.ResponseStatusCode));

        //  The error response (JSON) is available in the LastJsonData.
        Chilkat.JsonObject json = new Chilkat.JsonObject();
        json.EmitCompact = false;
        ai.GetLastJsonData(json);
        Debug.WriteLine(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.
Chilkat.StringBuilder sbResponse = new Chilkat.StringBuilder();
ai.GetOutputTextSb(sbResponse);
Debug.WriteLine(sbResponse.GetAsString());