v4.0.0-beta.8

Author: schnerd

.gitignore

@@ -2,4 +2,5 @@ node_modules
 yarn-error.log
 codegen.log
 dist
+/deno
 /*.tgz

.prettierignore

@@ -1,3 +1,4 @@
 CHANGELOG.md
 /ecosystem-tests
 /node_modules
+/deno

README.md

@@ -230,11 +230,15 @@ await openai.models.list({
 })
 ```
 
-## Status
+## Semantic Versioning
 
-This package is in beta. Its internals and interfaces are not stable
-and subject to change without a major semver bump;
-please reach out if you rely on any undocumented behavior.
+This package generally attempts to follow [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
 We are keen for your feedback; please open an [issue](https://www.github.com/openai/openai-node/issues) with questions, bugs, or suggestions.
 

build

@@ -3,15 +3,12 @@ set -exuo pipefail
 
 node scripts/check-version.cjs
 
-yarn tsc
-
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
 # This way importing from `"openai/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
-rm -rf dist
-mkdir dist
+rm -rf dist; mkdir dist
 # Copy src to dist/src and build from dist/src into dist, so that
 # the source map for index.js.map will refer to ./src/index.ts etc
 cp -rp src README.md dist
@@ -23,10 +20,10 @@ done
 node scripts/make-dist-package-json.cjs > dist/package.json
 
 # build to .js/.mjs/.d.ts files
-tsc-multi
+npm exec tsc-multi
 # copy over handwritten .js/.mjs/.d.ts files
 cp src/_shims/*.{d.ts,js,mjs} dist/_shims
-tsc-alias -p tsconfig.build.json
+npm exec tsc-alias -- -p tsconfig.build.json
 # we need to add exports = module.exports = OpenAI Node to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
@@ -37,19 +34,22 @@ node scripts/fix-index-exports.cjs
 # the same export default statement)
 cp dist/index.d.ts dist/index.d.mts
 
+SED=(sed -i)
+if [[ "$OSTYPE" == "darwin"* ]]; then SED=(sed -i ''); fi
+
 # strip out lib="dom" and types="node" references; these are needed at build time,
 # but would pollute the user's TS environment
 REFERENCE_SUBS='s/^ *\/\/\/ *<reference *lib="dom".*//g;s/^ *\/\/\/ *<reference *types="node".*//g'
-if [[ "$OSTYPE" == "darwin"* ]]; then
-  find dist -type f -exec sed -i '' "${REFERENCE_SUBS}" {} +
-else
-  find dist -type f -exec sed -i "${REFERENCE_SUBS}" {} +
-fi
+find dist -type f -exec "${SED[@]}" "${REFERENCE_SUBS}" {} +
 
-yarn prettier --loglevel=warn --write .
+npm exec prettier -- --loglevel=warn --write .
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-cd dist
-node -e 'require("openai")'
-node -e 'import("openai")' --input-type=module
+(cd dist && node -e 'require("openai")')
+(cd dist && node -e 'import("openai")' --input-type=module)
+
+if command -v deno &> /dev/null && [ -e ./build-deno ]
+then
+  ./build-deno
+fi

ecosystem-tests/ts-browser-webpack/src/index.ts

@@ -93,7 +93,7 @@ const model = 'whisper-1';
 
 const params = new URLSearchParams(location.search);
 
