fix(OpenAI): Add model field to CreateResponse for embeddings (#634)

* Add model field to CreateResponse for embeddings

* remove comments

* Add model field to CreateResponse for embeddings

remove comments

* add missing 'model' offset to type definition

* make model embedding property nullable

Author: bemtorres

README.md

@@ -697,6 +697,7 @@ $response->object; // 'list'
 
 foreach ($response->embeddings as $embedding) {
     $embedding->object; // 'embedding'
+    $embedding->model; // 'text-similarity-babbage-001'
     $embedding->embedding; // [0.018990106880664825, -0.0073809814639389515, ...]
     $embedding->index; // 0
 }

src/Resources/Embeddings.php

@@ -24,7 +24,7 @@ public function create(array $parameters): CreateResponse
     {
         $payload = Payload::create('embeddings', $parameters);
 
-        /** @var Response<array{object: string, data: array<int, array{object: string, embedding: array<int, float>, index: int}>, usage: array{prompt_tokens: int, total_tokens: int}}> $response */
+        /** @var Response<array{object: string, model: string, data: array<int, array{object: string, embedding: array<int, float>, index: int}>, usage: array{prompt_tokens: int, total_tokens: int}}> $response */
         $response = $this->transporter->requestObject($payload);
 
         return CreateResponse::from($response->data(), $response->meta());

src/Responses/Embeddings/CreateResponse.php

@@ -12,12 +12,12 @@
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
- * @implements ResponseContract<array{object: string, data: array<int, array{object: string, embedding: array<int, float>, index?: int}>, usage?: array{prompt_tokens: int, total_tokens: int}}>
+ * @implements ResponseContract<array{object: string, model?: string|null, data: array<int, array{object: string, embedding: array<int, float>, index?: int}>, usage?: array{prompt_tokens: int, total_tokens: int}}>
  */
 final class CreateResponse implements ResponseContract, ResponseHasMetaInformationContract
 {
     /**
-     * @use ArrayAccessible<array{object: string, data: array<int, array{object: string, embedding: array<int, float>, index?: int}>, usage?: array{prompt_tokens: int, total_tokens: int}}>
+     * @use ArrayAccessible<array{object: string, model?: string|null, data: array<int, array{object: string, embedding: array<int, float>, index?: int}>, usage?: array{prompt_tokens: int, total_tokens: int}}>
      */
     use ArrayAccessible;
 
@@ -29,6 +29,7 @@ final class CreateResponse implements ResponseContract, ResponseHasMetaInformati
      */
     private function __construct(
         public readonly string $object,
+        public readonly ?string $model,
         public readonly array $embeddings,
         public readonly ?CreateResponseUsage $usage,
         private readonly MetaInformation $meta,
@@ -37,7 +38,7 @@ private function __construct(
     /**
      * Acts as static factory, and returns a new Response instance.
      *
-     * @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
+     * @param  array{object: string, model?: string|null, 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, MetaInformation $meta): self
     {
@@ -47,6 +48,7 @@ public static function from(array $attributes, MetaInformation $meta): self
 
         return new self(
             $attributes['object'],
+            $attributes['model'] ?? null,
             $embeddings,
             isset($attributes['usage']) ? CreateResponseUsage::from($attributes['usage']) : null,
             $meta,
@@ -60,6 +62,7 @@ public function toArray(): array
     {
         return array_filter([
             'object' => $this->object,
+            'model' => $this->model ?? null,
             'data' => array_map(
                 static fn (CreateResponseEmbedding $result): array => $result->toArray(),
                 $this->embeddings,

src/Testing/Responses/Fixtures/Embeddings/CreateResponseFixture.php

@@ -6,6 +6,7 @@ final class CreateResponseFixture
 {
     public const ATTRIBUTES = [
         'object' => 'list',
+        'model' => 'text-embedding-3-small',
         'data' => [
             [
                 'object' => 'embedding',

tests/Fixtures/Embedding.php

@@ -38,6 +38,7 @@ function embeddingList(): array
 {
     return [
         'object' => 'list',
+        'model' => 'text-embedding-3-small',
         'data' => [
             embedding(),
             embedding(),
@@ -56,9 +57,28 @@ function embeddingListWithoutUsage(): array
 {
     return [
         'object' => 'list',
+        'model' => 'text-embedding-3-small',
         'data' => [
             embedding(),
             embedding(),
         ],
     ];
 }
+
+/**
+ * @return array<string, mixed>
+ */
+function embeddingListWithoutModel(): array
+{
+    return [
+        'object' => 'list',
+        'data' => [
+            embedding(),
+            embedding(),
+        ],
+        'usage' => [
+            'prompt_tokens' => 8,
+            'total_tokens' => 8,
+        ],
+    ];
+}

tests/Responses/Embeddings/CreateResponse.php

@@ -11,6 +11,7 @@
     expect($response)
         ->toBeInstanceOf(CreateResponse::class)
         ->object->toBe('list')
+        ->model->toBe('text-embedding-3-small')
         ->embeddings->toBeArray()->toHaveCount(2)
         ->embeddings->each->toBeInstanceOf(CreateResponseEmbedding::class)
         ->usage->toBeInstanceOf(CreateResponseUsage::class)
@@ -23,12 +24,26 @@
     expect($response)
         ->toBeInstanceOf(CreateResponse::class)
         ->object->toBe('list')
+        ->model->toBe('text-embedding-3-small')
         ->embeddings->toBeArray()->toHaveCount(2)
         ->embeddings->each->toBeInstanceOf(CreateResponseEmbedding::class)
         ->usage->toBeNull()
         ->meta()->toBeInstanceOf(MetaInformation::class);
 });
 
+test('from without model', function () {
+    $response = CreateResponse::from(embeddingListWithoutModel(), meta());
+
+    expect($response)
+        ->toBeInstanceOf(CreateResponse::class)
+        ->object->toBe('list')
+        ->model->toBeNull()
+        ->embeddings->toBeArray()->toHaveCount(2)
+        ->embeddings->each->toBeInstanceOf(CreateResponseEmbedding::class)
+        ->usage->toBeInstanceOf(CreateResponseUsage::class)
+        ->meta()->toBeInstanceOf(MetaInformation::class);
+});
+
 test('as array accessible', function () {
     $response = CreateResponse::from(embeddingList(), meta());
 
@@ -41,6 +56,12 @@
     expect($response->toArray())->toBeArray()->toBe(embeddingList());
 });
 
+test('to array without model', function () {
+    $response = CreateResponse::from(embeddingListWithoutModel(), meta());
+
+    expect($response->toArray())->toBeArray()->toBe(embeddingListWithoutModel());
+});
+
 test('fake', function () {
     $response = CreateResponse::fake();