openai 4.53.2 → 4.54.0

package/src/lib/{AbstractAssistantStreamRunner.ts → EventStream.ts}

@@ -1,12 +1,6 @@
-import * as Core from "../core";
 import { APIUserAbortError, OpenAIError } from "../error";
-import { Run, RunSubmitToolOutputsParamsBase } from "../resources/beta/threads/runs/runs";
-import { RunCreateParamsBase, Runs } from "../resources/beta/threads/runs/runs";
-import { ThreadCreateAndRunParamsBase, Threads } from "../resources/beta/threads/threads";
 
-export abstract class AbstractAssistantStreamRunner<
-  Events extends CustomEvents<any> = AbstractAssistantRunnerEvents,
-> {
+export class EventStream<EventTypes extends BaseEvents> {
   controller: AbortController = new AbortController();
 
   #connectedPromise: Promise<void>;
@@ -17,7 +11,9 @@ export abstract class AbstractAssistantStreamRunner<
   #resolveEndPromise: () => void = () => {};
   #rejectEndPromise: (error: OpenAIError) => void = () => {};
 
-  #listeners: { [Event in keyof Events]?: ListenersForEvent<Events, Event> } = {};
+  #listeners: {
+    [Event in keyof EventTypes]?: EventListeners<EventTypes, Event>;
+  } = {};
 
   #ended = false;
   #errored = false;
@@ -43,22 +39,18 @@ export abstract class AbstractAssistantStreamRunner<
     this.#endPromise.catch(() => {});
   }
 
