Tcl

AI: Diagnosing an Ask Failure

See more AI Examples

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

load ./chilkat.dll

set success 0

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

set 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.
CkAi_put_Provider $ai "openai"

# In this case, we're going to cause an intentional failure by using an invalid API key.
CkAi_put_ApiKey $ai "sk-11111111111111111111111111111111111111111111111k"

# Choose a model.
CkAi_put_Model $ai "gpt-4o"

# Add a text input.
CkAi_InputAddText $ai "Say Hello."

# Ask the AI for text output.
set success [CkAi_Ask $ai "text"]
if {$success == 0} 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 {[CkAi_get_ResponseStatusCode $ai] == 0} then {
        puts [CkAi_lastErrorText $ai]
    }     else {
        # If we received an error response, the status code will be >= 400.
        # (Ask would've returned 1 if the response status code was 200.)
        puts "Response status code: [CkAi_get_ResponseStatusCode $ai]"

        # The error response (JSON) is available in the LastJsonData.
        set json [new_CkJsonObject]

        CkJsonObject_put_EmitCompact $json 0
        CkAi_GetLastJsonData $ai $json
        puts [CkJsonObject_emit $json]

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

    delete_CkAi $ai
    delete_CkJsonObject $json
    exit
}

# Get the text response.
set sbResponse [new_CkStringBuilder]

CkAi_GetOutputTextSb $ai $sbResponse
puts [CkStringBuilder_getAsString $sbResponse]

delete_CkAi $ai
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse