PHP Extension

AI: Diagnosing an Ask Failure

See more AI Examples

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

<?php

include("chilkat.php");

$success = false;

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

$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) {
        print $ai->lastErrorText() . "\n";
    }
    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->get_ResponseStatusCode() . "\n";

        // The error response (JSON) is available in the LastJsonData.
        $json = new CkJsonObject();
        $json->put_EmitCompact(false);
        $ai->GetLastJsonData($json);
        print $json->emit() . "\n";

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

    exit;
}

// Get the text response.
$sbResponse = new CkStringBuilder();
$ai->GetOutputTextSb($sbResponse);
print $sbResponse->getAsString() . "\n";

?>