Merge pull request #1506 from openai/release-please--branches--master--changes--next--components--openai

release: 4.103.0

Author: kwhinnery-openai

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.102.0"
+  ".": "4.103.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-6af14840a810139bf407013167ce1c8fb21b6ef8eb0cc3db58b51af7d52c4b5a.yml
-openapi_spec_hash: 3241bde6b273cfec0035e522bd07985d
-config_hash: 7367b68a4e7db36885c1a886f57b17f6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fc64d7c2c8f51f750813375356c3f3fdfc7fc1b1b34f19c20a5410279d445d37.yml
+openapi_spec_hash: 618285fc70199ee32b9ebe4bf72f7e4c
+config_hash: c497f6b750cc89c0bf2eefc0bc839c70

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.103.0 (2025-05-22)
+
+Full Changelog: [v4.102.0...v4.103.0](https://github.com/openai/openai-node/compare/v4.102.0...v4.103.0)
+
+### Features
+
+* **api:** new streaming helpers for background responses ([1ddd6ff](https://github.com/openai/openai-node/commit/1ddd6ff182b09d696954fda4bde50fb82f1d6585))
+
 ## 4.102.0 (2025-05-21)
 
 Full Changelog: [v4.101.0...v4.102.0](https://github.com/openai/openai-node/compare/v4.101.0...v4.102.0)

api.md

@@ -692,7 +692,6 @@ Types:
 - <code><a href="./src/resources/responses/responses.ts">ResponseRefusalDoneEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseStatus</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseStreamEvent</a></code>
-- <code><a href="./src/resources/responses/responses.ts">ResponseTextAnnotationDeltaEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseTextConfig</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseTextDeltaEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseTextDoneEvent</a></code>

examples/responses/stream_background.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import OpenAI from 'openai';
+
+const openai = new OpenAI();
+
+async function main() {
+  const runner = openai.responses.stream({
+    model: 'gpt-4o-2024-08-06',
+    input: 'solve 8x + 31 = 2',
+    background: true,
+  });
+
+  let id: string | null = null;
+
+  for await (const event of runner) {
+    if (event.type == 'response.created') {
+      id = event.response.id;
+    }
+
+    console.log('event', event);
+    if (event.sequence_number == 10) {
+      break;
+    }
+  }
+
+  console.log('Interrupted. Continuing...');
+
+  const runner2 = openai.responses.stream({
+    response_id: id!,
+    starting_after: 10,
+  });
+
+  for await (const event of runner2) {
+    console.log('event', event);
+  }
+
+  const result = await runner2.finalResponse();
+  console.log(result);
+}
+
+main();

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@openai/openai",
-  "version": "4.102.0",
+  "version": "4.103.0",
   "exports": {
     ".": "./index.ts",
     "./helpers/zod": "./helpers/zod.ts",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.102.0",
+  "version": "4.103.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/lib/ResponsesParser.ts

@@ -1,6 +1,7 @@
 import { OpenAIError } from '../error';
 import type { ChatCompletionTool } from '../resources/chat/completions';
 import {
+  ResponseTextConfig,
   type FunctionTool,
   type ParsedContent,
   type ParsedResponse,
@@ -20,7 +21,9 @@ export type ResponseCreateParamsWithTools = ResponseCreateParamsBase & {
   tools?: ParseableToolsParams;
 };
 
-export type ExtractParsedContentFromParams<Params extends ResponseCreateParamsWithTools> =
+type TextConfigParams = { text?: ResponseTextConfig };
+
+export type ExtractParsedContentFromParams<Params extends TextConfigParams> =
   NonNullable<Params['text']>['format'] extends AutoParseableTextFormat<infer P> ? P : null;
 
 export function maybeParseResponse<

src/lib/responses/EventTypes.ts

@@ -24,7 +24,6 @@ import {
   ResponseOutputItemDoneEvent,
   ResponseRefusalDeltaEvent,
   ResponseRefusalDoneEvent,
-  ResponseTextAnnotationDeltaEvent,
   ResponseTextDeltaEvent as RawResponseTextDeltaEvent,
   ResponseTextDoneEvent,
   ResponseIncompleteEvent,
@@ -68,7 +67,6 @@ export type ParsedResponseStreamEvent =
   | ResponseOutputItemDoneEvent
   | ResponseRefusalDeltaEvent
   | ResponseRefusalDoneEvent
-  | ResponseTextAnnotationDeltaEvent
   | ResponseTextDeltaEvent
   | ResponseTextDoneEvent
   | ResponseWebSearchCallCompletedEvent

src/lib/responses/ResponseStream.ts

@@ -1,4 +1,5 @@
 import {
+  ResponseTextConfig,
   type ParsedResponse,
   type Response,
   type ResponseCreateParamsBase,
@@ -10,12 +11,40 @@ import { APIUserAbortError, OpenAIError } from '../../error';
 import OpenAI from '../../index';
 import { type BaseEvents, EventStream } from '../EventStream';
 import { type ResponseFunctionCallArgumentsDeltaEvent, type ResponseTextDeltaEvent } from './EventTypes';
-import { maybeParseResponse } from '../ResponsesParser';
+import { maybeParseResponse, ParseableToolsParams } from '../ResponsesParser';
+import { Stream } from 'openai/streaming';
 
-export type ResponseStreamParams = Omit<ResponseCreateParamsBase, 'stream'> & {
+export type ResponseStreamParams = ResponseCreateAndStreamParams | ResponseStreamByIdParams;
+
+export type ResponseCreateAndStreamParams = Omit<ResponseCreateParamsBase, 'stream'> & {
   stream?: true;
 };
 
+export type ResponseStreamByIdParams = {
+  /**
+   * The ID of the response to stream.
+   */
+  response_id: string;
+  /**
+   * If provided, the stream will start after the event with the given sequence number.
+   */
+  starting_after?: number;
+  /**
+   * Configuration options for a text response from the model. Can be plain text or
+   * structured JSON data. Learn more:
+   *
+   * - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+   * - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+   */
+  text?: ResponseTextConfig;
+
+  /**
+   * An array of tools the model may call while generating a response. When continuing a stream, provide
+   * the same tools as the original request.
+   */
+  tools?: ParseableToolsParams;
+};
+
 type ResponseEvents = BaseEvents &
   Omit<
     {
@@ -52,7 +81,7 @@ export class ResponseStream<ParsedT = null>
   ): ResponseStream<ParsedT> {
     const runner = new ResponseStream<ParsedT>(params as ResponseCreateParamsStreaming);
     runner._run(() =>
-      runner._createResponse(client, params, {
+      runner._createOrRetrieveResponse(client, params, {
         ...options,
         headers: { ...options?.headers, 'X-Stainless-Helper-Method': 'stream' },
       }),
@@ -65,11 +94,17 @@ export class ResponseStream<ParsedT = null>
     this.#currentResponseSnapshot = undefined;
   }
 
-  #addEvent(this: ResponseStream<ParsedT>, event: ResponseStreamEvent) {
+  #addEvent(this: ResponseStream<ParsedT>, event: ResponseStreamEvent, starting_after: number | null) {
     if (this.ended) return;
 
+    const maybeEmit = (name: string, event: ResponseStreamEvent & { snapshot?: string }) => {
+      if (starting_after == null || event.sequence_number > starting_after) {
+        this._emit(name as any, event);
+      }
+    };
+
     const response = this.#accumulateResponse(event);
-    this._emit('event', event);
+    maybeEmit('event', event);
 
     switch (event.type) {
       case 'response.output_text.delta': {
@@ -86,7 +121,7 @@ export class ResponseStream<ParsedT = null>
             throw new OpenAIError(`expected content to be 'output_text', got ${content.type}`);
           }
 
-          this._emit('response.output_text.delta', {
+          maybeEmit('response.output_text.delta', {
             ...event,
             snapshot: content.text,
           });
@@ -99,16 +134,15 @@ export class ResponseStream<ParsedT = null>
           throw new OpenAIError(`missing output at index ${event.output_index}`);
         }
         if (output.type === 'function_call') {
-          this._emit('response.function_call_arguments.delta', {
+          maybeEmit('response.function_call_arguments.delta', {
             ...event,
             snapshot: output.arguments,
           });
         }
         break;
       }
       default:
-        // @ts-ignore
-        this._emit(event.type, event);
+        maybeEmit(event.type, event);
         break;
     }
   }
@@ -128,9 +162,9 @@ export class ResponseStream<ParsedT = null>
     return parsedResponse;
   }
 
-  protected async _createResponse(
+  protected async _createOrRetrieveResponse(
     client: OpenAI,
-    params: ResponseStreamingParams,
+    params: ResponseStreamParams,
     options?: Core.RequestOptions,
   ): Promise<ParsedResponse<ParsedT>> {
     const signal = options?.signal;
@@ -140,13 +174,25 @@ export class ResponseStream<ParsedT = null>
     }
     this.#beginRequest();
 
-    const stream = await client.responses.create(
-      { ...params, stream: true },
-      { ...options, signal: this.controller.signal },
-    );
+    let stream: Stream<ResponseStreamEvent> | undefined;
+    let starting_after: number | null = null;
+    if ('response_id' in params) {
+      stream = await client.responses.retrieve(
+        params.response_id,
+        { stream: true },
+        { ...options, signal: this.controller.signal, stream: true },
+      );
+      starting_after = params.starting_after ?? null;
+    } else {
+      stream = await client.responses.create(
+        { ...params, stream: true },
+        { ...options, signal: this.controller.signal },
+      );
+    }
+
     this._connected();
     for await (const event of stream) {
-      this.#addEvent(event);
+      this.#addEvent(event, starting_after);
     }
     if (stream.controller.signal?.aborted) {
       throw new APIUserAbortError();