Fix: nullable fields on FineTunes create response and add missing fields on File repsonses

Author: gehrisandro

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## v0.2.1 (2022-11-09)
+### Fixed
+- FineTunes create response: `batch_size`, `learning_rate` and `fine_tuned_model` are nullable (#16)
+- File responses: add missing fields `status` and `status_details`
+
 ## v0.2.0 (2022-11-07)
 ### Added
 - Add `images()` resource to interact with [DALL-E](https://beta.openai.com/docs/api-reference/images)

README.md

@@ -236,6 +236,8 @@ $response->bytes; // 140
 $response->createdAt; // 1613779657
 $response->filename; // 'mydata.jsonl'
 $response->purpose; // 'fine-tune'
+$response->status; // 'succeeded'
+$response->status_details; // null
 
 $response->toArray(); // ['id' => 'file-XjGxS3KTG0uNmNOK362iJua3', ...]
 ```
@@ -256,6 +258,8 @@ $response->bytes; // 140
 $response->createdAt; // 1613779657
 $response->filename; // 'mydata.jsonl'
 $response->purpose; // 'fine-tune'
+$response->status; // 'succeeded'
+$response->status_details; // null
 
 $response->toArray(); // ['id' => 'file-XjGxS3KTG0uNmNOK362iJua3', ...]
 ```
@@ -340,6 +344,8 @@ foreach ($response->resultFiles as $result) {
     $result->createdAt; // 1613779657
     $result->filename; // 'mydata.jsonl'
     $result->purpose; // 'fine-tune'
+    $result->status; // 'succeeded'
+    $result->status_details; // null
 }
 
 foreach ($response->validationFiles as $result) {

src/Resources/Files.php

@@ -23,7 +23,7 @@ public function list(): ListResponse
     {
         $payload = Payload::list('files');
 
-        /** @var array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>} $result */
+        /** @var array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>} $result */
         $result = $this->transporter->requestObject($payload);
 
         return ListResponse::from($result);
@@ -38,7 +38,7 @@ public function retrieve(string $file): RetrieveResponse
     {
         $payload = Payload::retrieve('files', $file);
 
-        /** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string} $result */
+        /** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null} $result */
         $result = $this->transporter->requestObject($payload);
 
         return RetrieveResponse::from($result);
@@ -67,7 +67,7 @@ public function upload(array $parameters): CreateResponse
     {
         $payload = Payload::upload('files', $parameters);
 
-        /** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string} $result */
+        /** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null} $result */
         $result = $this->transporter->requestObject($payload);
 
         return CreateResponse::from($result);

src/Resources/FineTunes.php

@@ -26,7 +26,7 @@ public function create(array $parameters): RetrieveResponse
     {
         $payload = Payload::create('fine-tunes', $parameters);
 
-        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: string, hyperparams: array{batch_size: int, learning_rate_multiplier: float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, updated_at: int}  $result */
+        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: ?string, hyperparams: array{batch_size: ?int, learning_rate_multiplier: ?float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, updated_at: int}  $result */
         $result = $this->transporter->requestObject($payload);
 
         return RetrieveResponse::from($result);
@@ -41,7 +41,7 @@ public function list(): ListResponse
     {
         $payload = Payload::list('fine-tunes');
 
-        /** @var array{object: string, data: array<int, array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: string, hyperparams: array{batch_size: int, learning_rate_multiplier: float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, updated_at: int}>} $result */
+        /** @var array{object: string, data: array<int, array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: ?string, hyperparams: array{batch_size: ?int, learning_rate_multiplier: ?float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, updated_at: int}>} $result */
         $result = $this->transporter->requestObject($payload);
 
         return ListResponse::from($result);
@@ -56,7 +56,7 @@ public function retrieve(string $fineTuneId): RetrieveResponse
     {
         $payload = Payload::retrieve('fine-tunes', $fineTuneId);
 
-        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: string, hyperparams: array{batch_size: int, learning_rate_multiplier: float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, updated_at: int}  $result */
+        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: ?string, hyperparams: array{batch_size: ?int, learning_rate_multiplier: ?float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, updated_at: int}  $result */
         $result = $this->transporter->requestObject($payload);
 
         return RetrieveResponse::from($result);
@@ -71,7 +71,7 @@ public function cancel(string $fineTuneId): RetrieveResponse
     {
         $payload = Payload::cancel('fine-tunes', $fineTuneId);
 
-        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: string, hyperparams: array{batch_size: int, learning_rate_multiplier: float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>, updated_at: int}  $result */
+        /** @var array{id: string, object: string, model: string, created_at: int, events: array<int, array{object: string, created_at: int, level: string, message: string}>, fine_tuned_model: ?string, hyperparams: array{batch_size: ?int, learning_rate_multiplier: ?float, n_epochs: int, prompt_loss_weight: float}, organization_id: string, result_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, status: string, validation_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, training_files: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>, updated_at: int}  $result */
         $result = $this->transporter->requestObject($payload);
 
         return RetrieveResponse::from($result);

src/Responses/Files/CreateResponse.php

@@ -8,29 +8,34 @@
 use OpenAI\Responses\Concerns\ArrayAccessible;
 
 /**
- * @implements Response<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>
+ * @implements Response<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>
  */
 final class CreateResponse implements Response
 {
     /**
-     * @use ArrayAccessible<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>
+     * @use ArrayAccessible<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>
      */
     use ArrayAccessible;
 
+    /**
+     * @param  array<array-key, mixed>|null  $statusDetails
+     */
     private function __construct(
         public readonly string $id,
         public readonly string $object,
         public readonly int $bytes,
         public readonly int $createdAt,
         public readonly string $filename,
         public readonly string $purpose,
+        public readonly string $status,
+        public readonly ?array $statusDetails,
     ) {
     }
 
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}  $attributes
+     * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}  $attributes
      */
     public static function from(array $attributes): self
     {
@@ -41,6 +46,8 @@ public static function from(array $attributes): self
             $attributes['created_at'],
             $attributes['filename'],
             $attributes['purpose'],
+            $attributes['status'],
+            $attributes['status_details'],
         );
     }
 
@@ -56,6 +63,8 @@ public function toArray(): array
             'created_at' => $this->createdAt,
             'filename' => $this->filename,
             'purpose' => $this->purpose,
+            'status' => $this->status,
+            'status_details' => $this->statusDetails,
         ];
     }
 }

src/Responses/Files/ListResponse.php

@@ -8,12 +8,12 @@
 use OpenAI\Responses\Concerns\ArrayAccessible;
 
 /**
- * @implements Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>}>
+ * @implements Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>}>
  */
 final class ListResponse implements Response
 {
     /**
-     * @use ArrayAccessible<array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>}>
+     * @use ArrayAccessible<array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>}>
      */
     use ArrayAccessible;
 
@@ -29,7 +29,7 @@ private function __construct(
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @param  array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>}  $attributes
+     * @param  array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>}  $attributes
      */
     public static function from(array $attributes): self
     {

src/Responses/Files/RetrieveResponse.php

@@ -8,29 +8,34 @@
 use OpenAI\Responses\Concerns\ArrayAccessible;
 
 /**
- * @implements Response<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>
+ * @implements Response<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>
  */
 final class RetrieveResponse implements Response
 {
     /**
-     * @use ArrayAccessible<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}>
+     * @use ArrayAccessible<array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}>
      */
     use ArrayAccessible;
 
+    /**
+     * @param  array<array-key, mixed>|null  $statusDetails
+     */
     private function __construct(
         public readonly string $id,
         public readonly string $object,
         public readonly int $bytes,
         public readonly int $createdAt,
         public readonly string $filename,
         public readonly string $purpose,
+        public readonly string $status,
+        public readonly ?array $statusDetails,
     ) {
     }
 
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string}  $attributes
+     * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|null}  $attributes
      */
     public static function from(array $attributes): self
     {
@@ -41,6 +46,8 @@ public static function from(array $attributes): self
             $attributes['created_at'],
             $attributes['filename'],
             $attributes['purpose'],
+            $attributes['status'],
+            $attributes['status_details'],
         );
     }
 
@@ -56,6 +63,8 @@ public function toArray(): array
             'created_at' => $this->createdAt,
             'filename' => $this->filename,
             'purpose' => $this->purpose,
+            'status' => $this->status,
+            'status_details' => $this->statusDetails,
         ];
     }
 }