v4.0.1

Author: schnerd

README.md

@@ -42,7 +42,7 @@ main();
 
 ## Streaming Responses
 
-We provide support for streaming responses using Server Side Events (SSE).
+We provide support for streaming responses using Server Sent Events (SSE).
 
 ```ts
 import OpenAI from 'openai';

ecosystem-tests/bun/.gitignore

@@ -0,0 +1,169 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*

ecosystem-tests/bun/README.md

@@ -0,0 +1,15 @@
+# openai-bun-test
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v0.6.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

ecosystem-tests/bun/bun.lockb

@@ -0,0 +1,48 @@
+import OpenAI, { toFile } from 'openai';
+import { distance } from 'fastest-levenshtein';
+import { test, expect } from 'bun:test';
+
+const client = new OpenAI();
+
+function expectSimilar(received: any, comparedTo: string, expectedDistance: number) {
+  const message = () =>
+    [
+      `Received: ${JSON.stringify(received)}`,
+      `Expected: ${JSON.stringify(comparedTo)}`,
+      `Expected distance: ${expectedDistance}`,
+      `Received distance: ${actualDistance}`,
+    ].join('\n');
+
+  const actualDistance = distance(received, comparedTo);
+  expect(actualDistance).toBeLessThan(expectedDistance);
+}
+
+test(`basic request works`, async function () {
+  const completion = await client.chat.completions.create({
+    model: 'gpt-4',
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+  });
+  expectSimilar(completion.choices[0]?.message?.content, 'This is a test', 10);
+});
+
+test(`streaming works`, async function () {
+  const stream = await client.chat.completions.create({
+    model: 'gpt-4',
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+    stream: true,
+  });
+  const chunks = [];
+  for await (const part of stream) {
+    chunks.push(part);
+  }
+  expectSimilar(chunks.map((c) => c.choices[0]?.delta.content || '').join(''), 'This is a test', 10);
+});
+
+test(`toFile rejects`, async function () {
+  try {
+    await toFile(new TextEncoder().encode('foo'), 'foo.txt');
+    throw new Error(`expected toFile to reject`);
+  } catch (error) {
+    expect((error as any).message).toEqual(`file uploads aren't supported in this environment yet`);
+  }
+});

ecosystem-tests/bun/openai.test.ts

@@ -0,0 +1,15 @@
+{
+  "name": "openai-bun-test",
+  "module": "index.ts",
+  "type": "module",
+  "scripts": {
+    "tsc": "tsc"
+  },
+  "devDependencies": {
+    "fastest-levenshtein": "^1.0.16",
+    "bun-types": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

ecosystem-tests/bun/package.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+    "jsx": "preserve",
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "noEmit": true,
+    "types": [
+      "bun-types" // add Bun global
+    ]
+  }
+}

ecosystem-tests/bun/tsconfig.json

@@ -65,6 +65,22 @@ const projects = {
     await installPackage();
     await run('npm', ['run', 'tsc']);
   },
+  bun: async () => {
+    if (state.fromNpm) {
+      await run('bun', ['install', '-D', state.fromNpm]);
+      return;
+    }
+
+    const packFile = getPackFile();
+    await fs.copyFile(packFile, `./${TAR_NAME}`);
+    await run('bun', ['install', '-D', `./${TAR_NAME}`]);
+
+    await run('npm', ['run', 'tsc']);
+
+    if (state.live) {
+      await run('bun', ['test']);
+    }
+  },
   deno: async () => {
     await run('deno', ['task', 'install']);
     await installPackage();

ecosystem-tests/cli.ts

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",
@@ -86,6 +86,7 @@
     "@typescript-eslint/eslint-plugin": "^5.33.0",
     "@typescript-eslint/parser": "^5.33.0",
     "eslint": "^8.22.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
     "jest": "^29.4.0",
     "openai": "link:.",

package.json

@@ -3,7 +3,15 @@
  */
 
 exports.FormData = FormData;
-exports.File = File;
 exports.Blob = Blob;
+exports.File =
+  typeof File !== 'undefined' ? File : (
+    // Bun doesn't implement File yet, so just make a shim that throws a helpful error message
+    class File extends Blob {
+      constructor() {
+        throw new Error(`file uploads aren't supported in this environment yet as 'File' is not defined`);
+      }
+    }
+  );
 
 exports.isPolyfilled = false;

src/_shims/formdata.js

@@ -3,9 +3,18 @@
  */
 
 const _FormData = FormData;
-const _File = File;
 const _Blob = Blob;
 
+const _File =
+  typeof File !== 'undefined' ? File : (
+    // Bun doesn't implement File yet, so just make a shim that throws a helpful error message
+    class File extends Blob {
+      constructor() {
+        throw new Error(`file uploads aren't supported in this environment yet as 'File' is not defined`);
+      }
+    }
+  );
+
 export { _FormData as FormData, _File as File, _Blob as Blob };
 
 export const isPolyfilled = false;

src/_shims/formdata.mjs

@@ -16,6 +16,10 @@ export class Completions extends APIResource {
     body: CompletionCreateParamsStreaming,
     options?: Core.RequestOptions,
   ): APIPromise<Stream<ChatCompletionChunk>>;
+  create(
+    body: CompletionCreateParams,
+    options?: Core.RequestOptions,
+  ): APIPromise<Stream<ChatCompletionChunk> | ChatCompletion>;
   create(
     body: CompletionCreateParams,
     options?: Core.RequestOptions,

src/resources/chat/completions.ts

@@ -15,6 +15,10 @@ export class Completions extends APIResource {
     body: CompletionCreateParamsStreaming,
     options?: Core.RequestOptions,
   ): APIPromise<Stream<Completion>>;
+  create(
+    body: CompletionCreateParams,
+    options?: Core.RequestOptions,
+  ): APIPromise<Stream<Completion> | Completion>;
   create(
     body: CompletionCreateParams,
     options?: Core.RequestOptions,

src/resources/completions.ts

@@ -57,6 +57,11 @@ export class FineTunes extends APIResource {
     query: FineTuneListEventsParamsStreaming,
     options?: Core.RequestOptions,
   ): APIPromise<Stream<FineTuneEvent>>;
+  listEvents(
+    fineTuneId: string,
+    query?: FineTuneListEventsParams | undefined,
+    options?: Core.RequestOptions,
+  ): APIPromise<Stream<FineTuneEvent> | FineTuneEventsListResponse>;
   listEvents(
     fineTuneId: string,
     query?: FineTuneListEventsParams | undefined,