OpenAI or Azure OpenAI API key not found (Cannot set apiKey - ENV works fine)

[scottforte]

Checked other resources

• I added a very descriptive title to this issue.
• I searched the LangChain.js documentation with the integrated search.
• I used the GitHub search to find a similar question and didn't find it.
• I am sure that this is a bug in LangChain.js rather than my code.
• The bug is not resolved by updating to the latest stable version of LangChain (or the specific integration package).

Example Code

const { OpenAI } = require("@langchain/openai");

// WORKS FINE
new OpenAI({
  model,
  temperature,
});

// FAILS
new OpenAI({
  model,
  temperature,
  apiKey: `same exact key - ENV removed - yes, confirmed it's there in the code via console before calling`,
});

Error Message and Stack Trace (if applicable)

Error: OpenAI or Azure OpenAI API key not found\n' +
' at new OpenAIChat ([redacted]\node_modules\@langchain\openai\dist\legacy.cjs:235:19)\n' +
' at new OpenAI ([redacted]\node_modules\@langchain\openai\dist\llms.cjs:79:20)\n' +

rest redacted

Description

Setting the ENV: OPENAI_API_KEY the creating an model works fine, but passing a string fails.

This is only for new OpenAI()

new OpenAIEmbeddings() works fine to pass an apiKey string in

System Info

Windows
NPM 10.5.0
Node v20.12.2

[scottforte]

Problem is here:
\node_modules@langchain\openai\dist\legacy.cjs:230

fields?.openAIApiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
should be: fields?.apiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");

PR: #5714

[dosubot]

Hey there, @scottforte! I'm here to help you with any bugs, questions, or contributions while we wait for a human maintainer. Let's tackle this together!

The issue you're encountering is due to the OpenAI class constructor not correctly handling the apiKey parameter. The constructor currently checks for fields?.openAIApiKey instead of fields?.apiKey.

The proposed change in PR #5714 addresses this by modifying the line in legacy.ts to correctly check for fields?.apiKey:

- fields?.openAIApiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+ fields?.apiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");

This change ensures that the apiKey parameter passed directly in the code is correctly recognized and used by the OpenAI class, resolving the issue where setting the API key directly in the code fails while using environment variables works fine.

To continue talking to Dosu, mention @dosu.

[jacoblee93]

Merged a fix in #5714, but also these are legacy classes that generally shouldn't be used. Have also updated docs to better reflect this.