[Bug]: Undefined array key "index"

[j-schumann]

Description

Warning: Undefined array key "index" caused in Responses/Completions/CreateResponseChoice.php#L23

Steps To Reproduce

By receiving the following attributes:

from Openrouter.ai with different models, using

        $client = \OpenAI::factory()
            ->withApiKey($yourApiKey)
            ->withBaseUri('https://openrouter.ai/api/v1')
            ->make();

        $result = $client->completions()->create([
            //'model' => 'gpt-3.5-turbo-instruct',
            "model" => "google/gemini-2.0-pro-exp-02-05:free",
            'prompt' => 'Say this is a test',
            'max_tokens' => 6,
            'temperature' => 0
        ]);

OpenAI PHP Client Version

v0.10.3

PHP Version

8.4.3

Notes

No response

[legsak1mbo]

I found the same when using Gemini. The issue appears to be that Google do not return an id attribute with their responses. A quick fix was to null coalesce $attributes['id'] in the CreateResponse class for both Chats and Completions (lines 54 and 53 respectively):-

$attributes['id'] ?? bin2hex(random_bytes(6)),

NB I gave them a random value rather than empty or null just in case.

[ghostza1209]

I've fixed it by using my custom HTTP client

    $yourApiKey = config('app.gemini_api_key');
        $client = OpenAI::factory()
            ->withApiKey($yourApiKey)
            ->withHttpClient(new HttpClient())
            ->withBaseUri('generativelanguage.googleapis.com/v1beta/openai')
            ->make();

HttpClient.php

<?php

namespace Modules\RealtyVision\Client;

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Utils;
use Illuminate\Support\Arr;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

class HttpClient implements ClientInterface
{
    /**
     * @param RequestInterface $request
     * @return ResponseInterface
     * @throws ClientExceptionInterface
     */
    public function sendRequest(RequestInterface $request): ResponseInterface
    {
        $stack = HandlerStack::create();
        $stack->push(Middleware::mapResponse(function ($response) {
            $body = $this->ensureIdExisted($response->getBody()->getContents());
            $newBody = Utils::streamFor($body);
            return $response->withBody($newBody);
        }));

        $client = new Client(['handler' => $stack]);
        return $client->sendRequest($request);
    }

    /**
     * @param string $body
     * @return string
     */
    private function ensureIdExisted(string $body): string
    {
        $array = json_decode($body, true);
        $array['id'] = Arr::get($array, 'id') ?? uniqid();

        return json_encode($array);
    }
}