Merge pull request #3 from miroslaws8/develop

Add image creation

Author: miroslaws8

README.md

@@ -43,11 +43,11 @@ OPENAI_API_KEY=sk-*
 * Models
   * [List models](https://platform.openai.com/docs/api-reference/models/list)
   * [Retrieve model](https://platform.openai.com/docs/api-reference/models/retrieve)
-
+* Images
+  * [Create image](https://platform.openai.com/docs/api-reference/images/create)
 
 #### Coming soon:
 * Images
-  * Create image
   * Create image edit
 * Audio
   * Create transcription
@@ -79,6 +79,21 @@ $result->getChoices(); // Choices from OpenAI.
 
 ```
 
+#### Create image:
+
+```php
+$openAI = $this->container->make(\Itsimiro\OpenAI\Services\OpenAI::class);
+
+
+$result = $openAI->getDalle()->createImage(new CreateImageParameters(
+  'dog with a bone',
+  2,
+  responseFormat: ImageResponseFormatEnum::URL
+ ));
+
+$result->getImages(); // Generated images
+```
+
 #### See the [documentation](https://platform.openai.com/docs/api-reference) for more details on using OpenAI.
 
 ## Testing

composer.json

@@ -46,6 +46,13 @@
             "phpstan/extension-installer": true
         }
     },
-    "minimum-stability": "dev",
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Itsimiro\\OpenAI\\Providers\\OpenaiServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "stable",
     "prefer-stable": true
 }

src/Enum/ImageResponseFormatEnum.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Itsimiro\OpenAI\Enum;
+
+enum ImageResponseFormatEnum: string
+{
+    case URL = 'url';
+    case BASE64 = 'b64_json';
+}

src/Enum/ImageSizeEnum.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Itsimiro\OpenAI\Enum;
+
+enum ImageSizeEnum: string
+{
+    case SMALL = '256x256';
+    case MEDIUM = '512x512';
+    case LARGE = '1024x1024';
+}

src/Services/AIModels/Dalle.php

@@ -2,7 +2,21 @@
 
 namespace Itsimiro\OpenAI\Services\AIModels;
 
+use Itsimiro\OpenAI\Services\API\ApiService;
+use Itsimiro\OpenAI\Services\API\Results\CreateImageResult;
+use Itsimiro\OpenAI\Services\API\UrlService;
+use Itsimiro\OpenAI\Services\DataTransferObjects\CreateImageParameters;
+
 class Dalle
 {
+    public function __construct(private readonly ApiService $apiService, private readonly UrlService $urlService)
+    {}
 
+    public function createImage(CreateImageParameters $parameters): CreateImageResult
+    {
+        return $this->apiService->getResult(
+            $this->apiService->sendRequest('POST', $this->urlService->createImage(), $parameters->toArray()),
+            CreateImageResult::class
+        );
+    }
 }

src/Services/API/Results/BodyParameters.php renamed to src/Services/API/Constants/BodyParameters.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Itsimiro\OpenAI\Services\API\Results;
+namespace Itsimiro\OpenAI\Services\API\Constants;
 
 class BodyParameters
 {

src/Services/API/Constants/ImageBodyParameters.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\API\Constants;
+
+class ImageBodyParameters
+{
+    public const CREATED = 'created';
+    public const DATA = 'data';
+    public const URL = 'url';
+    public const BASE64 = 'b64_json';
+}

src/Services/API/Results/ChatResult.php

@@ -2,8 +2,6 @@
 
 namespace Itsimiro\OpenAI\Services\API\Results;
 
-use Spatie\LaravelData\Data;
-
 class ChatResult extends CompletionResult implements ResultInterface
 {
 

src/Services/API/Results/CompletionResult.php

@@ -2,11 +2,23 @@
 
 namespace Itsimiro\OpenAI\Services\API\Results;
 
+use Itsimiro\OpenAI\Services\API\Constants\BodyParameters;
 use Spatie\LaravelData\Data;
+use Spatie\LaravelData\Attributes\Validation\ArrayType;
 
 class CompletionResult extends Data implements ResultInterface
 {
-    public function __construct(public array $result)
+    public function __construct(
+        #[ArrayType([
+            BodyParameters::ID,
+            BodyParameters::OBJECT,
+            BodyParameters::CREATED_AT,
+            BodyParameters::MODEL,
+            BodyParameters::CHOICES,
+            BodyParameters::USAGE
+        ])]
+        public array $result
+    )
     {}
 
     public function getId(): string

src/Services/API/Results/CreateImageResult.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\API\Results;
+
+use Illuminate\Support\Arr;
+use Itsimiro\OpenAI\Services\API\Constants\ImageBodyParameters;
+use Itsimiro\OpenAI\Services\DataTransferObjects\Image;
+use Spatie\LaravelData\Attributes\Validation\ArrayType;
+use Spatie\LaravelData\Data;
+
+class CreateImageResult extends Data implements ResultInterface
+{
+    public function __construct(
+        #[ArrayType([
+            ImageBodyParameters::CREATED,
+            ImageBodyParameters::DATA,
+        ])]
+        public array $result
+    )
+    {}
+
+    public function getImages(): array
+    {
+        return array_map(
+            fn (array $image) => new Image($image),
+            Arr::get($this->result, ImageBodyParameters::DATA, [])
+        );
+    }
+
+    public function getCreatedDate()
+    {
+        return Arr::get($this->result, ImageBodyParameters::CREATED);
+    }
+}

src/Services/API/Results/EditsResult.php

@@ -2,11 +2,20 @@
 
 namespace Itsimiro\OpenAI\Services\API\Results;
 
+use Itsimiro\OpenAI\Services\API\Constants\BodyParameters;
+use Spatie\LaravelData\Attributes\Validation\ArrayType;
 use Spatie\LaravelData\Data;
 
 class EditsResult extends Data implements ResultInterface
 {
-    public function __construct(public array $result)
+    public function __construct(
+        #[ArrayType([
+            BodyParameters::CREATED_AT,
+            BodyParameters::CHOICES,
+            BodyParameters::USAGE
+        ])]
+        public array $result
+    )
     {}
 
     public function getCreateAt(): int

src/Services/API/Results/ModelResult.php

@@ -3,11 +3,20 @@
 namespace Itsimiro\OpenAI\Services\API\Results;
 
 use Illuminate\Support\Arr;
+use Itsimiro\OpenAI\Services\API\Constants\BodyParameters;
+use Spatie\LaravelData\Attributes\Validation\ArrayType;
 use Spatie\LaravelData\Data;
 
 class ModelResult extends Data implements ResultInterface
 {
-    public function __construct(public array $result)
+    public function __construct(
+        #[ArrayType([
+            BodyParameters::ID,
+            BodyParameters::OBJECT,
+            BodyParameters::OWNER_BY
+        ])]
+        public array $result
+    )
     {}
 
     public function getId(): string

src/Services/API/UrlService.php

@@ -44,9 +44,9 @@ public function answers(): string
         return $this->buildUrl('/answers');
     }
 
-    public function images(): string
+    public function createImage(): string
     {
-        return $this->buildUrl('/images');
+        return $this->buildUrl('/images/generations');
     }
 
     public function embeddings(): string

src/Services/DataTransferObjects/CreateImageParameters.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\DataTransferObjects;
+
+use Itsimiro\OpenAI\Enum\ImageResponseFormatEnum;
+use Itsimiro\OpenAI\Enum\ImageSizeEnum;
+use Spatie\LaravelData\Data;
+
+class CreateImageParameters extends Data
+{
+    public function __construct(
+        public string $prompt,
+        public int $imageCount = 1,
+        public ImageSizeEnum $size = ImageSizeEnum::LARGE,
+        public ImageResponseFormatEnum $responseFormat = ImageResponseFormatEnum::URL,
+        public string $user = ''
+    )
+    {}
+
+    public function toArray(): array
+    {
+        return [
+            'prompt' => $this->prompt,
+            'n' => $this->imageCount,
+            'size' => $this->size->value,
+            'response_format' => $this->responseFormat->value,
+            'user' => $this->user
+        ];
+    }
+}

src/Services/DataTransferObjects/Image.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Itsimiro\OpenAI\Services\DataTransferObjects;
+
+use Illuminate\Support\Arr;
+use Itsimiro\OpenAI\Services\API\Constants\ImageBodyParameters;
+use Spatie\LaravelData\Data;
+
+class Image extends Data
+{
+    public function __construct(
+        public array $data
+    )
+    {}
+
+    public function getUrl(): ?string
+    {
+        return Arr::get($this->data, ImageBodyParameters::URL);
+    }
+
+    public function getBase64(): ?string
+    {
+        return Arr::get($this->data, ImageBodyParameters::BASE64);
+    }
+}

tests/Unit/AIModels/DalleTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Itsimiro\OpenAI\Tests\Unit\AIModels;
+
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Contracts\Container\Container;
+use Itsimiro\OpenAI\Services\AIModels\Dalle;
+use Itsimiro\OpenAI\Services\API\ApiService;
+use Itsimiro\OpenAI\Services\API\Constants\ImageBodyParameters;
+use Itsimiro\OpenAI\Services\API\Results\CreateImageResult;
+use Itsimiro\OpenAI\Services\API\UrlService;
+use Itsimiro\OpenAI\Services\DataTransferObjects\CreateImageParameters;
+use Itsimiro\OpenAI\Services\DataTransferObjects\Image;
+use PHPUnit\Framework\MockObject\Exception;
+use PHPUnit\Framework\TestCase;
+
+class DalleTest extends TestCase
+{
+    private Container $app;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->app = app();
+    }
+
+    /**
+     * @throws Exception
+     * @throws BindingResolutionException
+     */
+    public function testCreateImage(): void
+    {
+        $expectedImage = new Image([
+            ImageBodyParameters::URL => 'test url',
+            ImageBodyParameters::BASE64 => '{"base64": "test"}',
+        ]);
+
+        $resultObject = $this->createMock(CreateImageResult::class);
+        $resultObject->method('getImages')->willReturn([
+            $expectedImage
+        ]);
+
+        $apiService = $this->createMock(ApiService::class);
+        $this->app->bind(ApiService::class, fn() => $apiService);
+        $apiService->expects($this->once())->method('getResult')->willReturn($resultObject);
+
+        $this->app->bind(UrlService::class, fn() => $this->createMock(UrlService::class));
+
+        $params = $this->createMock(CreateImageParameters::class);
+
+        $model = $this->app->make(Dalle::class);
+
+        $result = $model->createImage($params);
+
+        $this->assertCount(1, $result->getImages());
+        $this->assertEquals($expectedImage->getUrl(), $result->getImages()[0]->getUrl());
+    }
+}

tests/Unit/AIModels/GeneralTest.php

@@ -11,7 +11,6 @@
 use Itsimiro\OpenAI\Services\API\UrlService;
 use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\TestCase;
-use Spatie\LaravelData\DataCollection;
 
 class GeneralTest extends TestCase
 {