refactor: use openai sdk apikey function handling

Author: sinedied

libs/providers/langchain-openai/src/chat_models/base.ts

@@ -42,7 +42,6 @@ import {
   type OpenAIApiKey,
 } from "../types.js";
 import { type OpenAIEndpointConfig, getEndpoint } from "../utils/azure.js";
-import { resolveOpenAIApiKey } from "../utils/client.js";
 import {
   type FunctionDef,
   formatFunctionDefinitions,
@@ -463,17 +462,12 @@ export abstract class BaseChatOpenAI<
     if (this.disableStreaming) this.streamUsage = false;
 
     const clientConfig: ClientOptions = {
+      apiKey: this.apiKey,
       dangerouslyAllowBrowser: true,
       ...fields?.configuration,
       organization: this.organization,
     };
 
-    if (typeof this.apiKey === "string") {
-      clientConfig.apiKey = this.apiKey;
-    } else {
-      clientConfig.apiKey = undefined;
-    }
-
     this.clientConfig = clientConfig;
 
     // If `supportsStrictToolCalling` is explicitly set, use that value.
@@ -555,7 +549,7 @@ export abstract class BaseChatOpenAI<
   protected async _getClientOptions(
     options: OpenAICoreRequestOptions | undefined
   ): Promise<OpenAICoreRequestOptions> {
-    const resolvedApiKey = await resolveOpenAIApiKey(this.apiKey);
+    const currentApiKey = this.apiKey ?? this.clientConfig.apiKey;
 
     if (!this.client) {
       const openAIEndpointConfig: OpenAIEndpointConfig = {
@@ -571,19 +565,21 @@ export abstract class BaseChatOpenAI<
         maxRetries: 0,
       };
 
-      if (resolvedApiKey !== undefined) {
-        params.apiKey = resolvedApiKey;
-      } else if (typeof this.clientConfig.apiKey === "string") {
-        params.apiKey = this.clientConfig.apiKey;
+      if (currentApiKey !== undefined) {
+        params.apiKey = currentApiKey;
       }
 
       if (!params.baseURL) {
         delete params.baseURL;
       }
 
       this.client = new OpenAIClient(params);
-    } else if (resolvedApiKey !== undefined) {
-      this.client.apiKey = resolvedApiKey;
+    } else if (currentApiKey !== undefined) {
+      if (typeof currentApiKey === "string") {
+        this.client.apiKey = currentApiKey;
+      } else {
+        this.client = this.client.withOptions({ apiKey: currentApiKey });
+      }
     }
 
     const requestOptions = {

libs/providers/langchain-openai/src/embeddings.ts

@@ -4,7 +4,7 @@ import { Embeddings, type EmbeddingsParams } from "@langchain/core/embeddings";
 import { chunkArray } from "@langchain/core/utils/chunk_array";
 import type { OpenAIApiKey } from "./types.js";
 import { getEndpoint, OpenAIEndpointConfig } from "./utils/azure.js";
-import { resolveOpenAIApiKey, wrapOpenAIClientError } from "./utils/client.js";
+import { wrapOpenAIClientError } from "./utils/client.js";
 
 /**
  * @see https://platform.openai.com/docs/guides/embeddings#embedding-models
@@ -149,10 +149,8 @@ export class OpenAIEmbeddings<TOutput = number[]>
       organization: this.organization,
     };
 
-    if (typeof apiKey === "string") {
+    if (apiKey !== undefined) {
       clientConfig.apiKey = apiKey;
-    } else {
-      clientConfig.apiKey = undefined;
     }
 
     this.clientConfig = clientConfig;
@@ -228,7 +226,7 @@ export class OpenAIEmbeddings<TOutput = number[]>
   protected async embeddingWithRetry(
     request: OpenAIClient.EmbeddingCreateParams
   ) {
-    const resolvedApiKey = await resolveOpenAIApiKey(this.apiKey);
+    const currentApiKey = this.apiKey ?? this.clientConfig.apiKey;
 
     if (!this.client) {
       const openAIEndpointConfig: OpenAIEndpointConfig = {
@@ -244,19 +242,21 @@ export class OpenAIEmbeddings<TOutput = number[]>
         maxRetries: 0,
       };
 
-      if (resolvedApiKey !== undefined) {
-        params.apiKey = resolvedApiKey;
-      } else if (typeof this.clientConfig.apiKey === "string") {
-        params.apiKey = this.clientConfig.apiKey;
+      if (currentApiKey !== undefined) {
+        params.apiKey = currentApiKey;
       }
 
       if (!params.baseURL) {
         delete params.baseURL;
       }
 
       this.client = new OpenAIClient(params);
-    } else if (resolvedApiKey !== undefined) {
-      this.client.apiKey = resolvedApiKey;
+    } else if (currentApiKey !== undefined) {
+      if (typeof currentApiKey === "string") {
+        this.client.apiKey = currentApiKey;
+      } else {
+        this.client = this.client.withOptions({ apiKey: currentApiKey });
+      }
     }
     const requestOptions = {};
 

libs/providers/langchain-openai/src/llms.ts

@@ -16,7 +16,7 @@ import type {
   OpenAIInput,
 } from "./types.js";
 import { OpenAIEndpointConfig, getEndpoint } from "./utils/azure.js";
-import { resolveOpenAIApiKey, wrapOpenAIClientError } from "./utils/client.js";
+import { wrapOpenAIClientError } from "./utils/client.js";
 
 export type { OpenAICallOptions, OpenAIInput };
 
@@ -198,10 +198,8 @@ export class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions>
       organization: this.organization,
     };
 
-    if (typeof this.apiKey === "string") {
+    if (this.apiKey !== undefined) {
       clientConfig.apiKey = this.apiKey;
-    } else {
-      clientConfig.apiKey = undefined;
     }
 
     this.clientConfig = clientConfig;
@@ -470,7 +468,7 @@ export class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions>
   protected async _getClientOptions(
     options: OpenAICoreRequestOptions | undefined
   ): Promise<OpenAICoreRequestOptions> {
-    const resolvedApiKey = await resolveOpenAIApiKey(this.apiKey);
+    const currentApiKey = this.apiKey ?? this.clientConfig.apiKey;
 
     if (!this.client) {
       const openAIEndpointConfig: OpenAIEndpointConfig = {
@@ -486,19 +484,17 @@ export class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions>
         maxRetries: 0,
       };
 
-      if (resolvedApiKey !== undefined) {
-        params.apiKey = resolvedApiKey;
-      } else if (typeof this.clientConfig.apiKey === "string") {
-        params.apiKey = this.clientConfig.apiKey;
+      if (currentApiKey !== undefined) {
+        params.apiKey = currentApiKey;
       }
 
       if (!params.baseURL) {
         delete params.baseURL;
       }
 
       this.client = new OpenAIClient(params);
-    } else if (resolvedApiKey !== undefined) {
-      this.client.apiKey = resolvedApiKey;
+    } else if (currentApiKey !== undefined) {
+      this.client = this.client.withOptions({ apiKey: currentApiKey });
     }
 
     const requestOptions = {

libs/providers/langchain-openai/src/types.ts

@@ -1,4 +1,4 @@
-import type { OpenAI as OpenAIClient } from "openai";
+import type { OpenAI as OpenAIClient, ClientOptions } from "openai";
 import type {
   ResponseFormatText,
   ResponseFormatJSONObject,
@@ -24,7 +24,7 @@ export type OpenAIChatModelId =
 
 export type OpenAIVerbosityParam = "low" | "medium" | "high" | null;
 
-export type OpenAIApiKey = string | (() => string | Promise<string>);
+export type OpenAIApiKey = ClientOptions["apiKey"];
 
 export declare interface OpenAIBaseInput {
   /** Sampling temperature to use */

libs/providers/langchain-openai/src/utils/client.ts

@@ -1,23 +1,6 @@
 import { APIConnectionTimeoutError, APIUserAbortError } from "openai";
-import type { OpenAIApiKey } from "../types.js";
 import { addLangChainErrorFields } from "./errors.js";
 
-export async function resolveOpenAIApiKey(
-  apiKey: OpenAIApiKey | undefined
-): Promise<string | undefined> {
-  if (typeof apiKey === "function") {
-    const value = await apiKey();
-    if (value == null || typeof value !== "string" || value.length === 0) {
-      throw new Error(
-        "OpenAI apiKey callback must resolve to a non-empty string value."
-      );
-    }
-    return value;
-  }
-
-  return apiKey;
-}
-
 export function wrapOpenAIClientError(e: unknown) {
   if (!e || typeof e !== "object") {
     return e;