Annotations treated as arrays on message object

Author: Saraphoo

src/Responses/Chat/CreateResponseChoiceAnnotations.php

@@ -4,37 +4,30 @@
 
 final class CreateResponseChoiceAnnotations
 {
-    /**
-     * @param  array<int, CreateResponseChoiceAnnotationsUrlCitations>  $urlCitations
-     */
     public function __construct(
-        public readonly array $urlCitations
+        public readonly string $type,
+        public readonly CreateResponseChoiceAnnotationsUrlCitations $urlCitations
     ) {}
 
     /**
-     * @param  array<int, array{type: 'url_citation', url_citation: array{end_index: int, start_index: int, title: string, url: string}}>  $attributes
+     * @param  array{type: 'url_citation', url_citation: array{end_index: int, start_index: int, title: string, url: string}}  $attributes
      */
     public static function from(array $attributes): self
     {
-        $urlCitations = array_map(
-            fn (array $citation) => CreateResponseChoiceAnnotationsUrlCitations::from($citation['url_citation']),
-            $attributes
-        );
-
-        return new self($urlCitations);
+       return new self(
+           $attributes['type'],
+           CreateResponseChoiceAnnotationsUrlCitations::from($attributes['url_citation'])
+       );
     }
 
     /**
-     * @return array<int, array{type: 'url_citation', url_citation: array{end_index: int, start_index: int, title: string, url: string}}>
+     * @return array{type: 'url_citation', url_citation: array{end_index: int, start_index: int, title: string, url: string}}
      */
     public function toArray(): array
     {
-        return array_map(
-            fn (CreateResponseChoiceAnnotationsUrlCitations $citation) => [
-                'type' => 'url_citation',
-                'url_citation' => $citation->toArray(),
-            ],
-            $this->urlCitations
-        );
+        return [
+            'type' => $this->type,
+            'url_citation' => $this->urlCitations->toArray()
+        ];
     }
 }

src/Responses/Chat/CreateResponseMessage.php

@@ -12,31 +12,35 @@ final class CreateResponseMessage
     private function __construct(
         public readonly string $role,
         public readonly ?string $content,
-        public readonly ?CreateResponseChoiceAnnotations $annotations,
+        public readonly array $annotations,
         public readonly array $toolCalls,
         public readonly ?CreateResponseFunctionCall $functionCall,
     ) {}
 
     /**
-     * @param  array{role: string, content: ?string, annotations?: ?array<int, array{type: 'url_citation', url_citation: array{start_index: int, end_index: int, title: string, url: string}}>, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}  $attributes
+     * @param  array{role: string, content: ?string, annotations?: ?array{type: 'url_citation', url_citation: array{start_index: int, end_index: int, title: string, url: string}}, function_call: ?array{name: string, arguments: string}, tool_calls: ?array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}  $attributes
      */
     public static function from(array $attributes): self
     {
         $toolCalls = array_map(fn (array $result): CreateResponseToolCall => CreateResponseToolCall::from(
             $result
         ), $attributes['tool_calls'] ?? []);
 
+        $annotations = array_map(fn (array $result): CreateResponseChoiceAnnotations => CreateResponseChoiceAnnotations::from(
+            $result,
+        ), $attributes['annotations'] ?? []);
+
         return new self(
             $attributes['role'],
             $attributes['content'] ?? null,
-            isset($attributes['annotations']) ? CreateResponseChoiceAnnotations::from($attributes['annotations']) : null,
+            $annotations,
             $toolCalls,
             isset($attributes['function_call']) ? CreateResponseFunctionCall::from($attributes['function_call']) : null,
         );
     }
 
     /**
-     * @return array{role: string, content: string|null, annotations?: ?array<int, array{type: 'url_citation', url_citation: array{start_index: int, end_index: int, title: string, url: string}}>, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}
+     * @return array{role: string, content: string|null, annotations?: ?array{type: 'url_citation', url_citation: array{start_index: int, end_index: int, title: string, url: string}}, function_call?: array{name: string, arguments: string}, tool_calls?: array<int, array{id: string, type: string, function: array{name: string, arguments: string}}>}
      */
     public function toArray(): array
     {
@@ -45,8 +49,8 @@ public function toArray(): array
             'content' => $this->content,
         ];
 
-        if ($this->annotations) {
-            $data['annotations'] = $this->annotations->toArray();
+        if ($this->annotations !== []) {
+            $data['annotations'] = array_map(fn (CreateResponseChoiceAnnotations $annotations): array => $annotations->toArray(), $this->annotations);
         }
 
         if ($this->functionCall instanceof CreateResponseFunctionCall) {

tests/Responses/Chat/CreateResponseChoiceAnnotations.php

@@ -4,18 +4,16 @@
 use OpenAI\Responses\Chat\CreateResponseChoiceAnnotationsUrlCitations;
 
 it('from url_citation annotation', function () {
-    $result = CreateResponseChoiceAnnotations::from(chatCompletionWithAnnotations()['choices'][0]['message']['annotations']);
+    $result = CreateResponseChoiceAnnotations::from(chatCompletionWithAnnotations()['choices'][0]['message']['annotations'][0]);
 
     expect($result)
-        ->toBeInstanceOf(CreateResponseChoiceAnnotations::class)
-        ->urlCitations->toBeArray()
-        ->urlCitations->toHaveLength(1)
-        ->urlCitations->each->toBeInstanceOf(CreateResponseChoiceAnnotationsUrlCitations::class);
+        ->type->toBe('url_citation')
+        ->urlCitations->toBeInstanceOf(CreateResponseChoiceAnnotationsUrlCitations::class);
 });
 
 test('to array', function () {
-    $result = CreateResponseChoiceAnnotations::from(chatCompletionWithAnnotations()['choices'][0]['message']['annotations']);
+    $result = CreateResponseChoiceAnnotations::from(chatCompletionWithAnnotations()['choices'][0]['message']['annotations'][0]);
 
     expect($result->toArray())
-        ->toBe(chatCompletionWithAnnotations()['choices'][0]['message']['annotations']);
+        ->toBe(chatCompletionWithAnnotations()['choices'][0]['message']['annotations'][0]);
 });