fix: missing openai-version header from azure - fixes #201

openai-php · Aug 31, 2023 · ddab64d · ddab64d
1 parent ca17a3d
commit ddab64d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/src/Responses/Meta/MetaInformation.php b/src/Responses/Meta/MetaInformation.php
@@ -6,12 +6,12 @@
 use OpenAI\Responses\Concerns\ArrayAccessible;
 
 /**
- * @implements MetaInformationContract<array{x-request-id: string, openai-model?: string, openai-organization?: string, openai-processing-ms: int, openai-version: string, x-ratelimit-limit-requests?: int, x-ratelimit-limit-tokens?: int, x-ratelimit-remaining-requests?: int, x-ratelimit-remaining-tokens?: int, x-ratelimit-reset-requests?: string, x-ratelimit-reset-tokens?: string, x-request-id: string}>
+ * @implements MetaInformationContract<array{x-request-id: string, openai-model?: string, openai-organization?: string, openai-processing-ms: int, openai-version?: string, x-ratelimit-limit-requests?: int, x-ratelimit-limit-tokens?: int, x-ratelimit-remaining-requests?: int, x-ratelimit-remaining-tokens?: int, x-ratelimit-reset-requests?: string, x-ratelimit-reset-tokens?: string, x-request-id: string}>
  */
 final class MetaInformation implements MetaInformationContract
 {
     /**
-     * @use ArrayAccessible<array{x-request-id: string, openai-model?: string, openai-organization?: string, openai-processing-ms: int, openai-version: string, x-ratelimit-limit-requests?: int, x-ratelimit-limit-tokens?: int, x-ratelimit-remaining-requests?: int, x-ratelimit-remaining-tokens?: int, x-ratelimit-reset-requests?: string, x-ratelimit-reset-tokens?: string, x-request-id: string}>
+     * @use ArrayAccessible<array{x-request-id: string, openai-model?: string, openai-organization?: string, openai-processing-ms: int, openai-version?: string, x-ratelimit-limit-requests?: int, x-ratelimit-limit-tokens?: int, x-ratelimit-remaining-requests?: int, x-ratelimit-remaining-tokens?: int, x-ratelimit-reset-requests?: string, x-ratelimit-reset-tokens?: string, x-request-id: string}>
      */
     use ArrayAccessible;
 
@@ -33,7 +33,7 @@ public static function from(array $headers): self
         $openai = MetaInformationOpenAI::from([
             'model' => $headers['openai-model'][0] ?? null,
             'organization' => $headers['openai-organization'][0] ?? null,
-            'version' => $headers['openai-version'][0],
+            'version' => $headers['openai-version'][0] ?? null,
             'processingMs' => (int) $headers['openai-processing-ms'][0],
         ]);
 

diff --git a/src/Responses/Meta/MetaInformationOpenAI.php b/src/Responses/Meta/MetaInformationOpenAI.php
@@ -7,13 +7,13 @@ final class MetaInformationOpenAI
     public function __construct(
         public readonly ?string $model,
         public readonly ?string $organization,
-        public readonly string $version,
+        public readonly ?string $version,
         public readonly int $processingMs,
     ) {
     }
 
     /**
-     * @param  array{model: ?string, organization: ?string, version: string, processingMs: int}  $attributes
+     * @param  array{model: ?string, organization: ?string, version: ?string, processingMs: int}  $attributes
      */
     public static function from(array $attributes): self
     {

diff --git a/tests/Fixtures/Meta.php b/tests/Fixtures/Meta.php
@@ -19,6 +19,15 @@ function metaHeaders(): array
     ];
 }
 
+function metaHeadersFromAzure(): array
+{
+    return [
+        'openai-model' => ['text-davinci-003'],
+        'openai-processing-ms' => [3482.8264],
+        'x-request-id' => ['3813fa4fa3f17bdf0d7654f0f49ebab4'],
+    ];
+}
+
 function meta(): MetaInformation
 {
     return MetaInformation::from(metaHeaders());

diff --git a/tests/Responses/Meta/MetaInformation.php b/tests/Responses/Meta/MetaInformation.php
@@ -25,6 +25,21 @@
         ->tokenLimit->reset->toBe('2ms');
 });
 
+test('from azure response headers', function () {
+    $meta = MetaInformation::from((new \GuzzleHttp\Psr7\Response(headers: metaHeadersFromAzure()))->getHeaders());
+
+    expect($meta)
+        ->toBeInstanceOf(MetaInformation::class)
+        ->requestId->toBe('3813fa4fa3f17bdf0d7654f0f49ebab4')
+        ->openai->toBeInstanceOf(MetaInformationOpenAI::class)
+        ->openai->model->toBe('text-davinci-003')
+        ->openai->organization->toBeNull()
+        ->openai->version->toBeNull()
+        ->openai->processingMs->toBe(3482)
+        ->requestLimit->toBeNull()
+        ->tokenLimit->toBeNull();
+});
+
 test('as array accessible', function () {
     $meta = MetaInformation::from(metaHeaders());