feat(@langchain/openai): support callable function for apiKey (#9301)

Co-authored-by: Hunter Lovell <[email protected]>

Author: sinedied

.changeset/silly-buses-drum.md

@@ -0,0 +1,5 @@
+---
+"@langchain/openai": patch
+---
+
+support callable function for apiKey

libs/providers/langchain-openai/src/azure/chat_models/common.ts

@@ -1,4 +1,4 @@
-import { AzureOpenAI as AzureOpenAIClient } from "openai";
+import { AzureOpenAI as AzureOpenAIClient, type ClientOptions } from "openai";
 import { getEnv, getEnvironmentVariable } from "@langchain/core/utils/env";
 import type { Serialized } from "@langchain/core/load/serializable";
 import { ChatOpenAICallOptions } from "../../chat_models/index.js";
@@ -56,8 +56,10 @@ export function _constructAzureFields(
 ) {
   this.azureOpenAIApiKey =
     fields?.azureOpenAIApiKey ??
-    fields?.openAIApiKey ??
-    fields?.apiKey ??
+    (typeof fields?.openAIApiKey === "string"
+      ? fields?.openAIApiKey
+      : undefined) ??
+    (typeof fields?.apiKey === "string" ? fields?.apiKey : undefined) ??
     getEnvironmentVariable("AZURE_OPENAI_API_KEY");
 
   this.azureOpenAIApiInstanceName =
@@ -106,8 +108,9 @@ export function _getAzureClientOptions(
 
     const endpoint = getEndpoint(openAIEndpointConfig);
 
-    const params = {
-      ...this.clientConfig,
+    const { apiKey: existingApiKey, ...clientConfigRest } = this.clientConfig;
+    const params: Omit<ClientOptions, "apiKey"> & { apiKey?: string } = {
+      ...clientConfigRest,
       baseURL: endpoint,
       timeout: this.timeout,
       maxRetries: 0,

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

@@ -41,7 +41,7 @@ export class AzureOpenAIEmbeddings extends OpenAIEmbeddings {
     this.batchSize = fields?.batchSize ?? 1;
     this.azureOpenAIApiKey =
       fields?.azureOpenAIApiKey ??
-      fields?.apiKey ??
+      (typeof fields?.apiKey === "string" ? fields?.apiKey : undefined) ??
       getEnvironmentVariable("AZURE_OPENAI_API_KEY");
 
     this.azureOpenAIApiVersion =
@@ -81,8 +81,9 @@ export class AzureOpenAIEmbeddings extends OpenAIEmbeddings {
 
       const endpoint = getEndpoint(openAIEndpointConfig);
 
-      const params = {
-        ...this.clientConfig,
+      const { apiKey: existingApiKey, ...clientConfigRest } = this.clientConfig;
+      const params: Omit<ClientOptions, "apiKey"> & { apiKey?: string } = {
+        ...clientConfigRest,
         baseURL: endpoint,
         timeout: this.timeout,
         maxRetries: 0,

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

@@ -70,8 +70,10 @@ export class AzureOpenAI extends OpenAI {
 
     this.azureOpenAIApiKey =
       fields?.azureOpenAIApiKey ??
-      fields?.openAIApiKey ??
-      fields?.apiKey ??
+      (typeof fields?.openAIApiKey === "string"
+        ? fields?.openAIApiKey
+        : undefined) ??
+      (typeof fields?.apiKey === "string" ? fields?.apiKey : undefined) ??
       getEnvironmentVariable("AZURE_OPENAI_API_KEY");
 
     this.azureOpenAIApiInstanceName =
@@ -113,8 +115,9 @@ export class AzureOpenAI extends OpenAI {
 
       const endpoint = getEndpoint(openAIEndpointConfig);
 
-      const params = {
-        ...this.clientConfig,
+      const { apiKey: existingApiKey, ...clientConfigRest } = this.clientConfig;
+      const params: Omit<ClientOptions, "apiKey"> & { apiKey?: string } = {
+        ...clientConfigRest,
         baseURL: endpoint,
         timeout: this.timeout,
         maxRetries: 0,

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

@@ -40,6 +40,7 @@ import {
   type ChatOpenAIResponseFormat,
   ResponseFormatConfiguration,
   OpenAIVerbosityParam,
+  type OpenAIApiKey,
 } from "../types.js";
 import { type OpenAIEndpointConfig, getEndpoint } from "../utils/azure.js";
 import {
@@ -245,7 +246,7 @@ export abstract class BaseChatOpenAI<
 
   topLogprobs?: number;
 
-  apiKey?: string;
+  apiKey?: OpenAIApiKey;
 
   organization?: string;
 
@@ -420,7 +421,8 @@ export abstract class BaseChatOpenAI<
     super(fields ?? {});
 
     const configApiKey =
-      typeof fields?.configuration?.apiKey === "string"
+      typeof fields?.configuration?.apiKey === "string" ||
+      typeof fields?.configuration?.apiKey === "function"
         ? fields?.configuration?.apiKey
         : undefined;
     this.apiKey =

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

@@ -2,6 +2,7 @@ import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 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 { wrapOpenAIClientError } from "./utils/client.js";
 
@@ -102,16 +103,18 @@ export class OpenAIEmbeddings<TOutput = number[]>
 
   protected clientConfig: ClientOptions;
 
+  protected apiKey?: OpenAIApiKey;
+
   constructor(
     fields?: Partial<OpenAIEmbeddingsParams> & {
       verbose?: boolean;
       /**
        * The OpenAI API key to use.
        * Alias for `apiKey`.
        */
-      openAIApiKey?: string;
+      openAIApiKey?: OpenAIApiKey;
       /** The OpenAI API key to use. */
-      apiKey?: string;
+      apiKey?: OpenAIApiKey;
       configuration?: ClientOptions;
     }
   ) {

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

@@ -10,6 +10,7 @@ import {
 } from "@langchain/core/language_models/llms";
 import { chunkArray } from "@langchain/core/utils/chunk_array";
 import type {
+  OpenAIApiKey,
   OpenAICallOptions,
   OpenAICoreRequestOptions,
   OpenAIInput,
@@ -121,9 +122,9 @@ export class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions>
 
   streaming = false;
 
-  openAIApiKey?: string;
+  openAIApiKey?: OpenAIApiKey;
 
-  apiKey?: string;
+  apiKey?: OpenAIApiKey;
 
   organization?: string;
 

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,6 +24,8 @@ export type OpenAIChatModelId =
 
 export type OpenAIVerbosityParam = "low" | "medium" | "high" | null;
 
+export type OpenAIApiKey = ClientOptions["apiKey"];
+
 export declare interface OpenAIBaseInput {
   /** Sampling temperature to use */
   temperature: number;
@@ -103,12 +105,12 @@ export declare interface OpenAIBaseInput {
    * `OPENAI_API_KEY` environment variable.
    * Alias for `apiKey`
    */
-  openAIApiKey?: string;
+  openAIApiKey?: OpenAIApiKey;
   /**
    * API key to use when making requests to OpenAI. Defaults to the value of
    * `OPENAI_API_KEY` environment variable.
    */
-  apiKey?: string;
+  apiKey?: OpenAIApiKey;
 
   /**
    * The verbosity of the model's response.
@@ -285,7 +287,6 @@ export interface AzureOpenAIInput {
 export interface AzureOpenAIChatInput
   extends OpenAIChatInput,
     AzureOpenAIInput {
-  openAIApiKey?: string;
   openAIApiVersion?: string;
   openAIBasePath?: string;
   deploymentName?: string;