Merge pull request #1237 from openai/alpha-next

feat: alpha release

Author: kwhinnery-openai

.eslintrc.js

@@ -5,6 +5,25 @@ module.exports = {
     'no-unused-vars': 'off',
     'prettier/prettier': 'error',
     'unused-imports/no-unused-imports': 'error',
+    'no-restricted-imports': [
+      'error',
+      {
+        patterns: [
+          {
+            group: ['openai', 'openai/*'],
+            message: 'Use a relative import, not a package import.',
+          },
+        ],
+      },
+    ],
   },
+  overrides: [
+    {
+      files: ['tests/**', 'examples/**', 'ecosystem-tests/**'],
+      rules: {
+        'no-restricted-imports': 'off',
+      },
+    },
+  ],
   root: true,
 };

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
     branches:
       - master
       - next
+      - alpha
 
 jobs:
   lint:

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.77.0"
+  ".": "5.0.0-alpha.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-0d64ca9e45f51b4279f87b205eeb3a3576df98407698ce053f2e2302c1c08df1.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-a39aca84ed97ebafb707ebd5221e2787c5a42ff3d98f2ffaea8a0dcd84cbcbcb.yml

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ## Setting up the environment
 
-This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install).
 Other package managers may work but are not officially supported for development.
 
 To set up the repository, run:
@@ -29,10 +29,10 @@ All files in the `examples/` directory are not modified by the generator and can
 …
 ```
 
-```
-chmod +x examples/<your-example>.ts
+```sh
+$ chmod +x examples/<your-example>.ts
 # run the example against your api
-yarn tsn -T examples/<your-example>.ts
+$ yarn tsn -T examples/<your-example>.ts
 ```
 
 ## Using the repository from source

README.md

@@ -303,7 +303,6 @@ Request parameters that correspond to file uploads can be passed in many differe
 
 ```ts
 import fs from 'fs';
-import fetch from 'node-fetch';
 import OpenAI, { toFile } from 'openai';
 
 const client = new OpenAI();
@@ -560,21 +559,23 @@ validate or strip extra properties from the response from the API.
 
 ### Customizing the fetch client
 
-By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+By default, this library expects a global `fetch` function is defined.
 
-If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
-(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "OpenAI"`:
+If you want to use a different `fetch` function, you can either polyfill the global:
 
 ```ts
-// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
-// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import 'openai/shims/web';
-import OpenAI from 'openai';
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
 ```
 
-To do the inverse, add `import "openai/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/openai/openai-node/tree/master/src/_shims#readme)).
+Or pass it to the client:
+
+```ts
+import fetch from 'my-fetch';
+
+const client = new OpenAI({ fetch });
+```
 
 ### Logging and middleware
 
@@ -620,6 +621,8 @@ await client.models.list({
 });
 ```
 
+## Frequently Asked Questions
+
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -634,7 +637,7 @@ We are keen for your feedback; please open an [issue](https://github.com/ope
 
 ## Requirements
 
-TypeScript >= 4.5 is supported.
+TypeScript >= 4.9 is supported.
 
 The following runtimes are supported:
 

api.md

@@ -0,0 +1,2 @@
+/node_modules
+/dist