Add revised_prompt property to Image/CreateResponseData

Author: gehrisandro

src/Resources/Images.php

@@ -26,7 +26,7 @@ public function create(array $parameters): CreateResponse
     {
         $payload = Payload::create('images/generations', $parameters);
 
-        /** @var Response<array{created: int, data: array<int, array{url?: string, b64_json?: string}>}> $response */
+        /** @var Response<array{created: int, data: array<int, array{url?: string, b64_json?: string, revised_prompt?: string}>}> $response */
         $response = $this->transporter->requestObject($payload);
 
         return CreateResponse::from($response->data(), $response->meta());

src/Responses/Images/CreateResponse.php

@@ -12,12 +12,12 @@
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
- * @implements ResponseContract<array{created: int, data: array<int, array{url?: string, b64_json?: string}>}>
+ * @implements ResponseContract<array{created: int, data: array<int, array{url?: string, b64_json?: string, revised_prompt?: string}>}>
  */
 final class CreateResponse implements ResponseContract, ResponseHasMetaInformationContract
 {
     /**
-     * @use ArrayAccessible<array{created: int, data: array<int, array{url?: string, b64_json?: string}>}>
+     * @use ArrayAccessible<array{created: int, data: array<int, array{url?: string, b64_json?: string, revised_prompt?: string}>}>
      */
     use ArrayAccessible;
 
@@ -37,7 +37,7 @@ private function __construct(
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @param  array{created: int, data: array<int, array{url?: string, b64_json?: string}>}  $attributes
+     * @param  array{created: int, data: array<int, array{url?: string, b64_json?: string, revised_prompt?: string}>}  $attributes
      */
     public static function from(array $attributes, MetaInformation $meta): self
     {

src/Responses/Images/CreateResponseData.php

@@ -8,31 +8,33 @@
 use OpenAI\Responses\Concerns\ArrayAccessible;
 
 /**
- * @implements ResponseContract<array{url: string}|array{b64_json: string}>
+ * @implements ResponseContract<array{url: string, revised_prompt?: string}|array{b64_json: string, revised_prompt?: string}>
  */
 final class CreateResponseData implements ResponseContract
 {
     /**
-     * @use ArrayAccessible<array{url: string}|array{b64_json: string}>
+     * @use ArrayAccessible<array{url: string, revised_prompt?: string}|array{b64_json: string, revised_prompt?: string}>
      */
     use ArrayAccessible;
 
     private function __construct(
-        public readonly string $url = '',
-        public readonly string $b64_json = '',
+        public readonly string $url,
+        public readonly string $b64_json,
+        public readonly ?string $revisedPrompt,
     ) {
     }
 
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @param  array{url?: string, b64_json?: string}  $attributes
+     * @param  array{url?: string, b64_json?: string, revised_prompt?: string}  $attributes
      */
     public static function from(array $attributes): self
     {
         return new self(
             $attributes['url'] ?? '',
             $attributes['b64_json'] ?? '',
+            $attributes['revised_prompt'] ?? null,
         );
     }
 
@@ -41,8 +43,14 @@ public static function from(array $attributes): self
      */
     public function toArray(): array
     {
-        return $this->url !== '' && $this->url !== '0' ?
+        $data = $this->url !== '' && $this->url !== '0' ?
             ['url' => $this->url] :
             ['b64_json' => $this->b64_json];
+
+        if ($this->revisedPrompt !== null) {
+            $data['revised_prompt'] = $this->revisedPrompt;
+        }
+
+        return $data;
     }
 }

tests/Fixtures/Image.php

@@ -15,6 +15,22 @@ function imageCreateWithUrl(): array
     ];
 }
 
+/**
+ * @return array<string, mixed>
+ */
+function imageCreateWithUrlDallE3(): array
+{
+    return [
+        'created' => 1664136088,
+        'data' => [
+            [
+                'url' => 'https://openai.com/image.png',
+                'revised_prompt' => 'This is a revised prompt.',
+            ],
+        ],
+    ];
+}
+
 /**
  * @return array<string, mixed>
  */

tests/Responses/Images/CreateResponseData.php

@@ -17,6 +17,22 @@
         ->toBe(imageCreateWithUrl()['data'][0]);
 });
 
+test('from with url from dall-e 3', function () {
+    $response = CreateResponseData::from(imageCreateWithUrlDallE3()['data'][0]);
+
+    expect($response)
+        ->url->toBe('https://openai.com/image.png')
+        ->revisedPrompt->toBe('This is a revised prompt.')
+        ->b64_json->toBeEmpty();
+});
+
+test('to array with url from dall-e 3', function () {
+    $result = CreateResponseData::from(imageCreateWithUrlDallE3()['data'][0]);
+
+    expect($result->toArray())
+        ->toBe(imageCreateWithUrlDallE3()['data'][0]);
+});
+
 test('from with b64_json', function () {
     $response = CreateResponseData::from(imageCreateWithB46Json()['data'][0]);