WIP: refactor meta information class structure

openai-php · Aug 22, 2023 · 99933a0 · 99933a0
1 parent 0cea6f2
commit 99933a0
Show file tree

Hide file tree

Showing 61 changed files with 187 additions and 186 deletions.
diff --git a/...racts/ResponseMetaInformationContract.php → src/Contracts/MetaInformationContract.php b/...racts/ResponseMetaInformationContract.php → src/Contracts/MetaInformationContract.php
@@ -13,7 +13,7 @@
  *
  * @internal
  */
-interface ResponseMetaInformationContract extends ArrayAccess
+interface MetaInformationContract extends ArrayAccess
 {
     /**
      * Returns the array representation of the meta information.

diff --git a/src/Contracts/ResponseHasMetaInformationContract.php b/src/Contracts/ResponseHasMetaInformationContract.php
@@ -4,9 +4,9 @@
 
 namespace OpenAI\Contracts;
 
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 
 interface ResponseHasMetaInformationContract
 {
-    public function meta(): ResponseMetaInformation;
+    public function meta(): MetaInformation;
 }
diff --git a/src/Responses/Audio/TranscriptionResponse.php b/src/Responses/Audio/TranscriptionResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -33,7 +33,7 @@ private function __construct(
         public readonly ?float $duration,
         public readonly array $segments,
         public readonly string $text,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -42,7 +42,7 @@ private function __construct(
      *
      * @param  array{task: ?string, language: ?string, duration: ?float, segments: array<int, array{id: int, seek: int, start: float, end: float, text: string, tokens: array<int, int>, temperature: float, avg_logprob: float, compression_ratio: float, no_speech_prob: float, transient: bool}>, text: string}|string  $attributes
      */
-    public static function from(array|string $attributes, ResponseMetaInformation $meta): self
+    public static function from(array|string $attributes, MetaInformation $meta): self
     {
         if (is_string($attributes)) {
             $attributes = ['text' => $attributes];

diff --git a/src/Responses/Audio/TranslationResponse.php b/src/Responses/Audio/TranslationResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -33,7 +33,7 @@ private function __construct(
         public readonly ?float $duration,
         public readonly array $segments,
         public readonly string $text,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -42,7 +42,7 @@ private function __construct(
      *
      * @param  array{task: ?string, language: ?string, duration: ?float, segments: array<int, array{id: int, seek: int, start: float, end: float, text: string, tokens: array<int, int>, temperature: float, avg_logprob: float, compression_ratio: float, no_speech_prob: float, transient: bool}>, text: string}  $attributes
      */
-    public static function from(array|string $attributes, ResponseMetaInformation $meta): self
+    public static function from(array|string $attributes, MetaInformation $meta): self
     {
         if (is_string($attributes)) {
             $attributes = ['text' => $attributes];

diff --git a/src/Responses/Chat/CreateResponse.php b/src/Responses/Chat/CreateResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -34,7 +34,7 @@ private function __construct(
         public readonly string $model,
         public readonly array $choices,
         public readonly CreateResponseUsage $usage,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -43,7 +43,7 @@ private function __construct(
      *
      * @param  array{id: string, object: string, created: int, model: string, choices: array<int, array{index: int, message: array{role: string, content: ?string, function_call: ?array{name: string, arguments: string}}, finish_reason: string|null}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $choices = array_map(fn (array $result): CreateResponseChoice => CreateResponseChoice::from(
             $result

diff --git a/src/Responses/Completions/CreateResponse.php b/src/Responses/Completions/CreateResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -34,7 +34,7 @@ private function __construct(
         public readonly string $model,
         public readonly array $choices,
         public readonly CreateResponseUsage $usage,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -43,7 +43,7 @@ private function __construct(
      *
      * @param  array{id: string, object: string, created: int, model: string, choices: array<int, array{text: string, index: int, logprobs: array{tokens: array<int, string>, token_logprobs: array<int, float>, top_logprobs: array<int, string>|null, text_offset: array<int, int>}|null, finish_reason: string}>, usage: array{prompt_tokens: int, completion_tokens: int|null, total_tokens: int}}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $choices = array_map(fn (array $result): CreateResponseChoice => CreateResponseChoice::from(
             $result

diff --git a/src/Responses/Concerns/HasMetaInformation.php b/src/Responses/Concerns/HasMetaInformation.php
@@ -4,11 +4,11 @@
 
 namespace OpenAI\Responses\Concerns;
 
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 
 trait HasMetaInformation
 {
-    public function meta(): ResponseMetaInformation
+    public function meta(): MetaInformation
     {
         return $this->meta;
     }

diff --git a/src/Responses/Edits/CreateResponse.php b/src/Responses/Edits/CreateResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -32,7 +32,7 @@ private function __construct(
         public readonly int $created,
         public readonly array $choices,
         public readonly CreateResponseUsage $usage,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -41,7 +41,7 @@ private function __construct(
      *
      * @param  array{object: string, created: int, choices: array<int, array{text: string, index: int}>, usage: array{prompt_tokens: int, completion_tokens: int, total_tokens: int}}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $choices = array_map(fn (array $result): CreateResponseChoice => CreateResponseChoice::from(
             $result

diff --git a/src/Responses/Embeddings/CreateResponse.php b/src/Responses/Embeddings/CreateResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -31,7 +31,7 @@ private function __construct(
         public readonly string $object,
         public readonly array $embeddings,
         public readonly CreateResponseUsage $usage,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -40,7 +40,7 @@ private function __construct(
      *
      * @param  array{object: string, data: array<int, array{object: string, embedding: array<int, float>, index: int}>, usage: array{prompt_tokens: int, total_tokens: int}}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $embeddings = array_map(fn (array $result): CreateResponseEmbedding => CreateResponseEmbedding::from(
             $result

diff --git a/src/Responses/Files/CreateResponse.php b/src/Responses/Files/CreateResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -36,7 +36,7 @@ private function __construct(
         public readonly string $purpose,
         public readonly string $status,
         public readonly array|string|null $statusDetails,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -45,7 +45,7 @@ private function __construct(
      *
      * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         return new self(
             $attributes['id'],

diff --git a/src/Responses/Files/DeleteResponse.php b/src/Responses/Files/DeleteResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -28,7 +28,7 @@ private function __construct(
         public readonly string $id,
         public readonly string $object,
         public readonly bool $deleted,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -37,7 +37,7 @@ private function __construct(
      *
      * @param  array{id: string, object: string, deleted: bool}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         return new self(
             $attributes['id'],

diff --git a/src/Responses/Files/ListResponse.php b/src/Responses/Files/ListResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -30,7 +30,7 @@ final class ListResponse implements ResponseContract, ResponseHasMetaInformation
     private function __construct(
         public readonly string $object,
         public readonly array $data,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -39,7 +39,7 @@ private function __construct(
      *
      * @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>|string|null}>}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $data = array_map(fn (array $result): RetrieveResponse => RetrieveResponse::from(
             $result,

diff --git a/src/Responses/Files/RetrieveResponse.php b/src/Responses/Files/RetrieveResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -36,7 +36,7 @@ private function __construct(
         public readonly string $purpose,
         public readonly string $status,
         public readonly array|string|null $statusDetails,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -45,7 +45,7 @@ private function __construct(
      *
      * @param  array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         return new self(
             $attributes['id'],

diff --git a/src/Responses/FineTunes/ListEventsResponse.php b/src/Responses/FineTunes/ListEventsResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -30,7 +30,7 @@ final class ListEventsResponse implements ResponseContract, ResponseHasMetaInfor
     private function __construct(
         public readonly string $object,
         public readonly array $data,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -39,7 +39,7 @@ private function __construct(
      *
      * @param  array{object: string, data: array<int, array{object: string, created_at: int, level: string, message: string}>}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $data = array_map(fn (array $result): RetrieveResponseEvent => RetrieveResponseEvent::from(
             $result

diff --git a/src/Responses/FineTunes/ListResponse.php b/src/Responses/FineTunes/ListResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -30,7 +30,7 @@ final class ListResponse implements ResponseContract, ResponseHasMetaInformation
     private function __construct(
         public readonly string $object,
         public readonly array $data,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -39,7 +39,7 @@ private function __construct(
      *
      * @param  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>|string|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>|string|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>|string|null}>, updated_at: int}>}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $data = array_map(fn (array $result): RetrieveResponse => RetrieveResponse::from(
             $result,

diff --git a/src/Responses/FineTunes/RetrieveResponse.php b/src/Responses/FineTunes/RetrieveResponse.php
@@ -8,7 +8,7 @@
 use OpenAI\Contracts\ResponseHasMetaInformationContract;
 use OpenAI\Responses\Concerns\ArrayAccessible;
 use OpenAI\Responses\Concerns\HasMetaInformation;
-use OpenAI\Responses\ResponseMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
@@ -44,7 +44,7 @@ private function __construct(
         public readonly array $validationFiles,
         public readonly array $trainingFiles,
         public readonly int $updatedAt,
-        private readonly ResponseMetaInformation $meta,
+        private readonly MetaInformation $meta,
     ) {
     }
 
@@ -53,7 +53,7 @@ private function __construct(
      *
      * @param  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>|string|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>|string|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>|string|null}>, updated_at: int}  $attributes
      */
-    public static function from(array $attributes, ResponseMetaInformation $meta): self
+    public static function from(array $attributes, MetaInformation $meta): self
     {
         $events = array_map(fn (array $result): RetrieveResponseEvent => RetrieveResponseEvent::from(
             $result