-const client = new OpenAI({ apiKey: params.get('apiKey') ?? undefined });
+const client = new OpenAI({ apiKey: params.get('apiKey') ?? undefined, dangerouslyAllowBrowser: true });
 
 async function typeTests() {
   // @ts-expect-error this should error if the `Uploadable` type was resolved correctly

examples/azure.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI from 'openai';
 

examples/demo.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI from 'openai';
 

examples/errors.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 import OpenAI, { NotFoundError } from 'openai';
 

examples/fine-tunes.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env yarn tsn -T
+#!/usr/bin/env -S npm run tsn -T
 
 /**
  * Fine-tuning allows you to train models on your own data.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.8",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",
@@ -91,6 +91,7 @@
     "jest": "^29.4.0",
     "prettier": "rattrayalex/prettier#postfix-ternaries",
     "ts-jest": "^29.1.0",
+    "ts-morph": "^19.0.0",
     "ts-node": "^10.5.0",
     "tsc-alias": "^1.8.6",
     "tsc-multi": "^1.1.0",

src/_shims/ReadableStream.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `ReadableStream` type for your environment.
+ */
+
+// @ts-ignore
+type _ReadableStream<R = any> = unknown extends ReadableStream ? never : ReadableStream<R>;
+declare const _ReadableStream: {
+  prototype: _ReadableStream;
+  new (
+    underlyingSource: _UnderlyingByteSource,
+    strategy?: { highWaterMark?: number },
+  ): _ReadableStream<Uint8Array>;
+  new <R = any>(
+    underlyingSource: _UnderlyingDefaultSource<R>,
+    strategy?: _QueuingStrategy<R>,
+  ): _ReadableStream<R>;
+  new <R = any>(underlyingSource?: _UnderlyingSource<R>, strategy?: _QueuingStrategy<R>): _ReadableStream<R>;
+};
+
+// @ts-ignore
+type _UnderlyingSource<R = any> = unknown extends UnderlyingSource ? never : UnderlyingSource<R>;
+// @ts-ignore
+type _UnderlyingByteSource = unknown extends UnderlyingByteSource ? never : UnderlyingByteSource;
+type _UnderlyingDefaultSource<R = any> =
+  // @ts-ignore
+  unknown extends UnderlyingDefaultSource ? never : UnderlyingDefaultSource<R>;
+// @ts-ignore
+type _QueuingStrategy<R = any> = unknown extends QueuingStrategy ? never : QueuingStrategy<R>;
+
+export { _ReadableStream as ReadableStream };

src/_shims/ReadableStream.js

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

src/_shims/ReadableStream.mjs

@@ -0,0 +1,7 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const _ReadableStream = ReadableStream;
+
+export { _ReadableStream as ReadableStream };

src/_shims/ReadableStream.node.ts

@@ -0,0 +1,6 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+import { ReadableStream } from 'web-streams-polyfill';
+
+export { ReadableStream };

src/_shims/fetch.deno.ts

@@ -0,0 +1,23 @@
+const _fetch = fetch;
+const _Request = Request;
+type _RequestInfo = RequestInfo;
+type _RequestInit = RequestInit;
+const _Response = Response;
+type _ResponseInit = ResponseInit;
+type _BodyInit = BodyInit;
+const _Headers = Headers;
+type _HeadersInit = HeadersInit;
+
+export const isPolyfilled = false;
+
+export {
+  _fetch as fetch,
+  _Request as Request,
+  type _RequestInfo as RequestInfo,
+  type _RequestInit as RequestInit,
+  _Response as Response,
+  type _ResponseInit as ResponseInit,
+  type _BodyInit as BodyInit,
+  _Headers as Headers,
+  type _HeadersInit as HeadersInit,
+};

src/_shims/formdata.deno.ts

@@ -0,0 +1,16 @@
+type _BlobPropertyBag = BlobPropertyBag;
+type _FilePropertyBag = FilePropertyBag;
+
+const _FormData = FormData;
+const _File = File;
+const _Blob = Blob;
+
+export const isPolyfilled = false;
+
+export {
+  _FormData as FormData,
+  _File as File,
+  _Blob as Blob,
+  type _BlobPropertyBag as BlobPropertyBag,
+  type _FilePropertyBag as FilePropertyBag,
+};

src/core.ts

@@ -635,12 +635,13 @@ type PlatformName =
   | 'Android'
   | `Other:${string}`
   | 'Unknown';
+type Browser = 'ie' | 'edge' | 'chrome' | 'firefox' | 'safari';
 type PlatformProperties = {
   'X-Stainless-Lang': 'js';
   'X-Stainless-Package-Version': string;
   'X-Stainless-OS': PlatformName;
   'X-Stainless-Arch': Arch;
-  'X-Stainless-Runtime': 'node' | 'deno' | 'edge' | 'unknown';
+  'X-Stainless-Runtime': 'node' | 'deno' | 'edge' | `browser:${Browser}` | 'unknown';
   'X-Stainless-Runtime-Version': string;
 };
 const getPlatformProperties = (): PlatformProperties => {
@@ -675,7 +676,20 @@ const getPlatformProperties = (): PlatformProperties => {
       'X-Stainless-Runtime-Version': process.version,
     };
   }
-  // TODO add support for Cloudflare workers, browsers, etc.
+
+  const browserInfo = getBrowserInfo();
+  if (browserInfo) {
+    return {
+      'X-Stainless-Lang': 'js',
+      'X-Stainless-Package-Version': VERSION,
+      'X-Stainless-OS': 'Unknown',
+      'X-Stainless-Arch': 'unknown',
+      'X-Stainless-Runtime': `browser:${browserInfo.browser}`,
+      'X-Stainless-Runtime-Version': browserInfo.version,
+    };
+  }
+
+  // TODO add support for Cloudflare workers, etc.
   return {
     'X-Stainless-Lang': 'js',
     'X-Stainless-Package-Version': VERSION,
@@ -686,6 +700,44 @@ const getPlatformProperties = (): PlatformProperties => {
   };
 };
 
+type BrowserInfo = {
+  browser: Browser;
+  version: string;
+};
+
+declare const navigator: { userAgent: string } | undefined;
+
+// Note: modified from https://github.com/JS-DevTools/host-environment/blob/b1ab79ecde37db5d6e163c050e54fe7d287d7c92/src/isomorphic.browser.ts
+function getBrowserInfo(): BrowserInfo | null {
+  if (!navigator || typeof navigator === 'undefined') {
+    return null;
+  }
+
+  // NOTE: The order matters here!
+  const browserPatterns = [
+    { key: 'edge' as const, pattern: /Edge(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'ie' as const, pattern: /MSIE(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'ie' as const, pattern: /Trident(?:.*rv\:(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'chrome' as const, pattern: /Chrome(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'firefox' as const, pattern: /Firefox(?:\W+(\d+)\.(\d+)(?:\.(\d+))?)?/ },
+    { key: 'safari' as const, pattern: /(?:Version\W+(\d+)\.(\d+)(?:\.(\d+))?)?(?:\W+Mobile\S*)?\W+Safari/ },
+  ];
+
+  // Find the FIRST matching browser
+  for (const { key, pattern } of browserPatterns) {
+    const match = pattern.exec(navigator.userAgent);
+    if (match) {
+      const major = match[1] || 0;
+      const minor = match[2] || 0;
+      const patch = match[3] || 0;
+
+      return { browser: key, version: `${major}.${minor}.${patch}` };
+    }
+  }
+
+  return null;
+}
+
 const normalizeArch = (arch: string): Arch => {
   // Node docs:
   // - https://nodejs.org/api/process.html#processarch
@@ -744,8 +796,8 @@ const isAbsoluteURL = (url: string): boolean => {
 
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
-const validatePositiveInteger = (name: string, n: number) => {
-  if (!Number.isInteger(n)) {
+const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
     throw new Error(`${name} must be an integer`);
   }
   if (n < 0) {
@@ -767,14 +819,16 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 /**
  * Read an environment variable.
  *
- * Will return an empty string if the environment variable doesn't exist or cannot be accessed.
+ * Will return undefined if the environment variable doesn't exist or cannot be accessed.
  */
 export const readEnv = (env: string): string | undefined => {
-  if (typeof process === 'undefined') {
-    return undefined;
+  if (typeof process !== 'undefined') {
+    return process.env?.[env] ?? undefined;
   }
-
-  return process.env[env] ?? undefined;
+  if (typeof Deno !== 'undefined') {
+    return Deno.env?.get?.(env);
+  }
+  return undefined;
 };
 
 export const coerceInteger = (value: unknown): number => {
@@ -841,6 +895,17 @@ const uuid4 = () => {
   });
 };
 
+export const isRunningInBrowser = () => {
+  return (
+    // @ts-ignore
+    typeof window !== 'undefined' &&
+    // @ts-ignore
+    typeof window.document !== 'undefined' &&
+    // @ts-ignore
+    typeof navigator !== 'undefined'
+  );
+};
+
 export interface HeadersProtocol {
   get: (header: string) => string | null | undefined;
 }

src/index.ts

@@ -67,6 +67,12 @@ export interface ClientOptions {
    */
   defaultQuery?: Core.DefaultQuery;
 
+  /**
+   * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
+   * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
+   */
+  dangerouslyAllowBrowser?: boolean;
+
   organization?: string | null;
 }
 
@@ -95,6 +101,12 @@ export class OpenAI extends Core.APIClient {
       ...opts,
     };
 
+    if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) {
+      throw new Error(
+        "It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers. \nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew OpenAI({ apiKey, dangerouslyAllowBrowser: true });\n\nhttps://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety\n",
+      );
+    }
+
     super({
       baseURL: options.baseURL!,
       timeout: options.timeout ?? 600000,
@@ -181,6 +193,8 @@ export namespace OpenAI {
   export import Completion = API.Completion;
   export import CompletionChoice = API.CompletionChoice;
   export import CompletionCreateParams = API.CompletionCreateParams;
+  export import CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
+  export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
 
   export import Chat = API.Chat;
 
@@ -225,6 +239,8 @@ export namespace OpenAI {
   export import FineTunesPage = API.FineTunesPage;
   export import FineTuneCreateParams = API.FineTuneCreateParams;
   export import FineTuneListEventsParams = API.FineTuneListEventsParams;
+  export import FineTuneListEventsParamsNonStreaming = API.FineTuneListEventsParamsNonStreaming;
+  export import FineTuneListEventsParamsStreaming = API.FineTuneListEventsParamsStreaming;
 }
 
 export default OpenAI;

src/resources/audio/audio.ts

@@ -3,7 +3,7 @@
 import { APIResource } from 'openai/resource';
 import { Transcriptions } from './transcriptions';
 import { Translations } from './translations';
-import * as API from './';
+import * as API from './index';
 
 export class Audio extends APIResource {
   transcriptions: Transcriptions = new Transcriptions(this.client);

src/resources/audio/transcriptions.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 import { type Uploadable, multipartFormRequestOptions } from 'openai/core';
 
 export class Transcriptions extends APIResource {

src/resources/audio/translations.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 import { type Uploadable, multipartFormRequestOptions } from 'openai/core';
 
 export class Translations extends APIResource {

src/resources/chat/chat.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from 'openai/resource';
 import { Completions } from './completions';
-import * as API from './';
+import * as API from './index';
 
 export class Chat extends APIResource {
   completions: Completions = new Completions(this.client);
@@ -14,4 +14,6 @@ export namespace Chat {
   export import ChatCompletionChunk = API.ChatCompletionChunk;
   export import CreateChatCompletionRequestMessage = API.CreateChatCompletionRequestMessage;
   export import CompletionCreateParams = API.CompletionCreateParams;
+  export import CompletionCreateParamsNonStreaming = API.CompletionCreateParamsNonStreaming;
+  export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
 }

src/resources/chat/completions.ts

@@ -6,5 +6,7 @@ export {
   ChatCompletionChunk,
   CreateChatCompletionRequestMessage,
   CompletionCreateParams,
+  CompletionCreateParamsNonStreaming,
+  CompletionCreateParamsStreaming,
   Completions,
 } from './completions';

src/resources/chat/index.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 
 export class Edits extends APIResource {
   /**

src/resources/completions.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 
 export class Embeddings extends APIResource {
   /**

src/resources/edits.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 import { type Uploadable, multipartFormRequestOptions } from 'openai/core';
 import { Page } from 'openai/pagination';
 

src/resources/embeddings.ts

@@ -3,7 +3,7 @@
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import * as Files from 'openai/resources/files';
-import * as API from './';
+import * as API from './index';
 import { Page } from 'openai/pagination';
 import { Stream } from 'openai/streaming';
 
@@ -48,14 +48,19 @@ export class FineTunes extends APIResource {
    */
   listEvents(
     fineTuneId: string,
-    query?: FineTuneListEventsParams.ListEventsRequestNonStreaming,
+    query?: FineTuneListEventsParamsNonStreaming,
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<FineTuneEventsListResponse>>;
   listEvents(
     fineTuneId: string,
-    query: FineTuneListEventsParams.ListEventsRequestStreaming,
+    query: FineTuneListEventsParamsStreaming,
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<Stream<FineTuneEvent>>>;
+  listEvents(
+    fineTuneId: string,
+    query?: FineTuneListEventsParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<FineTuneEventsListResponse | Stream<FineTuneEvent>>>;
   listEvents(
     fineTuneId: string,
     query?: FineTuneListEventsParams | undefined,
@@ -266,36 +271,48 @@ export interface FineTuneCreateParams {
   validation_file?: string | null;
 }
 
-export type FineTuneListEventsParams =
-  | FineTuneListEventsParams.ListEventsRequestNonStreaming
-  | FineTuneListEventsParams.ListEventsRequestStreaming;
+export interface FineTuneListEventsParams {
+  /**
+   * Whether to stream events for the fine-tune job. If set to true, events will be
+   * sent as data-only
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+   * as they become available. The stream will terminate with a `data: [DONE]`
+   * message when the job is finished (succeeded, cancelled, or failed).
+   *
+   * If set to false, only events generated so far will be returned.
+   */
+  stream?: boolean;
+}
 
 export namespace FineTuneListEventsParams {
-  export interface ListEventsRequestNonStreaming {
-    /**
-     * Whether to stream events for the fine-tune job. If set to true, events will be
-     * sent as data-only
-     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
-     * as they become available. The stream will terminate with a `data: [DONE]`
-     * message when the job is finished (succeeded, cancelled, or failed).
-     *
-     * If set to false, only events generated so far will be returned.
-     */
-    stream?: false;
-  }
+  export type FineTuneListEventsParamsNonStreaming = API.FineTuneListEventsParamsNonStreaming;
+  export type FineTuneListEventsParamsStreaming = API.FineTuneListEventsParamsStreaming;
+}
 
-  export interface ListEventsRequestStreaming {
-    /**
-     * Whether to stream events for the fine-tune job. If set to true, events will be
-     * sent as data-only
-     * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
-     * as they become available. The stream will terminate with a `data: [DONE]`
-     * message when the job is finished (succeeded, cancelled, or failed).
-     *
-     * If set to false, only events generated so far will be returned.
-     */
-    stream: true;
-  }
+export interface FineTuneListEventsParamsNonStreaming extends FineTuneListEventsParams {
+  /**
+   * Whether to stream events for the fine-tune job. If set to true, events will be
+   * sent as data-only
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+   * as they become available. The stream will terminate with a `data: [DONE]`
+   * message when the job is finished (succeeded, cancelled, or failed).
+   *
+   * If set to false, only events generated so far will be returned.
+   */
+  stream?: false;
+}
+
+export interface FineTuneListEventsParamsStreaming extends FineTuneListEventsParams {
+  /**
+   * Whether to stream events for the fine-tune job. If set to true, events will be
+   * sent as data-only
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
+   * as they become available. The stream will terminate with a `data: [DONE]`
+   * message when the job is finished (succeeded, cancelled, or failed).
+   *
+   * If set to false, only events generated so far will be returned.
+   */
+  stream: true;
 }
 
 export namespace FineTunes {
@@ -305,4 +322,6 @@ export namespace FineTunes {
   export type FineTunesPage = _FineTunesPage;
   export import FineTuneCreateParams = API.FineTuneCreateParams;
   export import FineTuneListEventsParams = API.FineTuneListEventsParams;
+  export import FineTuneListEventsParamsNonStreaming = API.FineTuneListEventsParamsNonStreaming;
+  export import FineTuneListEventsParamsStreaming = API.FineTuneListEventsParamsStreaming;
 }

src/resources/files.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 import { type Uploadable, multipartFormRequestOptions } from 'openai/core';
 
 export class Images extends APIResource {

src/resources/fine-tunes.ts

@@ -2,7 +2,14 @@
 
 export { Audio } from './audio/audio';
 export { Chat } from './chat/chat';
-export { Completion, CompletionChoice, CompletionCreateParams, Completions } from './completions';
+export {
+  Completion,
+  CompletionChoice,
+  CompletionCreateParams,
+  CompletionCreateParamsNonStreaming,
+  CompletionCreateParamsStreaming,
+  Completions,
+} from './completions';
 export { Edit, EditCreateParams, Edits } from './edits';
 export { Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
 export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files';
@@ -12,6 +19,8 @@ export {
   FineTuneEventsListResponse,
   FineTuneCreateParams,
   FineTuneListEventsParams,
+  FineTuneListEventsParamsNonStreaming,
+  FineTuneListEventsParamsStreaming,
   FineTunesPage,
   FineTunes,
 } from './fine-tunes';

src/resources/images.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 import { Page } from 'openai/pagination';
 
 export class Models extends APIResource {

src/resources/index.ts

@@ -2,7 +2,7 @@
 
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './';
+import * as API from './index';
 
 export class Moderations extends APIResource {
   /**

src/resources/models.ts

@@ -1,4 +1,5 @@
 import type { Response } from 'openai/_shims/fetch';
+import { ReadableStream } from 'openai/_shims/ReadableStream';
 
 import { APIResponse, Headers, createResponseHeaders } from './core';
 
@@ -78,6 +79,38 @@ export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Ite
       if (!done) this.controller.abort();
     }
   }
+
+  toReadableStream(): ReadableStream {
+    const self = this;
+    let iter: AsyncIterator<Item>;
+    const encoder = new TextEncoder();
+
+    return new ReadableStream({
+      async start() {
+        iter = self[Symbol.asyncIterator]();
+      },
+      async pull(ctrl) {
+        try {
+          const { value, done } = await iter.next();
+          if (done) return ctrl.close();
+
+          const str =
+            typeof value === 'string' ? value : (
+              // Add a newline after JSON to make it easier to parse newline-separated JSON on the frontend.
+              JSON.stringify(value) + '\n'
+            );
+          const bytes = encoder.encode(str);
+
+          ctrl.enqueue(bytes);
+        } catch (err) {
+          ctrl.error(err);
+        }
+      },
+      async cancel() {
+        await iter.return?.();
+      },
+    });
+  }
 }
 
 class SSEDecoder {

src/resources/moderations.ts

@@ -1,14 +1,15 @@
 import { type RequestOptions } from './core';
 import { type Readable } from 'openai/_shims/node-readable';
 import { type BodyInit } from 'openai/_shims/fetch';
-import { FormData, File, type FilePropertyBag } from 'openai/_shims/formdata';
+import { FormData, File, type Blob, type FilePropertyBag } from 'openai/_shims/formdata';
 import { getMultipartRequestOptions } from 'openai/_shims/getMultipartRequestOptions';
 import { fileFromPath } from 'openai/_shims/fileFromPath';
 import { type FsReadStream, isFsReadStream } from 'openai/_shims/node-readable';
 
 export { fileFromPath };
 
-export type BlobPart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
+type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
+export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
 
 /**
  * Typically, this is a native "File" class.
@@ -84,11 +85,11 @@ export const isUploadable = (value: any): value is Uploadable => {
   return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
 };
 
-export type ToFileInput = Uploadable | Exclude<BlobPart, string> | AsyncIterable<BlobPart>;
+export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
 
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobPart}, or {@link AsyncIterable} of {@link BlobPart}s
+ * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content
@@ -231,10 +232,10 @@ const addFormValue = async (form: FormData, key: string, value: unknown): Promis
 
   // TODO: make nested formats configurable
   if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-    form.append(key, value);
+    form.append(key, String(value));
   } else if (isUploadable(value)) {
     const file = await toFile(value);
-    form.append(key, file);
+    form.append(key, file as File);
   } else if (Array.isArray(value)) {
     await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
   } else if (typeof value === 'object') {

src/streaming.ts

@@ -1 +1 @@
-export const VERSION = '4.0.0-beta.7';
+export const VERSION = '4.0.0-beta.8';

src/uploads.ts

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "include": ["dist/src"],
-  "exclude": [],
+  "exclude": ["dist/src/_shims/*.deno.ts"],
   "compilerOptions": {
     "rootDir": "./dist/src",
     "paths": {

src/version.ts

@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["deno"],
+  "exclude": [],
+  "compilerOptions": {
+    "rootDir": "./deno",
+    "lib": ["es2020", "DOM"],
+    "paths": {
+      "openai/_shims/*": ["deno/_shims/*"],
+      "openai": ["deno/index.ts"],
+      "openai/*": ["deno/*"],
+      "digest-fetch": ["./typings/digest-fetch"]
+    },
+    "noEmit": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "deno",
+    "pretty": true,
+    "sourceMap": true
+  }
+}

tsconfig.build.json

@@ -1,5 +1,6 @@
 {
   "include": ["src", "tests", "examples"],
+  "exclude": ["src/_shims/*.deno.ts"],
   "compilerOptions": {
     "target": "es2019",
     "lib": ["es2020"],

tsconfig.deno.json

@@ -720,6 +720,16 @@
   dependencies:
     "@sinonjs/commons" "^3.0.0"
 
+"@ts-morph/common@~0.20.0":
+  version "0.20.0"
+  resolved "https://registry.yarnpkg.com/@ts-morph/common/-/common-0.20.0.tgz#3f161996b085ba4519731e4d24c35f6cba5b80af"
+  integrity sha512-7uKjByfbPpwuzkstL3L5MQyuXPSKdoNG93Fmi2JoDcTf3pEP731JdRFAduRVkOs8oqxPsXKA+ScrWkdQ8t/I+Q==
+  dependencies:
+    fast-glob "^3.2.12"
+    minimatch "^7.4.3"
+    mkdirp "^2.1.6"
+    path-browserify "^1.0.1"
+
 "@tsconfig/node10@^1.0.7":
   version "1.0.8"
   resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.8.tgz#c1e4e80d6f964fbecb3359c43bd48b40f7cadad9"
@@ -1218,6 +1228,13 @@ brace-expansion@^1.1.7:
     balanced-match "^1.0.0"
     concat-map "0.0.1"
 
+brace-expansion@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae"
+  integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==
+  dependencies:
+    balanced-match "^1.0.0"
+
 braces@^3.0.2, braces@~3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107"
@@ -1393,6 +1410,11 @@ co@^4.6.0:
   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
   integrity sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=
 
+code-block-writer@^12.0.0:
+  version "12.0.0"
+  resolved "https://registry.yarnpkg.com/code-block-writer/-/code-block-writer-12.0.0.tgz#4dd58946eb4234105aff7f0035977b2afdc2a770"
+  integrity sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w==
+
 collapse-white-space@1.0.6, collapse-white-space@^1.0.2:
   version "1.0.6"
   resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-1.0.6.tgz#e63629c0016665792060dbbeb79c42239d2c5287"
@@ -2962,11 +2984,23 @@ minimatch@^3.0.4, minimatch@^3.1.2:
   dependencies:
     brace-expansion "^1.1.7"
 
+minimatch@^7.4.3:
+  version "7.4.6"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb"
+  integrity sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==
+  dependencies:
+    brace-expansion "^2.0.1"
+
 minimist@1.2.6, minimist@^1.2.0, minimist@^1.2.6:
   version "1.2.6"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
   integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==
 
+mkdirp@^2.1.6:
+  version "2.1.6"
+  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-2.1.6.tgz#964fbcb12b2d8c5d6fbc62a963ac95a273e2cc19"
+  integrity sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A==
+
 ms@2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
@@ -3142,6 +3176,11 @@ parse-srcset@ikatyang/parse-srcset#54eb9c1cb21db5c62b4d0e275d7249516df6f0ee:
   version "1.0.2"
   resolved "https://codeload.github.com/ikatyang/parse-srcset/tar.gz/54eb9c1cb21db5c62b4d0e275d7249516df6f0ee"
 
+path-browserify@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd"
+  integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==
+
 path-exists@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3"
@@ -3783,6 +3822,14 @@ ts-jest@^29.1.0:
     semver "7.x"
     yargs-parser "^21.0.1"
 
+ts-morph@^19.0.0:
+  version "19.0.0"
+  resolved "https://registry.yarnpkg.com/ts-morph/-/ts-morph-19.0.0.tgz#43e95fb0156c3fe3c77c814ac26b7d0be2f93169"
+  integrity sha512-D6qcpiJdn46tUqV45vr5UGM2dnIEuTGNxVhg0sk5NX11orcouwj6i1bMqZIz2mZTZB1Hcgy7C3oEVhAT+f6mbQ==
+  dependencies:
+    "@ts-morph/common" "~0.20.0"
+    code-block-writer "^12.0.0"
+
 ts-node@^10.5.0:
   version "10.7.0"
   resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.7.0.tgz#35d503d0fab3e2baa672a0e94f4b40653c2463f5"