Swift

AI: Diagnosing an Ask Failure

See more AI Examples

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

func chilkatTest() {
    var success: Bool = false

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

    let ai = CkoAi()!

    //  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-5.6-terra"

    //  Add a text input.
    ai.inputAddText(text: "Say Hello.")

    //  Ask the AI for text output.
    success = ai.ask(outputType: "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.intValue == 0 {
            print("\(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.)
            print("Response status code: \(ai.responseStatusCode.intValue)")

            //  The error response (JSON) is available in the LastJsonData.
            let json = CkoJsonObject()!
            json.emitCompact = false
            ai.getLastJsonData(json: json)
            print("\(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.
    let sbResponse = CkoStringBuilder()!
    ai.getOutputTextSb(sb: sbResponse)
    print("\(sbResponse.getAsString()!)")

}