openai 6.33.0 → 6.35.0

package/src/resources/responses/ws.ts

@@ -1,201 +1,38 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as WS from 'ws';
-import { ResponsesEmitter, ResponsesStreamMessage, WebSocketError, buildURL } from './internal-base';
-import * as ResponsesAPI from './responses';
+import { NodeWebSocket } from '../../internal/ws-adapter-node';
+import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../client';
 
-export class ResponsesWS extends ResponsesEmitter {
-  url: URL;
-  socket: WS.WebSocket;
-  private client: OpenAI;
+export type { ResponsesWSReconnectOptions } from './ws-base';
 
-  constructor(client: OpenAI, options?: WS.ClientOptions | null | undefined) {
-    super();
-    this.client = client;
-    this.url = buildURL(client, {});
-    this.socket = new WS.WebSocket(this.url, {
-      ...options,
-      headers: {
-        ...this.authHeaders(),
-        ...options?.headers,
-      },
-    });
-
-    this.socket.on('message', (wsEvent) => {
-      const event = (() => {
-        try {
-          return JSON.parse(wsEvent.toString()) as ResponsesAPI.ResponsesServerEvent;
-        } catch (err) {
-          this._onError(null, 'could not parse websocket event', err);
-          return null;
-        }
-      })();
-
-      if (event) {
-        this._emit('event', event);
-
-        if (event.type === 'error') {
-          this._onError(event);
-        } else {
-          // @ts-ignore TS isn't smart enough to get the relationship right here
-          this._emit(event.type, event);
-        }
-      }
-    });
-
-    this.socket.on('error', (err) => {
-      this._onError(null, err.message, err);
-    });
-  }
+export interface ResponsesWSClientOptions extends WS.ClientOptions, ResponsesWSBaseOptions {}
 
-  send(event: ResponsesAPI.ResponsesClientEvent) {
-    try {
-      this.socket.send(JSON.stringify(event));
-    } catch (err) {
-      this._onError(null, 'could not send data', err);
-    }
-  }
+export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
+  private _wsOptions: WS.ClientOptions | null | undefined;
 
-  close(props?: { code: number; reason: string }) {
-    try {
-      this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');
-    } catch (err) {
-      this._onError(null, 'could not close the connection', err);
+  constructor(client: OpenAI, options?: ResponsesWSClientOptions | null | undefined) {
+    if (!WS?.WebSocket) {
+      throw new Error(
+        'ResponsesWS from "openai/resources/responses/ws" requires the "ws" package but it could not be loaded.',
+      );
     }
-  }
 
-  /**
-   * Returns an async iterator over WebSocket lifecycle and message events,
-   * providing an alternative to the event-based `.on()` API.
-   * The iterator will exit if the socket closes but breaking out of the iterator
-   * does not close the socket.
-   *
-   * @example
-   * ```ts
-   * for await (const event of connection.stream()) {
-   *   switch (event.type) {
-   *     case 'message':
-   *       console.log('received:', event.message);
-   *       break;
-   *     case 'error':
-   *       console.error(event.error);
-   *       break;
-   *     case 'close':
-   *       console.log('connection closed');
-   *       break;
-   *   }
-   * }
-   * ```
-   */
-  stream(): AsyncIterableIterator<ResponsesStreamMessage> {
-    return this[Symbol.asyncIterator]();
+    const { reconnect, maxQueueSize, ...wsOptions } = options ?? {};
+    super(client, { reconnect, maxQueueSize });
+    this._wsOptions = wsOptions;
+    this._connectInitial();
   }
 
-  [Symbol.asyncIterator](): AsyncIterableIterator<ResponsesStreamMessage> {
-    // Two-queue async iterator: `queue` buffers incoming messages,
-    // `resolvers` buffers waiting next() calls. A push wakes the
-    // oldest next(); a next() drains the oldest message.
-    const queue: ResponsesStreamMessage[] = [];
-    const resolvers: (() => void)[] = [];
-    let done = false;
-
-    const push = (msg: ResponsesStreamMessage) => {
-      queue.push(msg);
-      resolvers.shift()?.();
-    };
-
-    const onEvent = (event: ResponsesAPI.ResponsesServerEvent) => {
-      if (event.type === 'error') return; // handled by onEmitterError
-      push({ type: 'message', message: event });
-    };
-
-    // Catches both API-level and socket-level errors via _onError → _emit('error')
-    const onEmitterError = (err: WebSocketError) => {
-      push({ type: 'error', error: err });
-    };
-
-    const onOpen = () => {
-      push({ type: 'open' });
-    };
-
-    const flushResolvers = () => {
-      for (let resolver = resolvers.shift(); resolver; resolver = resolvers.shift()) {
-        resolver();
-      }
-    };
-
-    const onClose = () => {
-      push({ type: 'close' });
-      done = true;
-      flushResolvers();
-      cleanup();
-    };
-
-    const cleanup = () => {
-      this.off('event', onEvent);
-      this.off('error', onEmitterError);
-      this.socket.off('open', onOpen);
-      this.socket.off('close', onClose);
-    };
-
-    this.on('event', onEvent);
-    this.on('error', onEmitterError);
-    this.socket.on('open', onOpen);
-    this.socket.on('close', onClose);
-
-    switch (this.socket.readyState) {
-      case WS.WebSocket.CONNECTING:
-        push({ type: 'connecting' });
-        break;
-      case WS.WebSocket.OPEN:
-        push({ type: 'open' });
-        break;
-      case WS.WebSocket.CLOSING:
-        push({ type: 'closing' });
-        break;
-      case WS.WebSocket.CLOSED:
-        push({ type: 'close' });
-        done = true;
-        cleanup();
-        break;
-    }
-
-    const resolve = (res: (value: IteratorResult<ResponsesStreamMessage>) => void) => {
-      if (queue.length > 0) {
-        res({ value: queue.shift()!, done: false });
-      } else if (done) {
-        res({ value: undefined, done: true });
-      } else {
-        return false;
-      }
-      return true;
-    };
-
-    const next = (): Promise<IteratorResult<ResponsesStreamMessage>> =>
-      new Promise((res) => {
-        if (resolve(res)) return;
-        resolvers.push(() => {
-          resolve(res);
-        });
-      });
-
-    return {
-      next,
-      return: (): Promise<IteratorReturnResult<undefined>> => {
-        done = true;
-        cleanup();
-        flushResolvers();
-        return Promise.resolve({ value: undefined, done: true });
-      },
-      [Symbol.asyncIterator]() {
-        return this;
+  protected _createSocket(url: URL, authHeaders: Record<string, string>): NodeWebSocket {
+    const ws = new WS.WebSocket(url, {
+      ...this._wsOptions,
+      headers: {
+        ...authHeaders,
+        ...this._wsOptions?.headers,
       },
-    };
-  }
-
-  private authHeaders(): Record<string, string> {
-    return { Authorization: `Bearer ${this.client.apiKey}` };
-    return {};
+    });
+    return new NodeWebSocket(ws);
   }
 }

package/src/resources/shared.ts

@@ -248,6 +248,8 @@ export type FunctionParameters = { [key: string]: unknown };
  */
 export type Metadata = { [key: string]: string };
 
+export type OAuthErrorCode = 'invalid_grant' | 'invalid_subject_token' | (string & {});
+
 /**
  * **gpt-5 and o-series models only**
  *

package/src/resources/vector-stores/file-batches.ts

@@ -274,8 +274,9 @@ export interface FileBatchCreateParams {
    * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
    * the vector store should use. Useful for tools like `file_search` that can access
    * files. If `attributes` or `chunking_strategy` are provided, they will be applied
-   * to all files in the batch. The maximum batch size is 2000 files. Mutually
-   * exclusive with `files`.
+   * to all files in the batch. The maximum batch size is 2000 files. This endpoint
+   * is recommended for multi-file ingestion and helps reduce per-vector-store write
+   * request pressure. Mutually exclusive with `files`.
    */
   file_ids?: Array<string>;
 
@@ -283,8 +284,9 @@ export interface FileBatchCreateParams {
    * A list of objects that each include a `file_id` plus optional `attributes` or
    * `chunking_strategy`. Use this when you need to override metadata for specific
    * files. The global `attributes` or `chunking_strategy` will be ignored and must
-   * be specified for each file. The maximum batch size is 2000 files. Mutually
-   * exclusive with `file_ids`.
+   * be specified for each file. The maximum batch size is 2000 files. This endpoint
+   * is recommended for multi-file ingestion and helps reduce per-vector-store write
+   * request pressure. Mutually exclusive with `file_ids`.
    */
   files?: Array<FileBatchCreateParams.File>;
 }
@@ -294,7 +296,9 @@ export namespace FileBatchCreateParams {
     /**
      * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
      * vector store should use. Useful for tools like `file_search` that can access
-     * files.
+     * files. For multi-file ingestion, we recommend
+     * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+     * to minimize per-vector-store write requests.
      */
     file_id: string;
 

package/src/resources/vector-stores/files.ts

@@ -299,7 +299,9 @@ export interface FileCreateParams {
   /**
    * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
    * vector store should use. Useful for tools like `file_search` that can access
-   * files.
+   * files. For multi-file ingestion, we recommend
+   * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+   * to minimize per-vector-store write requests.
    */
   file_id: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.33.0'; // x-release-please-version
+export const VERSION = '6.35.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.33.0";
+export declare const VERSION = "6.35.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.33.0";
+export declare const VERSION = "6.35.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.33.0'; // x-release-please-version
+exports.VERSION = '6.35.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.33.0'; // x-release-please-version
+export const VERSION = '6.35.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map