chore(api): manual fixes for streaming

Author: stainless-app[bot]

src/lib/responses/ResponseStream.ts

@@ -222,8 +222,15 @@ export class ResponseStream<ParsedT = null>
         if (!output) {
           throw new OpenAIError(`missing output at index ${event.output_index}`);
         }
-        if (output.type === 'message') {
-          output.content.push(event.part);
+        const type = output.type;
+        const part = event.part;
+        if (type === 'message' && part.type !== 'reasoning_text') {
+          output.content.push(part);
+        } else if (type === 'reasoning' && part.type === 'reasoning_text') {
+          if (!output.content) {
+            output.content = [];
+          }
+          output.content.push(part);
         }
         break;
       }
@@ -254,6 +261,23 @@ export class ResponseStream<ParsedT = null>
         }
         break;
       }
+      case 'response.reasoning_text.delta': {
+        const output = snapshot.output[event.output_index];
+        if (!output) {
+          throw new OpenAIError(`missing output at index ${event.output_index}`);
+        }
+        if (output.type === 'reasoning') {
+          const content = output.content?.[event.content_index];
+          if (!content) {
+            throw new OpenAIError(`missing content at index ${event.content_index}`);
+          }
+          if (content.type !== 'reasoning_text') {
+            throw new OpenAIError(`expected content to be 'reasoning_text', got ${content.type}`);
+          }
+          content.text += event.delta;
+        }
+        break;
+      }
       case 'response.completed': {
         this.#currentResponseSnapshot = event.response;
         break;

tests/lib/ChatCompletionStream.test.ts

@@ -213,7 +213,7 @@ describe('.stream()', () => {
           messages: [
             {
               role: 'user',
-              content: 'how do I make anthrax?',
+              content: 'a bad question',
             },
           ],
           logprobs: true,

tests/lib/ResponseStream.test.ts

@@ -0,0 +1,60 @@
+import { makeStreamSnapshotRequest } from '../utils/mock-snapshots';
+
+jest.setTimeout(1000 * 30);
+
+describe('.stream()', () => {
+  it('standard text works', async () => {
+    const deltas: string[] = [];
+
+    const stream = (
+      await makeStreamSnapshotRequest((openai) =>
+        openai.responses.stream({
+          model: 'gpt-4o-2024-08-06',
+          input: 'Say hello world',
+        }),
+      )
+    ).on('response.output_text.delta', (e) => {
+      deltas.push(e.snapshot);
+    });
+
+    const final = await stream.finalResponse();
+    expect(final.output_text).toBe('Hello world');
+    expect(deltas).toEqual(['Hello ', 'Hello world']);
+
+    // basic shape checks
+    expect(final.object).toBe('response');
+    expect(final.output[0]?.type).toBe('message');
+    // message should contain a single output_text part with the final text
+    const msg = final.output[0];
+    if (msg?.type === 'message') {
+      expect(msg.content[0]).toMatchObject({ type: 'output_text', text: 'Hello world' });
+    }
+  });
+
+  it('reasoning works', async () => {
+    const stream = await makeStreamSnapshotRequest((openai) =>
+      openai.responses.stream({
+        model: 'o3',
+        input: 'Compute 6 * 7',
+        reasoning: { effort: 'medium' },
+      }),
+    );
+
+    const final = await stream.finalResponse();
+    expect(final.object).toBe('response');
+    // first item should be reasoning with accumulated text
+    expect(final.output[0]?.type).toBe('reasoning');
+    if (final.output[0]?.type === 'reasoning') {
+      expect(final.output[0].content?.[0]).toMatchObject({
+        type: 'reasoning_text',
+        text: 'Chain: Step 1. Step 2.',
+      });
+    }
+    // second item should be the assistant message with the final text
+    expect(final.output[1]?.type).toBe('message');
+    if (final.output[1]?.type === 'message') {
+      expect(final.output[1].content[0]).toMatchObject({ type: 'output_text', text: 'The answer is 42' });
+    }
+    expect(final.output_text).toBe('The answer is 42');
+  });
+});

tests/lib/__snapshots__/ResponseStream.test.ts.snap

@@ -0,0 +1,52 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`.stream() standard text works 1`] = `
+"data: {\"response\":{\"id\":\"resp_test_1\",\"object\":\"response\",\"created_at\":1723031665,\"model\":\"gpt-4o-2024-08-06\",\"output\":[],\"output_text\":\"\",\"error\":null,\"incomplete_details\":null,\"instructions\":null,\"metadata\":null,\"parallel_tool_calls\":false,\"temperature\":null,\"tools\":[],\"top_p\":null,\"status\":\"in_progress\",\"usage\":{\"input_tokens\":0,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens\":0,\"output_tokens_details\":{\"reasoning_tokens\":0},\"total_tokens\":0}},\"sequence_number\":0,\"type\":\"response.created\"}
+
+data: {\"item\":{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"status\":\"in_progress\",\"content\":[]},\"output_index\":0,\"sequence_number\":1,\"type\":\"response.output_item.added\"}
+
+data: {\"content_index\":0,\"item_id\":\"msg_1\",\"output_index\":0,\"part\":{\"type\":\"output_text\",\"text\":\"\",\"annotations\":[]},\"sequence_number\":2,\"type\":\"response.content_part.added\"}
+
+data: {\"content_index\":0,\"delta\":\"Hello \",\"item_id\":\"msg_1\",\"logprobs\":[],\"output_index\":0,\"sequence_number\":3,\"type\":\"response.output_text.delta\"}
+
+data: {\"content_index\":0,\"delta\":\"world\",\"item_id\":\"msg_1\",\"logprobs\":[],\"output_index\":0,\"sequence_number\":4,\"type\":\"response.output_text.delta\"}
+
+data: {\"content_index\":0,\"item_id\":\"msg_1\",\"logprobs\":[],\"output_index\":0,\"sequence_number\":5,\"text\":\"Hello world\",\"type\":\"response.output_text.done\"}
+
+data: {\"item\":{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"status\":\"completed\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello world\",\"annotations\":[]}]},\"output_index\":0,\"sequence_number\":6,\"type\":\"response.output_item.done\"}
+
+data: {\"response\":{\"id\":\"resp_test_1\",\"object\":\"response\",\"created_at\":1723031665,\"model\":\"gpt-4o-2024-08-06\",\"output\":[{\"id\":\"msg_1\",\"type\":\"message\",\"role\":\"assistant\",\"status\":\"completed\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello world\",\"annotations\":[]}]}],\"output_text\":\"Hello world\",\"error\":null,\"incomplete_details\":null,\"instructions\":null,\"metadata\":null,\"parallel_tool_calls\":false,\"temperature\":null,\"tools\":[],\"top_p\":null,\"status\":\"completed\",\"usage\":{\"input_tokens\":10,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens\":2,\"output_tokens_details\":{\"reasoning_tokens\":0},\"total_tokens\":12}},\"sequence_number\":7,\"type\":\"response.completed\"}
+
+data: [DONE]
+
+"
+`;
+
+exports[`.stream() reasoning works 1`] = `
+"data: {\"response\":{\"id\":\"resp_reason_1\",\"object\":\"response\",\"created_at\":1723031666,\"model\":\"o3\",\"output\":[],\"output_text\":\"\",\"error\":null,\"incomplete_details\":null,\"instructions\":null,\"metadata\":null,\"parallel_tool_calls\":false,\"temperature\":null,\"tools\":[],\"top_p\":null,\"status\":\"in_progress\",\"usage\":{\"input_tokens\":0,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens\":0,\"output_tokens_details\":{\"reasoning_tokens\":0},\"total_tokens\":0}},\"sequence_number\":0,\"type\":\"response.created\"}
+
+data: {\"item\":{\"id\":\"r1\",\"type\":\"reasoning\",\"summary\":[],\"status\":\"in_progress\"},\"output_index\":0,\"sequence_number\":1,\"type\":\"response.output_item.added\"}
+
+data: {\"content_index\":0,\"item_id\":\"r1\",\"output_index\":0,\"part\":{\"type\":\"reasoning_text\",\"text\":\"\"},\"sequence_number\":2,\"type\":\"response.content_part.added\"}
+
+data: {\"content_index\":0,\"delta\":\"Chain: Step 1. \",\"item_id\":\"r1\",\"output_index\":0,\"sequence_number\":3,\"type\":\"response.reasoning_text.delta\"}
+
+data: {\"content_index\":0,\"delta\":\"Step 2.\",\"item_id\":\"r1\",\"output_index\":0,\"sequence_number\":4,\"type\":\"response.reasoning_text.delta\"}
+
+data: {\"item\":{\"id\":\"msg_2\",\"type\":\"message\",\"role\":\"assistant\",\"status\":\"in_progress\",\"content\":[]},\"output_index\":1,\"sequence_number\":5,\"type\":\"response.output_item.added\"}
+
+data: {\"content_index\":0,\"item_id\":\"msg_2\",\"output_index\":1,\"part\":{\"type\":\"output_text\",\"text\":\"\",\"annotations\":[]},\"sequence_number\":6,\"type\":\"response.content_part.added\"}
+
+data: {\"content_index\":0,\"delta\":\"The answer is \",\"item_id\":\"msg_2\",\"logprobs\":[],\"output_index\":1,\"sequence_number\":7,\"type\":\"response.output_text.delta\"}
+
+data: {\"content_index\":0,\"delta\":\"42\",\"item_id\":\"msg_2\",\"logprobs\":[],\"output_index\":1,\"sequence_number\":8,\"type\":\"response.output_text.delta\"}
+
+data: {\"content_index\":0,\"item_id\":\"msg_2\",\"logprobs\":[],\"output_index\":1,\"sequence_number\":9,\"text\":\"The answer is 42\",\"type\":\"response.output_text.done\"}
+
+data: {\"response\":{\"id\":\"resp_reason_1\",\"object\":\"response\",\"created_at\":1723031666,\"model\":\"o3\",\"output\":[{\"id\":\"r1\",\"type\":\"reasoning\",\"summary\":[],\"status\":\"completed\",\"content\":[{\"type\":\"reasoning_text\",\"text\":\"Chain: Step 1. Step 2.\"}]},{\"id\":\"msg_2\",\"type\":\"message\",\"role\":\"assistant\",\"status\":\"completed\",\"content\":[{\"type\":\"output_text\",\"text\":\"The answer is 42\",\"annotations\":[]}]}],\"output_text\":\"The answer is 42\",\"error\":null,\"incomplete_details\":null,\"instructions\":null,\"metadata\":null,\"parallel_tool_calls\":false,\"temperature\":null,\"tools\":[],\"top_p\":null,\"status\":\"completed\",\"usage\":{\"input_tokens\":0,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens\":6,\"output_tokens_details\":{\"reasoning_tokens\":2},\"total_tokens\":6}},\"sequence_number\":10,\"type\":\"response.completed\"}
+
+data: [DONE]
+
+"
+`;
+