fix(OpenAI): Add support for reasoning text streaming events (#673)

* Add support for `response.reasoning_text.delta` and `response.reasoning_text.done` events.

* Remove `type` attribute from `ReasoningTextDelta` and `ReasoningTextDone` responses.

Author: louisbels

src/Responses/Responses/CreateStreamedResponse.php

@@ -29,6 +29,8 @@
 use OpenAI\Responses\Responses\Streaming\ReasoningSummaryPart;
 use OpenAI\Responses\Responses\Streaming\ReasoningSummaryTextDelta;
 use OpenAI\Responses\Responses\Streaming\ReasoningSummaryTextDone;
+use OpenAI\Responses\Responses\Streaming\ReasoningTextDelta;
+use OpenAI\Responses\Responses\Streaming\ReasoningTextDone;
 use OpenAI\Responses\Responses\Streaming\RefusalDelta;
 use OpenAI\Responses\Responses\Streaming\RefusalDone;
 use OpenAI\Responses\Responses\Streaming\WebSearchCall;
@@ -50,7 +52,7 @@ final class CreateStreamedResponse implements ResponseContract
 
     private function __construct(
         public readonly string $event,
-        public readonly CreateResponse|OutputItem|ContentPart|OutputTextDelta|OutputTextAnnotationAdded|OutputTextDone|RefusalDelta|RefusalDone|FunctionCallArgumentsDelta|FunctionCallArgumentsDone|FileSearchCall|WebSearchCall|CodeInterpreterCall|CodeInterpreterCodeDelta|CodeInterpreterCodeDone|ReasoningSummaryPart|ReasoningSummaryTextDelta|ReasoningSummaryTextDone|McpListTools|McpListToolsInProgress|McpCall|McpCallArgumentsDelta|McpCallArgumentsDone|ImageGenerationPart|ImageGenerationPartialImage|Error $response,
+        public readonly CreateResponse|OutputItem|ContentPart|OutputTextDelta|OutputTextAnnotationAdded|OutputTextDone|RefusalDelta|RefusalDone|FunctionCallArgumentsDelta|FunctionCallArgumentsDone|FileSearchCall|WebSearchCall|CodeInterpreterCall|CodeInterpreterCodeDelta|CodeInterpreterCodeDone|ReasoningSummaryPart|ReasoningSummaryTextDelta|ReasoningSummaryTextDone|ReasoningTextDelta|ReasoningTextDone|McpListTools|McpListToolsInProgress|McpCall|McpCallArgumentsDelta|McpCallArgumentsDone|ImageGenerationPart|ImageGenerationPartialImage|Error $response,
     ) {}
 
     /**
@@ -95,6 +97,8 @@ public static function from(array $attributes): self
             'response.reasoning_summary_part.done' => ReasoningSummaryPart::from($attributes, $meta), // @phpstan-ignore-line
             'response.reasoning_summary_text.delta' => ReasoningSummaryTextDelta::from($attributes, $meta), // @phpstan-ignore-line
             'response.reasoning_summary_text.done' => ReasoningSummaryTextDone::from($attributes, $meta), // @phpstan-ignore-line
+            'response.reasoning_text.delta' => ReasoningTextDelta::from($attributes, $meta), // @phpstan-ignore-line
+            'response.reasoning_text.done' => ReasoningTextDone::from($attributes, $meta), // @phpstan-ignore-line
             'response.mcp_list_tools.in_progress' => McpListToolsInProgress::from($attributes, $meta), // @phpstan-ignore-line
             'response.mcp_list_tools.failed',
             'response.mcp_list_tools.completed' => McpListTools::from($attributes, $meta), // @phpstan-ignore-line

src/Responses/Responses/Streaming/ReasoningTextDelta.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Responses\Responses\Streaming;
+
+use OpenAI\Contracts\ResponseContract;
+use OpenAI\Contracts\ResponseHasMetaInformationContract;
+use OpenAI\Responses\Concerns\ArrayAccessible;
+use OpenAI\Responses\Concerns\HasMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
+use OpenAI\Testing\Responses\Concerns\Fakeable;
+
+/**
+ * @phpstan-type ReasoningTextDeltaType array{content_index: int, delta: string, item_id: string, output_index: int, sequence_number: int}
+ *
+ * @implements ResponseContract<ReasoningTextDeltaType>
+ */
+final class ReasoningTextDelta implements ResponseContract, ResponseHasMetaInformationContract
+{
+    /**
+     * @use ArrayAccessible<ReasoningTextDeltaType>
+     */
+    use ArrayAccessible;
+
+    use Fakeable;
+    use HasMetaInformation;
+
+    private function __construct(
+        public readonly int $contentIndex,
+        public readonly string $delta,
+        public readonly string $itemId,
+        public readonly int $outputIndex,
+        public readonly int $sequenceNumber,
+        private readonly MetaInformation $meta,
+    ) {}
+
+    /**
+     * @param  ReasoningTextDeltaType  $attributes
+     */
+    public static function from(array $attributes, MetaInformation $meta): self
+    {
+        return new self(
+            contentIndex: $attributes['content_index'],
+            delta: $attributes['delta'],
+            itemId: $attributes['item_id'],
+            outputIndex: $attributes['output_index'],
+            sequenceNumber: $attributes['sequence_number'],
+            meta: $meta,
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [
+            'content_index' => $this->contentIndex,
+            'delta' => $this->delta,
+            'item_id' => $this->itemId,
+            'output_index' => $this->outputIndex,
+            'sequence_number' => $this->sequenceNumber,
+        ];
+    }
+}

src/Responses/Responses/Streaming/ReasoningTextDone.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Responses\Responses\Streaming;
+
+use OpenAI\Contracts\ResponseContract;
+use OpenAI\Contracts\ResponseHasMetaInformationContract;
+use OpenAI\Responses\Concerns\ArrayAccessible;
+use OpenAI\Responses\Concerns\HasMetaInformation;
+use OpenAI\Responses\Meta\MetaInformation;
+use OpenAI\Testing\Responses\Concerns\Fakeable;
+
+/**
+ * @phpstan-type ReasoningTextDoneType array{content_index: int, item_id: string, output_index: int, sequence_number: int, text: string}
+ *
+ * @implements ResponseContract<ReasoningTextDoneType>
+ */
+final class ReasoningTextDone implements ResponseContract, ResponseHasMetaInformationContract
+{
+    /**
+     * @use ArrayAccessible<ReasoningTextDoneType>
+     */
+    use ArrayAccessible;
+
+    use Fakeable;
+    use HasMetaInformation;
+
+    private function __construct(
+        public readonly int $contentIndex,
+        public readonly string $itemId,
+        public readonly int $outputIndex,
+        public readonly int $sequenceNumber,
+        public readonly string $text,
+        private readonly MetaInformation $meta,
+    ) {}
+
+    /**
+     * @param  ReasoningTextDoneType  $attributes
+     */
+    public static function from(array $attributes, MetaInformation $meta): self
+    {
+        return new self(
+            contentIndex: $attributes['content_index'],
+            itemId: $attributes['item_id'],
+            outputIndex: $attributes['output_index'],
+            sequenceNumber: $attributes['sequence_number'],
+            text: $attributes['text'],
+            meta: $meta,
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [
+            'content_index' => $this->contentIndex,
+            'item_id' => $this->itemId,
+            'output_index' => $this->outputIndex,
+            'sequence_number' => $this->sequenceNumber,
+            'text' => $this->text,
+        ];
+    }
+}

tests/Fixtures/Responses.php

@@ -760,3 +760,13 @@ function responseCompletionSteamCreatedEvent()
 {
     return fopen(__DIR__.'/Streams/ResponseCreatedResponse.txt', 'r');
 }
+
+function responseReasoningTextDeltaEvent()
+{
+    return fopen(__DIR__.'/Streams/ResponseReasoningTextDelta.txt', 'r');
+}
+
+function responseReasoningTextDoneEvent()
+{
+    return fopen(__DIR__.'/Streams/ResponseReasoningTextDone.txt', 'r');
+}

tests/Fixtures/Streams/ResponseReasoningTextDelta.txt

@@ -0,0 +1 @@
+data: {"type":"response.reasoning_text.delta","content_index":0,"delta":"Let me analyze","item_id":"item_123","output_index":0,"sequence_number":5}

tests/Fixtures/Streams/ResponseReasoningTextDone.txt

@@ -0,0 +1 @@
+data: {"type":"response.reasoning_text.done","content_index":0,"item_id":"item_123","output_index":0,"sequence_number":10,"text":"Let me analyze this problem step by step to provide the best solution."}

tests/Responses/Responses/CreateStreamedResponse.php

@@ -2,6 +2,8 @@
 
 use OpenAI\Responses\Responses\CreateResponse;
 use OpenAI\Responses\Responses\CreateStreamedResponse;
+use OpenAI\Responses\Responses\Streaming\ReasoningTextDelta;
+use OpenAI\Responses\Responses\Streaming\ReasoningTextDone;
 
 test('fake', function () {
     $response = CreateStreamedResponse::fake();
@@ -20,3 +22,31 @@
         ->response->toBeInstanceOf(CreateResponse::class)
         ->response->id->toBe('resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c');
 });
+
+test('reasoning text delta event', function () {
+    $response = CreateStreamedResponse::fake(responseReasoningTextDeltaEvent());
+
+    expect($response->getIterator()->current())
+        ->toBeInstanceOf(CreateStreamedResponse::class)
+        ->event->toBe('response.reasoning_text.delta')
+        ->response->toBeInstanceOf(ReasoningTextDelta::class)
+        ->response->delta->toBe('Let me analyze')
+        ->response->itemId->toBe('item_123')
+        ->response->outputIndex->toBe(0)
+        ->response->contentIndex->toBe(0)
+        ->response->sequenceNumber->toBe(5);
+});
+
+test('reasoning text done event', function () {
+    $response = CreateStreamedResponse::fake(responseReasoningTextDoneEvent());
+
+    expect($response->getIterator()->current())
+        ->toBeInstanceOf(CreateStreamedResponse::class)
+        ->event->toBe('response.reasoning_text.done')
+        ->response->toBeInstanceOf(ReasoningTextDone::class)
+        ->response->text->toBe('Let me analyze this problem step by step to provide the best solution.')
+        ->response->itemId->toBe('item_123')
+        ->response->outputIndex->toBe(0)
+        ->response->contentIndex->toBe(0)
+        ->response->sequenceNumber->toBe(10);
+});