-  protected _run(executor: () => Promise<any>) {
+  protected _run(this: EventStream<EventTypes>, executor: () => Promise<any>) {
     // Unfortunately if we call `executor()` immediately we get runtime errors about
     // references to `this` before the `super()` constructor call returns.
     setTimeout(() => {
       executor().then(() => {
-        // this._emitFinal();
+        this._emitFinal();
         this._emit('end');
-      }, this.#handleError);
+      }, this.#handleError.bind(this));
     }, 0);
   }
 
-  protected _addRun(run: Run): Run {
-    return run;
-  }
-
-  protected _connected() {
+  protected _connected(this: EventStream<EventTypes>) {
     if (this.ended) return;
     this.#resolveConnectedPromise();
     this._emit('connect');
@@ -87,8 +79,8 @@ export abstract class AbstractAssistantStreamRunner<
    * called, multiple times.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  on<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
+  on<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
+    const listeners: EventListeners<EventTypes, Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener });
     return this;
@@ -101,7 +93,7 @@ export abstract class AbstractAssistantStreamRunner<
    * off() must be called multiple times to remove each instance.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  off<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
+  off<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
     const listeners = this.#listeners[event];
     if (!listeners) return this;
     const index = listeners.findIndex((l) => l.listener === listener);
@@ -114,8 +106,8 @@ export abstract class AbstractAssistantStreamRunner<
    * this listener is removed and then invoked.
    * @returns this ChatCompletionStream, so that calls can be chained
    */
-  once<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this {
-    const listeners: ListenersForEvent<Events, Event> =
+  once<Event extends keyof EventTypes>(event: Event, listener: EventListener<EventTypes, Event>): this {
+    const listeners: EventListeners<EventTypes, Event> =
       this.#listeners[event] || (this.#listeners[event] = []);
     listeners.push({ listener, once: true });
     return this;
@@ -132,12 +124,12 @@ export abstract class AbstractAssistantStreamRunner<
    *
    *   const message = await stream.emitted('message') // rejects if the stream errors
    */
-  emitted<Event extends keyof Events>(
+  emitted<Event extends keyof EventTypes>(
     event: Event,
   ): Promise<
-    EventParameters<Events, Event> extends [infer Param] ? Param
-    : EventParameters<Events, Event> extends [] ? void
-    : EventParameters<Events, Event>
+    EventParameters<EventTypes, Event> extends [infer Param] ? Param
+    : EventParameters<EventTypes, Event> extends [] ? void
+    : EventParameters<EventTypes, Event>
   > {
     return new Promise((resolve, reject) => {
       this.#catchingPromiseCreated = true;
@@ -151,7 +143,7 @@ export abstract class AbstractAssistantStreamRunner<
     await this.#endPromise;
   }
 
-  #handleError = (error: unknown) => {
+  #handleError(this: EventStream<EventTypes>, error: unknown) {
     this.#errored = true;
     if (error instanceof Error && error.name === 'AbortError') {
       error = new APIUserAbortError();
@@ -170,9 +162,15 @@ export abstract class AbstractAssistantStreamRunner<
       return this._emit('error', openAIError);
     }
     return this._emit('error', new OpenAIError(String(error)));
-  };
+  }
 
-  protected _emit<Event extends keyof Events>(event: Event, ...args: EventParameters<Events, Event>) {
+  _emit<Event extends keyof BaseEvents>(event: Event, ...args: EventParameters<BaseEvents, Event>): void;
+  _emit<Event extends keyof EventTypes>(event: Event, ...args: EventParameters<EventTypes, Event>): void;
+  _emit<Event extends keyof EventTypes>(
+    this: EventStream<EventTypes>,
+    event: Event,
+    ...args: EventParameters<EventTypes, Event>
+  ) {
     // make sure we don't emit any events after end
     if (this.#ended) {
       return;
@@ -183,10 +181,10 @@ export abstract class AbstractAssistantStreamRunner<
       this.#resolveEndPromise();
     }
 
-    const listeners: ListenersForEvent<Events, Event> | undefined = this.#listeners[event];
+    const listeners: EventListeners<EventTypes, Event> | undefined = this.#listeners[event];
     if (listeners) {
       this.#listeners[event] = listeners.filter((l) => !l.once) as any;
-      listeners.forEach(({ listener }: any) => listener(...args));
+      listeners.forEach(({ listener }: any) => listener(...(args as any)));
     }
 
     if (event === 'abort') {
@@ -219,121 +217,22 @@ export abstract class AbstractAssistantStreamRunner<
     }
   }
 
-  protected async _threadAssistantStream(
-    body: ThreadCreateAndRunParamsBase,
-    thread: Threads,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createThreadAssistantStream(thread, body, options);
-  }
-
-  protected async _runAssistantStream(
-    threadId: string,
-    runs: Runs,
-    params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createAssistantStream(runs, threadId, params, options);
-  }
-
-  protected async _runToolAssistantStream(
-    threadId: string,
-    runId: string,
-    runs: Runs,
-    params: RunSubmitToolOutputsParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    return await this._createToolAssistantStream(runs, threadId, runId, params, options);
-  }
-
-  protected async _createThreadAssistantStream(
-    thread: Threads,
-    body: ThreadCreateAndRunParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-    // this.#validateParams(params);
-
-    const runResult = await thread.createAndRun(
-      { ...body, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
-
-  protected async _createToolAssistantStream(
-    run: Runs,
-    threadId: string,
-    runId: string,
-    params: RunSubmitToolOutputsParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-
-    const runResult = await run.submitToolOutputs(
-      threadId,
-      runId,
-      { ...params, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
-
-  protected async _createAssistantStream(
-    run: Runs,
-    threadId: string,
-    params: RunCreateParamsBase,
-    options?: Core.RequestOptions,
-  ): Promise<Run> {
-    const signal = options?.signal;
-    if (signal) {
-      if (signal.aborted) this.controller.abort();
-      signal.addEventListener('abort', () => this.controller.abort());
-    }
-    // this.#validateParams(params);
-
-    const runResult = await run.create(
-      threadId,
-      { ...params, stream: false },
-      { ...options, signal: this.controller.signal },
-    );
-    this._connected();
-    return this._addRun(runResult as Run);
-  }
+  protected _emitFinal(): void {}
 }
 
-type CustomEvents<Event extends string> = {
-  [k in Event]: k extends keyof AbstractAssistantRunnerEvents ? AbstractAssistantRunnerEvents[k]
-  : (...args: any[]) => void;
-};
+type EventListener<Events, EventType extends keyof Events> = Events[EventType];
 
-type ListenerForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Event extends (
-  keyof AbstractAssistantRunnerEvents
-) ?
-  AbstractAssistantRunnerEvents[Event]
-: Events[Event];
-
-type ListenersForEvent<Events extends CustomEvents<any>, Event extends keyof Events> = Array<{
-  listener: ListenerForEvent<Events, Event>;
+type EventListeners<Events, EventType extends keyof Events> = Array<{
+  listener: EventListener<Events, EventType>;
   once?: boolean;
 }>;
-type EventParameters<Events extends CustomEvents<any>, Event extends keyof Events> = Parameters<
-  ListenerForEvent<Events, Event>
->;
 
-export interface AbstractAssistantRunnerEvents {
+export type EventParameters<Events, EventType extends keyof Events> = {
+  [Event in EventType]: EventListener<Events, EventType> extends (...args: infer P) => any ? P : never;
+}[EventType];
+
+export interface BaseEvents {
   connect: () => void;
-  run: (run: Run) => void;
   error: (error: OpenAIError) => void;
   abort: (error: APIUserAbortError) => void;
   end: () => void;

package/src/resources/audio/audio.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as AudioAPI from './audio';
 import * as SpeechAPI from './speech';
 import * as TranscriptionsAPI from './transcriptions';
 import * as TranslationsAPI from './translations';
@@ -11,7 +12,10 @@ export class Audio extends APIResource {
   speech: SpeechAPI.Speech = new SpeechAPI.Speech(this._client);
 }
 
+export type AudioModel = 'whisper-1';
+
 export namespace Audio {
+  export import AudioModel = AudioAPI.AudioModel;
   export import Transcriptions = TranscriptionsAPI.Transcriptions;
   export import Transcription = TranscriptionsAPI.Transcription;
   export import TranscriptionCreateParams = TranscriptionsAPI.TranscriptionCreateParams;
@@ -19,5 +23,6 @@ export namespace Audio {
   export import Translation = TranslationsAPI.Translation;
   export import TranslationCreateParams = TranslationsAPI.TranslationCreateParams;
   export import Speech = SpeechAPI.Speech;
+  export import SpeechModel = SpeechAPI.SpeechModel;
   export import SpeechCreateParams = SpeechAPI.SpeechCreateParams;
 }

package/src/resources/audio/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Audio } from './audio';
-export { SpeechCreateParams, Speech } from './speech';
+export { AudioModel, Audio } from './audio';
+export { SpeechModel, SpeechCreateParams, Speech } from './speech';
 export { Transcription, TranscriptionCreateParams, Transcriptions } from './transcriptions';
 export { Translation, TranslationCreateParams, Translations } from './translations';

package/src/resources/audio/speech.ts

@@ -14,6 +14,8 @@ export class Speech extends APIResource {
   }
 }
 
+export type SpeechModel = 'tts-1' | 'tts-1-hd';
+
 export interface SpeechCreateParams {
   /**
    * The text to generate audio for. The maximum length is 4096 characters.
@@ -24,7 +26,7 @@ export interface SpeechCreateParams {
    * One of the available [TTS models](https://platform.openai.com/docs/models/tts):
    * `tts-1` or `tts-1-hd`
    */
-  model: (string & {}) | 'tts-1' | 'tts-1-hd';
+  model: (string & {}) | SpeechModel;
 
   /**
    * The voice to use when generating the audio. Supported voices are `alloy`,
@@ -48,5 +50,6 @@ export interface SpeechCreateParams {
 }
 
 export namespace Speech {
+  export import SpeechModel = SpeechAPI.SpeechModel;
   export import SpeechCreateParams = SpeechAPI.SpeechCreateParams;
 }

package/src/resources/audio/transcriptions.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as TranscriptionsAPI from './transcriptions';
+import * as AudioAPI from './audio';
 
 export class Transcriptions extends APIResource {
   /**
@@ -35,7 +36,7 @@ export interface TranscriptionCreateParams {
    * ID of the model to use. Only `whisper-1` (which is powered by our open source
    * Whisper V2 model) is currently available.
    */
-  model: (string & {}) | 'whisper-1';
+  model: (string & {}) | AudioAPI.AudioModel;
 
   /**
    * The language of the input audio. Supplying the input language in

package/src/resources/audio/translations.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as TranslationsAPI from './translations';
+import * as AudioAPI from './audio';
 
 export class Translations extends APIResource {
   /**
@@ -28,7 +29,7 @@ export interface TranslationCreateParams {
    * ID of the model to use. Only `whisper-1` (which is powered by our open source
    * Whisper V2 model) is currently available.
    */
-  model: (string & {}) | 'whisper-1';
+  model: (string & {}) | AudioAPI.AudioModel;
 
   /**
    * An optional text to guide the model's style or continue a previous audio

package/src/resources/beta/assistants.ts

@@ -5,6 +5,7 @@ import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
 import * as AssistantsAPI from './assistants';
 import * as Shared from '../shared';
+import * as ChatAPI from '../chat/chat';
 import * as MessagesAPI from './threads/messages';
 import * as ThreadsAPI from './threads/threads';
 import * as RunsAPI from './threads/runs/runs';
@@ -1053,30 +1054,7 @@ export interface AssistantCreateParams {
    * [Model overview](https://platform.openai.com/docs/models/overview) for
    * descriptions of them.
    */
-  model:
-    | (string & {})
-    | 'gpt-4o'
-    | 'gpt-4o-2024-05-13'
-    | 'gpt-4o-mini'
-    | 'gpt-4o-mini-2024-07-18'
-    | 'gpt-4-turbo'
-    | 'gpt-4-turbo-2024-04-09'
-    | 'gpt-4-0125-preview'
-    | 'gpt-4-turbo-preview'
-    | 'gpt-4-1106-preview'
-    | 'gpt-4-vision-preview'
-    | 'gpt-4'
-    | 'gpt-4-0314'
-    | 'gpt-4-0613'
-    | 'gpt-4-32k'
-    | 'gpt-4-32k-0314'
-    | 'gpt-4-32k-0613'
-    | 'gpt-3.5-turbo'
-    | 'gpt-3.5-turbo-16k'
-    | 'gpt-3.5-turbo-0613'
-    | 'gpt-3.5-turbo-1106'
-    | 'gpt-3.5-turbo-0125'
-    | 'gpt-3.5-turbo-16k-0613';
+  model: (string & {}) | ChatAPI.ChatModel;
 
   /**
    * The description of the assistant. The maximum length is 512 characters.

package/src/resources/beta/threads/runs/runs.ts

@@ -9,6 +9,7 @@ import { sleep } from '../../../../core';
 import { RunSubmitToolOutputsParamsStream } from '../../../../lib/AssistantStream';
 import * as RunsAPI from './runs';
 import * as AssistantsAPI from '../../assistants';
+import * as ChatAPI from '../../../chat/chat';
 import * as MessagesAPI from '../messages';
 import * as ThreadsAPI from '../threads';
 import * as StepsAPI from './steps';
@@ -668,31 +669,7 @@ export interface RunCreateParamsBase {
    * model associated with the assistant. If not, the model associated with the
    * assistant will be used.
    */
-  model?:
-    | (string & {})
-    | 'gpt-4o'
-    | 'gpt-4o-2024-05-13'
-    | 'gpt-4o-mini'
-    | 'gpt-4o-mini-2024-07-18'
-    | 'gpt-4-turbo'
-    | 'gpt-4-turbo-2024-04-09'
-    | 'gpt-4-0125-preview'
-    | 'gpt-4-turbo-preview'
-    | 'gpt-4-1106-preview'
-    | 'gpt-4-vision-preview'
-    | 'gpt-4'
-    | 'gpt-4-0314'
-    | 'gpt-4-0613'
-    | 'gpt-4-32k'
-    | 'gpt-4-32k-0314'
-    | 'gpt-4-32k-0613'
-    | 'gpt-3.5-turbo'
-    | 'gpt-3.5-turbo-16k'
-    | 'gpt-3.5-turbo-0613'
-    | 'gpt-3.5-turbo-1106'
-    | 'gpt-3.5-turbo-0125'
-    | 'gpt-3.5-turbo-16k-0613'
-    | null;
+  model?: (string & {}) | ChatAPI.ChatModel | null;
 
   /**
    * Whether to enable

package/src/resources/beta/threads/threads.ts

@@ -7,6 +7,7 @@ import { APIPromise } from '../../../core';
 import * as Core from '../../../core';
 import * as ThreadsAPI from './threads';
 import * as AssistantsAPI from '../assistants';
+import * as ChatAPI from '../../chat/chat';
 import * as MessagesAPI from './messages';
 import * as RunsAPI from './runs/runs';
 import { Stream } from '../../../streaming';
@@ -545,31 +546,7 @@ export interface ThreadCreateAndRunParamsBase {
    * model associated with the assistant. If not, the model associated with the
    * assistant will be used.
    */
-  model?:
-    | (string & {})
-    | 'gpt-4o'
-    | 'gpt-4o-2024-05-13'
-    | 'gpt-4o-mini'
-    | 'gpt-4o-mini-2024-07-18'
-    | 'gpt-4-turbo'
-    | 'gpt-4-turbo-2024-04-09'
-    | 'gpt-4-0125-preview'
-    | 'gpt-4-turbo-preview'
-    | 'gpt-4-1106-preview'
-    | 'gpt-4-vision-preview'
-    | 'gpt-4'
-    | 'gpt-4-0314'
-    | 'gpt-4-0613'
-    | 'gpt-4-32k'
-    | 'gpt-4-32k-0314'
-    | 'gpt-4-32k-0613'
-    | 'gpt-3.5-turbo'
-    | 'gpt-3.5-turbo-16k'
-    | 'gpt-3.5-turbo-0613'
-    | 'gpt-3.5-turbo-1106'
-    | 'gpt-3.5-turbo-0125'
-    | 'gpt-3.5-turbo-16k-0613'
-    | null;
+  model?: (string & {}) | ChatAPI.ChatModel | null;
 
   /**
    * Whether to enable

package/src/resources/images.ts

@@ -52,6 +52,8 @@ export interface Image {
   url?: string;
 }
 
+export type ImageModel = 'dall-e-2' | 'dall-e-3';
+
 export interface ImagesResponse {
   created: number;
 
@@ -69,7 +71,7 @@ export interface ImageCreateVariationParams {
    * The model to use for image generation. Only `dall-e-2` is supported at this
    * time.
    */
-  model?: (string & {}) | 'dall-e-2' | null;
+  model?: (string & {}) | ImageModel | null;
 
   /**
    * The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
@@ -122,7 +124,7 @@ export interface ImageEditParams {
    * The model to use for image generation. Only `dall-e-2` is supported at this
    * time.
    */
-  model?: (string & {}) | 'dall-e-2' | null;
+  model?: (string & {}) | ImageModel | null;
 
   /**
    * The number of images to generate. Must be between 1 and 10.
@@ -160,7 +162,7 @@ export interface ImageGenerateParams {
   /**
    * The model to use for image generation.
    */
-  model?: (string & {}) | 'dall-e-2' | 'dall-e-3' | null;
+  model?: (string & {}) | ImageModel | null;
 
   /**
    * The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
@@ -207,6 +209,7 @@ export interface ImageGenerateParams {
 
 export namespace Images {
   export import Image = ImagesAPI.Image;
+  export import ImageModel = ImagesAPI.ImageModel;
   export import ImagesResponse = ImagesAPI.ImagesResponse;
   export import ImageCreateVariationParams = ImagesAPI.ImageCreateVariationParams;
   export import ImageEditParams = ImagesAPI.ImageEditParams;

package/src/resources/index.ts

@@ -2,7 +2,7 @@
 
 export * from './chat/index';
 export * from './shared';
-export { Audio } from './audio/audio';
+export { AudioModel, Audio } from './audio/audio';
 export {
   Batch,
   BatchError,
@@ -35,6 +35,7 @@ export {
 export { FineTuning } from './fine-tuning/fine-tuning';
 export {
   Image,
+  ImageModel,
   ImagesResponse,
   ImageCreateVariationParams,
   ImageEditParams,
@@ -42,5 +43,11 @@ export {
   Images,
 } from './images';
 export { Model, ModelDeleted, ModelsPage, Models } from './models';
-export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations';
+export {
+  Moderation,
+  ModerationModel,
+  ModerationCreateResponse,
+  ModerationCreateParams,
+  Moderations,
+} from './moderations';
 export { Upload, UploadCreateParams, UploadCompleteParams, Uploads } from './uploads/uploads';

package/src/resources/moderations.ts

@@ -168,6 +168,8 @@ export namespace Moderation {
   }
 }
 
+export type ModerationModel = 'text-moderation-latest' | 'text-moderation-stable';
+
 /**
  * Represents if a given text input is potentially harmful.
  */
@@ -204,11 +206,12 @@ export interface ModerationCreateParams {
    * model. Accuracy of `text-moderation-stable` may be slightly lower than for
    * `text-moderation-latest`.
    */
-  model?: (string & {}) | 'text-moderation-latest' | 'text-moderation-stable';
+  model?: (string & {}) | ModerationModel;
 }
 
 export namespace Moderations {
   export import Moderation = ModerationsAPI.Moderation;
+  export import ModerationModel = ModerationsAPI.ModerationModel;
   export import ModerationCreateResponse = ModerationsAPI.ModerationCreateResponse;
   export import ModerationCreateParams = ModerationsAPI.ModerationCreateParams;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.53.2'; // x-release-please-version
+export const VERSION = '4.54.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.53.2";
+export declare const VERSION = "4.54.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 = '4.53.2'; // x-release-please-version
+exports.VERSION = '4.54.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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