Some review adjustments

Author: DZunke

examples/image-generator-dall-e-2.php

@@ -13,12 +13,15 @@
 }
 
 $platform = PlatformFactory::create($_ENV['OPENAI_API_KEY']);
-$llm = new DallE(DallE::DALL_E_2);
 
 $response = $platform->request(
-    model: $llm,
+    model: new DallE(),
     input: 'A cartoon-style elephant with a long trunk and large ears.',
-    options: ['response_format' => 'url', 'n' => 2],
+    options: [
+        'version' => DallE::DALL_E_2, // Utilize Dall-E 2 version
+        'response_format' => 'url', // Generate response as URL
+        'n' => 2, // Generate multiple images for example
+    ],
 );
 
 foreach ($response->getContent() as $index => $image) {

examples/image-generator-dall-e-3.php

@@ -1,7 +1,7 @@
 <?php
 
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE;
-use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImagesResponse;
+use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImageResponse;
 use PhpLlm\LlmChain\Bridge\OpenAI\PlatformFactory;
 use PhpLlm\LlmChain\Model\Response\AsyncResponse;
 use Symfony\Component\Dotenv\Dotenv;
@@ -15,19 +15,20 @@
 }
 
 $platform = PlatformFactory::create($_ENV['OPENAI_API_KEY']);
-$llm = new DallE(DallE::DALL_E_3);
 
 $response = $platform->request(
-    model: $llm,
+    model: new DallE(),
     input: 'A cartoon-style elephant with a long trunk and large ears.',
-    options: ['response_format' => 'url', 'n' => 1],
+    options: [
+        'version' => DallE::DALL_E_3, // Utilize Dall-E 3 version
+    ],
 );
 
 if ($response instanceof AsyncResponse) {
     $response = $response->unwrap();
 }
 
-assert($response instanceof ImagesResponse);
+assert($response instanceof ImageResponse);
 
 echo 'Revised Prompt: '.$response->revisedPrompt.PHP_EOL.PHP_EOL;
 

src/Bridge/OpenAI/DallE.php

@@ -14,10 +14,7 @@
     /** @param array<string, mixed> $options The default options for the model usage */
     public function __construct(
         private string $version = self::DALL_E_2,
-        private array $options = [
-            'response_format' => 'url',
-            'n' => 1,
-        ],
+        private array $options = [],
     ) {
     }
 

src/Bridge/OpenAI/DallE/ImagesResponse.php renamed to src/Bridge/OpenAI/DallE/ImageResponse.php

@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Model\Response\ResponseInterface;
 
-class ImagesResponse implements ResponseInterface
+class ImageResponse implements ResponseInterface
 {
     /** @var list<Base64Image|UrlImage> */
     private readonly array $images;

src/Bridge/OpenAI/DallE/ModelClient.php

@@ -61,6 +61,6 @@ public function convert(HttpResponse $response, array $options = []): LlmRespons
             $images[] = new Base64Image($image['b64_json']);
         }
 
-        return new ImagesResponse($image['revised_prompt'] ?? null, ...$images);
+        return new ImageResponse($image['revised_prompt'] ?? null, ...$images);
     }
 }

tests/Bridge/OpenAI/DallE/ImagesResponseTest.php renamed to tests/Bridge/OpenAI/DallE/ImageResponseTest.php

@@ -5,25 +5,25 @@
 namespace PhpLlm\LlmChain\Tests\Bridge\OpenAI\DallE;
 
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE\Base64Image;
-use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImagesResponse;
+use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImageResponse;
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE\UrlImage;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Small;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 
-#[CoversClass(ImagesResponse::class)]
+#[CoversClass(ImageResponse::class)]
 #[UsesClass(Base64Image::class)]
 #[UsesClass(UrlImage::class)]
 #[Small]
-final class ImagesResponseTest extends TestCase
+final class ImageResponseTest extends TestCase
 {
     #[Test]
     public function itCreatesImagesResponse(): void
     {
         $base64Image = new Base64Image('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==');
-        $generatedImagesResponse = new ImagesResponse(null, $base64Image);
+        $generatedImagesResponse = new ImageResponse(null, $base64Image);
 
         self::assertNull($generatedImagesResponse->revisedPrompt);
         self::assertCount(1, $generatedImagesResponse->getContent());
@@ -34,7 +34,7 @@ public function itCreatesImagesResponse(): void
     public function itCreatesImagesResponseWithRevisedPrompt(): void
     {
         $base64Image = new Base64Image('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==');
-        $generatedImagesResponse = new ImagesResponse('revised prompt', $base64Image);
+        $generatedImagesResponse = new ImageResponse('revised prompt', $base64Image);
 
         self::assertSame('revised prompt', $generatedImagesResponse->revisedPrompt);
         self::assertCount(1, $generatedImagesResponse->getContent());
@@ -47,7 +47,7 @@ public function itIsCreatableWithMultipleImages(): void
         $image1 = new UrlImage('https://example');
         $image2 = new UrlImage('https://example2');
 
-        $generatedImagesResponse = new ImagesResponse(null, $image1, $image2);
+        $generatedImagesResponse = new ImageResponse(null, $image1, $image2);
 
         self::assertCount(2, $generatedImagesResponse->getContent());
         self::assertSame($image1, $generatedImagesResponse->getContent()[0]);

tests/Bridge/OpenAI/DallE/ModelClientTest.php

@@ -6,7 +6,7 @@
 
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE;
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE\Base64Image;
-use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImagesResponse;
+use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ImageResponse;
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE\ModelClient;
 use PhpLlm\LlmChain\Bridge\OpenAI\DallE\UrlImage;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -25,7 +25,7 @@
 #[UsesClass(HttpClientInterface::class)]
 #[UsesClass(UrlImage::class)]
 #[UsesClass(Base64Image::class)]
-#[UsesClass(ImagesResponse::class)]
+#[UsesClass(ImageResponse::class)]
 #[Small]
 final class ModelClientTest extends TestCase
 {
@@ -86,7 +86,7 @@ public function itIsConvertingTheResponseWithRevisedPrompt(): void
         $modelClient = new ModelClient(new MockHttpClient(), 'sk-api-key');
         $response = $modelClient->convert($httpResponse, ['response_format' => 'b64_json']);
 
-        self::assertInstanceOf(ImagesResponse::class, $response);
+        self::assertInstanceOf(ImageResponse::class, $response);
         self::assertCount(1, $response->getContent());
         self::assertInstanceOf(Base64Image::class, $response->getContent()[0]);
         self::assertSame($emptyPixel, $response->getContent()[0]->encodedImage);

tests/Bridge/OpenAI/DallETest.php

@@ -20,7 +20,7 @@ public function itCreatesDallEWithDefaultSettings(): void
         $dallE = new DallE();
 
         self::assertSame(DallE::DALL_E_2, $dallE->getVersion());
-        self::assertSame(['response_format' => 'url', 'n' => 1], $dallE->getOptions());
+        self::assertSame([], $dallE->getOptions());
     }
 
     #[Test]