Lua Requires Chilkat v11.2.0+

AI: Diagnosing an Ask Failure

See more AI Examples

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

local chilkat = require("chilkat")

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

local ai = chilkat.Ai.new()

-- 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.api_key = "sk-11111111111111111111111111111111111111111111111k"

-- Choose a model.
ai.model = "gpt-5.6-terra"

-- Add a text input.
ai:input_add_text("Say Hello.")

-- Ask the AI for text output.
local success = ai:ask("text")
if not success then
    -- 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.response_status_code == 0 then
        print(ai.last_error_text)
    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.response_status_code)

        -- The error response (JSON) is available in the LastJsonData.
        local json = chilkat.JsonObject.new()
        json.emit_compact = false
        ai:get_last_json_data(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"
        --   }
        -- }
    end

    return
end

-- Get the text response.
local sbResponse = chilkat.StringBuilder.new()
ai:get_output_text_sb(sbResponse)
print(sbResponse:get_as_string())