v4.0.0-beta.12

Author: schnerd

README.md

@@ -187,13 +187,13 @@ await openai.chat.completions.create({ messages: [{ role: 'user', content: 'How
 
 ### Timeouts
 
-Requests time out after 60 seconds by default. You can configure this with a `timeout` option:
+Requests time out after 10 minutes by default. You can configure this with a `timeout` option:
 
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
 const openai = new OpenAI({
-  timeout: 20 * 1000, // 20 seconds (default is 60s)
+  timeout: 20 * 1000, // 20 seconds (default is 10 minutes)
 });
 
 // Override per-request:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.0.0-beta.11",
+  "version": "4.0.0-beta.12",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",

src/core.ts

@@ -135,7 +135,7 @@ export abstract class APIClient {
   constructor({
     baseURL,
     maxRetries,
-    timeout = 60 * 1000, // 60s
+    timeout = 600000, // 10 minutes
     httpAgent,
     fetch: overridenFetch,
   }: {
@@ -254,7 +254,10 @@ export abstract class APIClient {
     const timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
     const minAgentTimeout = timeout + 1000;
-    if ((httpAgent as any)?.options && minAgentTimeout > ((httpAgent as any).options.timeout ?? 0)) {
+    if (
+      typeof (httpAgent as any)?.options?.timeout === 'number' &&
+      minAgentTimeout > ((httpAgent as any).options.timeout ?? 0)
+    ) {
       // Allow any given request to bump our agent active socket timeout.
       // This may seem strange, but leaking active sockets should be rare and not particularly problematic,
       // and without mutating agent we would need to create more of them.

src/index.ts

@@ -90,7 +90,7 @@ export class OpenAI extends Core.APIClient {
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Error(
-        'The OPENAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the OpenAI client with an apiKey option, like new OpenAI({ apiKey: undefined }).',
+        "The OPENAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the OpenAI client with an apiKey option, like new OpenAI({ apiKey: 'my apiKey' }).",
       );
     }
 
@@ -109,7 +109,7 @@ export class OpenAI extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
-      timeout: options.timeout ?? 600000,
+      timeout: options.timeout ?? 600000 /* 10 minutes */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
       fetch: options.fetch,

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.0.0-beta.11';
+export const VERSION = '4.0.0-beta.12';