openai 4.8.0 → 4.9.0

package/src/_shims/web-runtime.ts

@@ -0,0 +1,91 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import { MultipartBody } from './MultipartBody';
+import { type RequestOptions } from '../core';
+import { type Shims } from './registry';
+
+export function getRuntime({ manuallyImported }: { manuallyImported?: boolean } = {}): Shims {
+  const recommendation =
+    manuallyImported ?
+      `You may need to use polyfills`
+    : `Add one of these imports before your first \`import … from 'openai'\`:
+- \`import 'openai/shims/node'\` (if you're running on Node)
+- \`import 'openai/shims/web'\` (otherwise)
+`;
+
+  let _fetch, _Request, _Response, _Headers;
+  try {
+    // @ts-ignore
+    _fetch = fetch;
+    // @ts-ignore
+    _Request = Request;
+    // @ts-ignore
+    _Response = Response;
+    // @ts-ignore
+    _Headers = Headers;
+  } catch (error) {
+    throw new Error(
+      `this environment is missing the following Web Fetch API type: ${
+        (error as any).message
+      }. ${recommendation}`,
+    );
+  }
+
+  return {
+    kind: 'web',
+    fetch: _fetch,
+    Request: _Request,
+    Response: _Response,
+    Headers: _Headers,
+    FormData:
+      // @ts-ignore
+      typeof FormData !== 'undefined' ? FormData : (
+        class FormData {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'FormData' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    Blob:
+      typeof Blob !== 'undefined' ? Blob : (
+        class Blob {
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'Blob' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    File:
+      // @ts-ignore
+      typeof File !== 'undefined' ? File : (
+        class File {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'File' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    getMultipartRequestOptions: async <T extends {} = Record<string, unknown>>(
+      // @ts-ignore
+      form: FormData,
+      opts: RequestOptions<T>,
+    ): Promise<RequestOptions<T>> => ({
+      ...opts,
+      body: new MultipartBody(form) as any,
+    }),
+    getDefaultAgent: (url: string) => undefined,
+    fileFromPath: () => {
+      throw new Error(
+        'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/openai/openai-node#file-uploads',
+      );
+    },
+    isFsReadStream: (value: any) => false,
+  };
+}

package/src/_shims/web-types.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type Agent = any;
+
+declare const _fetch: typeof fetch;
+export { _fetch as fetch };
+
+type _Request = Request;
+export { _Request as Request };
+
+type _RequestInfo = RequestInfo;
+export { type _RequestInfo as RequestInfo };
+
+type _RequestInit = RequestInit;
+export { type _RequestInit as RequestInit };
+
+type _Response = Response;
+export { _Response as Response };
+
+type _ResponseInit = ResponseInit;
+export { type _ResponseInit as ResponseInit };
+
+type _ResponseType = ResponseType;
+export { type _ResponseType as ResponseType };
+
+type _BodyInit = BodyInit;
+export { type _BodyInit as BodyInit };
+
+type _Headers = Headers;
+export { _Headers as Headers };
+
+type _HeadersInit = HeadersInit;
+export { type _HeadersInit as HeadersInit };
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+type _FormData = FormData;
+declare const _FormData: typeof FormData;
+export { _FormData as FormData };
+
+type _File = File;
+declare const _File: typeof File;
+export { _File as File };
+
+type _Blob = Blob;
+declare const _Blob: typeof Blob;
+export { _Blob as Blob };
+
+export declare class Readable {
+  readable: boolean;
+  readonly readableEnded: boolean;
+  readonly readableFlowing: boolean | null;
+  readonly readableHighWaterMark: number;
+  readonly readableLength: number;
+  readonly readableObjectMode: boolean;
+  destroyed: boolean;
+  read(size?: number): any;
+  pause(): this;
+  resume(): this;
+  isPaused(): boolean;
+  destroy(error?: Error): this;
+  [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+}
+
+export declare class FsReadStream extends Readable {
+  path: {}; // node type is string | Buffer
+}
+
+type _ReadableStream<R = any> = ReadableStream<R>;
+export { type _ReadableStream as ReadableStream };

package/src/_shims/web-types.js

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */

package/src/_shims/web-types.mjs

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */

package/src/core.ts

@@ -1,24 +1,25 @@
-import { VERSION } from './version.js';
-import { Stream } from './streaming.js';
-import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error.js';
-import type { Readable } from './_shims/node-readable.js';
-import { getDefaultAgent, type Agent } from './_shims/agent.js';
+import { VERSION } from './version';
+import { Stream } from './streaming';
+import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error';
 import {
+  kind as shimsKind,
+  type Readable,
+  getDefaultAgent,
+  type Agent,
   fetch,
-  isPolyfilled as fetchIsPolyfilled,
   type RequestInfo,
   type RequestInit,
   type Response,
   type HeadersInit,
-} from './_shims/fetch.js';
+} from './_shims/index';
 export { type Response };
-import { isMultipartBody } from './uploads.js';
+import { isMultipartBody } from './uploads';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
   createForm,
   type Uploadable,
-} from './uploads.js';
+} from './uploads';
 
 const MAX_RETRIES = 2;
 
@@ -84,6 +85,12 @@ export class APIPromise<T> extends Promise<T> {
    *
    * If you want to parse the response body but still get the `Response`
    * instance, you can use {@link withResponse()}.
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * or add one of these imports before your first `import … from 'openai'`:
+   * - `import 'openai/shims/node'` (if you're running on Node)
+   * - `import 'openai/shims/web'` (otherwise)
    */
   asResponse(): Promise<Response> {
     return this.responsePromise.then((p) => p.response);
@@ -93,6 +100,13 @@ export class APIPromise<T> extends Promise<T> {
    *
    * If you just want to get the raw `Response` instance without parsing it,
    * you can use {@link asResponse()}.
+   *
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * or add one of these imports before your first `import … from 'openai'`:
+   * - `import 'openai/shims/node'` (if you're running on Node)
+   * - `import 'openai/shims/web'` (otherwise)
    */
   async withResponse(): Promise<{ data: T; response: Response }> {
     const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
@@ -277,7 +291,7 @@ export abstract class APIClient {
       ...headers,
     };
     // let builtin fetch set the Content-Type for multipart bodies
-    if (isMultipartBody(options.body) && !fetchIsPolyfilled) {
+    if (isMultipartBody(options.body) && shimsKind !== 'node') {
       delete reqHeaders['Content-Type'];
     }
 
@@ -444,11 +458,14 @@ export abstract class APIClient {
 
     const timeout = setTimeout(() => controller.abort(), ms);
 
-    return this.getRequestClient()
-      .fetch(url, { signal: controller.signal as any, ...options })
-      .finally(() => {
-        clearTimeout(timeout);
-      });
+    return (
+      this.getRequestClient()
+        // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
+        .fetch.call(undefined, url, { signal: controller.signal as any, ...options })
+        .finally(() => {
+          clearTimeout(timeout);
+        })
+    );
   }
 
   protected getRequestClient(): RequestClient {
@@ -592,7 +609,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
     } else if ('url' in nextInfo) {
       const params = [...Object.entries(nextOptions.query || {}), ...nextInfo.url.searchParams.entries()];
       for (const [key, value] of params) {
-        nextInfo.url.searchParams.set(key, value);
+        nextInfo.url.searchParams.set(key, value as any);
       }
       nextOptions.query = undefined;
       nextOptions.path = nextInfo.url.toString();
@@ -718,7 +735,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   idempotencyKey: true,
 };
 
-export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
+export const isRequestOptions = (obj: unknown): obj is RequestOptions<Record<string, unknown> | Readable> => {
   return (
     typeof obj === 'object' &&
     obj !== null &&

package/src/error.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { castToError, Headers } from './core.js';
+import { castToError, Headers } from './core';
 
 export class APIError extends Error {
   readonly status: number | undefined;

package/src/index.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from './core.js';
-import * as Pagination from './pagination.js';
-import * as API from './resources/index.js';
-import * as Errors from './error.js';
-import type { Agent } from './_shims/agent.js';
-import * as Uploads from './uploads.js';
+import * as Core from './core';
+import * as Pagination from './pagination';
+import * as API from './resources/index';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
 
 export interface ClientOptions {
   /**

package/src/pagination.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core.js';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
 
 export interface PageResponse<Item> {
   data: Array<Item>;

package/src/resource.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import type { OpenAI } from './index.js';
+import type { OpenAI } from './index';
 
 export class APIResource {
   protected client: OpenAI;

package/src/resources/audio/audio.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource.js';
-import { Transcriptions } from './transcriptions.js';
-import { Translations } from './translations.js';
-import * as API from './index.js';
+import { APIResource } from "../../resource";
+import { Transcriptions } from './transcriptions';
+import { Translations } from './translations';
+import * as API from './index';
 
 export class Audio extends APIResource {
   transcriptions: Transcriptions = new Transcriptions(this.client);

package/src/resources/audio/index.ts

@@ -1,5 +1,5 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Audio } from './audio.js';
-export { Transcription, TranscriptionCreateParams, Transcriptions } from './transcriptions.js';
-export { Translation, TranslationCreateParams, Translations } from './translations.js';
+export { Audio } from './audio';
+export { Transcription, TranscriptionCreateParams, Transcriptions } from './transcriptions';
+export { Translation, TranslationCreateParams, Translations } from './translations';

package/src/resources/audio/transcriptions.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as API from './index.js';
-import { type Uploadable, multipartFormRequestOptions } from '../../core.js';
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from "../../core";
 
 export class Transcriptions extends APIResource {
   /**

package/src/resources/audio/translations.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as API from './index.js';
-import { type Uploadable, multipartFormRequestOptions } from '../../core.js';
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from "../../core";
 
 export class Translations extends APIResource {
   /**

package/src/resources/chat/chat.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource.js';
-import { Completions } from './completions.js';
-import * as API from './index.js';
+import { APIResource } from "../../resource";
+import { Completions } from './completions';
+import * as API from './index';
 
 export class Chat extends APIResource {
   completions: Completions = new Completions(this.client);

package/src/resources/chat/completions.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIPromise } from '../../core.js';
-import { APIResource } from '../../resource.js';
-import * as Completions_ from '../completions.js';
-import * as API from './index.js';
-import { Stream } from '../../streaming.js';
+import * as Core from "../../core";
+import { APIPromise } from "../../core";
+import { APIResource } from "../../resource";
+import * as Completions_ from "../completions";
+import * as API from './index';
+import { Stream } from "../../streaming";
 
 export class Completions extends APIResource {
   /**

package/src/resources/chat/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Chat } from './chat.js';
+export { Chat } from './chat';
 export {
   ChatCompletion,
   ChatCompletionChunk,
@@ -15,4 +15,4 @@ export {
   ChatCompletionCreateParamsStreaming,
   CompletionCreateParamsStreaming,
   Completions,
-} from './completions.js';
+} from './completions';

package/src/resources/completions.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIPromise } from '../core.js';
-import { APIResource } from '../resource.js';
-import * as API from './index.js';
-import { Stream } from '../streaming.js';
+import * as Core from "../core";
+import { APIPromise } from "../core";
+import { APIResource } from "../resource";
+import * as API from './index';
+import { Stream } from "../streaming";
 
 export class Completions extends APIResource {
   /**

package/src/resources/edits.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import * as Completions from './completions.js';
-import * as API from './index.js';
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import * as Completions from "./completions";
+import * as API from './index';
 
 export class Edits extends APIResource {
   /**

package/src/resources/embeddings.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import * as API from './index.js';
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import * as API from './index';
 
 export class Embeddings extends APIResource {
   /**

package/src/resources/files.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import { sleep } from '../core.js';
-import { APIConnectionTimeoutError } from '../error.js';
-import * as API from './index.js';
-import { type Uploadable, multipartFormRequestOptions } from '../core.js';
-import { Page } from '../pagination.js';
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import { sleep } from "../core";
+import { APIConnectionTimeoutError } from "../error";
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from "../core";
+import { Page } from "../pagination";
 
 export class Files extends APIResource {
   /**

package/src/resources/fine-tunes.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIPromise } from '../core.js';
-import { APIResource } from '../resource.js';
-import * as Files from './files.js';
-import * as API from './index.js';
-import { Page } from '../pagination.js';
-import { Stream } from '../streaming.js';
+import * as Core from "../core";
+import { APIPromise } from "../core";
+import { APIResource } from "../resource";
+import * as Files from "./files";
+import * as API from './index';
+import { Page } from "../pagination";
+import { Stream } from "../streaming";
 
 export class FineTunes extends APIResource {
   /**

package/src/resources/fine-tuning/fine-tuning.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '../../resource.js';
-import { Jobs } from './jobs.js';
-import * as API from './index.js';
+import { APIResource } from "../../resource";
+import { Jobs } from './jobs';
+import * as API from './index';
 
 export class FineTuning extends APIResource {
   jobs: Jobs = new Jobs(this.client);

package/src/resources/fine-tuning/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { FineTuning } from './fine-tuning.js';
+export { FineTuning } from './fine-tuning';
 export {
   FineTuningJob,
   FineTuningJobEvent,
@@ -10,4 +10,4 @@ export {
   FineTuningJobsPage,
   FineTuningJobEventsPage,
   Jobs,
-} from './jobs.js';
+} from './jobs';

package/src/resources/fine-tuning/jobs.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../../core.js';
-import { APIResource } from '../../resource.js';
-import { isRequestOptions } from '../../core.js';
-import * as Files from '../files.js';
-import * as API from './index.js';
-import { CursorPage, CursorPageParams } from '../../pagination.js';
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as Files from "../files";
+import * as API from './index';
+import { CursorPage, CursorPageParams } from "../../pagination";
 
 export class Jobs extends APIResource {
   /**

package/src/resources/images.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import * as API from './index.js';
-import { type Uploadable, multipartFormRequestOptions } from '../core.js';
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from "../core";
 
 export class Images extends APIResource {
   /**

package/src/resources/index.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Audio } from './audio/audio.js';
-export { Chat } from './chat/chat.js';
+export { Audio } from './audio/audio';
+export { Chat } from './chat/chat';
 export {
   Completion,
   CompletionChoice,
@@ -10,10 +10,10 @@ export {
   CompletionCreateParamsNonStreaming,
   CompletionCreateParamsStreaming,
   Completions,
-} from './completions.js';
-export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings.js';
-export { Edit, EditCreateParams, Edits } from './edits.js';
-export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files.js';
+} from './completions';
+export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
+export { Edit, EditCreateParams, Edits } from './edits';
+export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files';
 export {
   FineTune,
   FineTuneEvent,
@@ -24,8 +24,8 @@ export {
   FineTuneListEventsParamsStreaming,
   FineTunesPage,
   FineTunes,
-} from './fine-tunes.js';
-export { FineTuning } from './fine-tuning/fine-tuning.js';
+} from './fine-tunes';
+export { FineTuning } from './fine-tuning/fine-tuning';
 export {
   Image,
   ImagesResponse,
@@ -33,6 +33,6 @@ export {
   ImageEditParams,
   ImageGenerateParams,
   Images,
-} from './images.js';
-export { Model, ModelDeleted, ModelsPage, Models } from './models.js';
-export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations.js';
+} from './images';
+export { Model, ModelDeleted, ModelsPage, Models } from './models';
+export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations';

package/src/resources/models.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import * as API from './index.js';
-import { Page } from '../pagination.js';
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import * as API from './index';
+import { Page } from "../pagination";
 
 export class Models extends APIResource {
   /**