Merge pull request #421 from openai/release-please--branches--master--changes--next--components--openai

Author: athyuttamre

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.15.0"
+  ".": "4.15.1"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.15.1 (2023-11-04)
+
+Full Changelog: [v4.15.0...v4.15.1](https://github.com/openai/openai-node/compare/v4.15.0...v4.15.1)
+
+### Documentation
+
+* document customizing fetch ([#420](https://github.com/openai/openai-node/issues/420)) ([1ca982f](https://github.com/openai/openai-node/commit/1ca982f192daf49e33b7acb5505ed26c9d891255))
+
 ## 4.15.0 (2023-11-03)
 
 Full Changelog: [v4.14.2...v4.15.0](https://github.com/openai/openai-node/compare/v4.14.2...v4.15.0)

README.md

@@ -21,7 +21,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://raw.githubusercontent.com/openai/openai-node/v4.14.2-deno/mod.ts';
+import OpenAI from 'https://raw.githubusercontent.com/openai/openai-node/v4.15.0-deno/mod.ts';
 ```
 
 <!-- x-release-please-end -->
@@ -395,6 +395,45 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(chatCompletion.choices);
 ```
 
+## Customizing the fetch client
+
+By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+
+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"`:
+
+<!-- prettier-ignore -->
+```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";
+```
+
+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 [here](https://github.com/openai/openai-node/src/_shims#readme).
+
+You may also provide a custom `fetch` function when instantiating the client,
+which can be used to inspect or alter the `Request` or `Response` before/after each request:
+
+```ts
+import { fetch } from 'undici'; // as one example
+import OpenAI from 'openai';
+
+const client = new OpenAI({
+  fetch: (url: RequestInfo, init?: RequestInfo): Response => {
+    console.log('About to make request', url, init);
+    const response = await fetch(url, init);
+    console.log('Got response', response);
+    return response;
+  },
+});
+```
+
+Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
+This is intended for debugging purposes only and may change in the future without notice.
+
 ## Configuring an HTTP(S) Agent (e.g., for proxies)
 
 By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.15.0",
+  "version": "4.15.1",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.15.0'; // x-release-please-version
+export const VERSION = '4.15.1'; // x-release-please-version