Java

AI: Diagnosing an Ask Failure

See more AI Examples

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

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkAi 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.put_Provider("openai");

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

    // Choose a model.
    ai.put_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.get_ResponseStatusCode() == 0) {
            System.out.println(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.)
            System.out.println("Response status code: " + ai.get_ResponseStatusCode());

            // The error response (JSON) is available in the LastJsonData.
            CkJsonObject json = new CkJsonObject();
            json.put_EmitCompact(false);
            ai.GetLastJsonData(json);
            System.out.println(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.
    CkStringBuilder sbResponse = new CkStringBuilder();
    ai.GetOutputTextSb(sbResponse);
    System.out.println(sbResponse.getAsString());
  }
}