fix(OpenAI) - Add index to CreateStreamedResponseToolCall (#562)

clementmas · web-flow · commit 199d23715ae9 · 2025-05-22T10:25:03.000-04:00
* Update CreateStreamedResponseToolCall.php

* provide index to CreateStreamedResponseToolCall toArray method

* fix type coverage in CreateStreamedResponseToolCall toArray method
diff --git a/src/Responses/Chat/CreateStreamedResponseToolCall.php b/src/Responses/Chat/CreateStreamedResponseToolCall.php
@@ -7,32 +7,35 @@
 final class CreateStreamedResponseToolCall
 {
     private function __construct(
+        public readonly ?int $index,
         public readonly ?string $id,
         public readonly ?string $type,
         public readonly CreateStreamedResponseToolCallFunction $function,
     ) {}
 
     /**
-     * @param  array{id?: string, type?: string, function: array{name?: string, arguments: string}}  $attributes
+     * @param  array{index?: int, id?: string, type?: string, function: array{name?: string, arguments: string}}  $attributes
      */
     public static function from(array $attributes): self
     {
         return new self(
+            $attributes['index'] ?? null,
             $attributes['id'] ?? null,
             $attributes['type'] ?? null,
             CreateStreamedResponseToolCallFunction::from($attributes['function']),
         );
     }
 
     /**
-     * @return array{id?: string, type?: string, function?: array{name?: string, arguments: string}}
+     * @return array{index?: int, id?: string, type?: string, function?: array{name?: string, arguments: string}}
      */
     public function toArray(): array
     {
         return array_filter([
+            'index' => $this->index,
             'id' => $this->id,
             'type' => $this->type,
             'function' => $this->function->toArray(),
-        ]);
+        ], fn (mixed $value): bool => ! is_null($value));
     }
 }
diff --git a/tests/Fixtures/Chat.php b/tests/Fixtures/Chat.php
@@ -601,6 +601,7 @@ function chatCompletionStreamToolCallsChunk(): array
                 'delta' => [
                     'tool_calls' => [
                         [
+                            'index' => 0,
                             'id' => 'call_trlgKnhMpYSC7CFXKw3CceUZ',
                             'type' => 'function',
                             'function' => [

Original file line number	Diff line number	Diff line change
`@@ -601,6 +601,7 @@ function chatCompletionStreamToolCallsChunk(): array`
`601`	`601`	`'delta' => [`
`602`	`602`	`'tool_calls' => [`
`603`	`603`	`[`
	`604`	`+ 'index' => 0,`
`604`	`605`	`'id' => 'call_trlgKnhMpYSC7CFXKw3CceUZ',`
`605`	`606`	`'type' => 'function',`
`606`	`607`	`'function' => [`