[Fixed] OpenAI API error: "Module 'openai' has no exported member 'Configuration'" – Javascript

The Problem:

In a Node.js application, attempting to import the ‘Configuration’ and ‘OpenAIApi’ classes from the ‘openai’ module results in an error stating "Module ‘openai’ has no exported member ‘Configuration’/’OpenAIApi’". The goal is to utilize the OpenAI API for handling conversation routes, but the API calls fail due to these missing exported members.

The Solutions:

Solution 1: Automatic migration

• Automatic migration CLI command:
  • Run npm exec openai migrate to easily migrate your code from v3 to v4.
  • Audit the changes afterward to ensure everything is working correctly.

Solution 2: Manual migration

Initialization

• Old (v3):

import { Configuration, OpenAIApi } from "openai";

const configuration = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);

• New (v4):

import OpenAI from "openai";

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

Creating a chat completion

• Old (v3):

const chatCompletion = await openai.createChatCompletion({
  model: "gpt-3.5-turbo",
  messages: [{ role: "user", content: "Hello world" }],
});
console.log(chatCompletion.data.choices[0].message);

• New (v4):

const chatCompletion = await openai.chat.completions.create({
  model: "gpt-3.5-turbo",
  messages: [{ "role": "user", "content": "Hello!" }],
});
console.log(chatCompletion.choices[0].message);

Creating a streaming chat completion (new)

• New (v4):

const stream = await openai.chat.completions.create({
  model: "gpt-3.5-turbo",
  messages: [{ "role": "user", "content": "Hello!" }],
  stream: true,
});
for await (const part of stream) {
  console.log(part.choices[0].delta); 
}

Creating a completion

• Old (v3):

const completion = await openai.createCompletion({
  model: "text-davinci-003",
  prompt: "This story begins",
  max_tokens: 30,
});
console.log(completion.data.choices[0].text);

• New (v4):

const completion = await openai.completions.create({
  model: "text-davinci-003",
  prompt: "This story begins",
  max_tokens: 30,
});
console.log(completion.choices[0].text);

Creating a transcription (Whisper)

• Old (v3):

const response = await openai.createTranscription(
  fs.createReadStream("audio.mp3"),
  "whisper-1"
);

• New (v4):

const response = await openai.audio.transcriptions.create({
  model: 'whisper-1',
  file: fs.createReadStream('audio.mp3'),
});

Creating a streaming completion (new)

• New (v4):

const stream = await openai.completions.create({
  model: "text-davinci-003",
  prompt: "This story begins",
  max_tokens: 30,
  stream: true,
});
for await (const part of stream) {
   console.log(part.choices[0]);
}

Error handling

• Old (v3):

try {
  const completion = await openai.createCompletion({...});
} catch (error) {
  if (error.response) {
    console.log(error.response.status); // e.g. 401
    console.log(error.response.data.message); // e.g. The authentication token you passed was invalid...
    console.log(error.response.data.code); // e.g. 'invalid_api_key'
    console.log(error.response.data.type); // e.g. 'invalid_request_error'
  } else {
    console.log(error);
  }
}

• New (v4):

try {
  const response = await openai.completions.create({...});
} catch (error) {
  if (error instanceof OpenAI.APIError) {
    console.error(error.status);  // e.g. 401
    console.error(error.message); // e.g. The authentication token you passed was invalid...
    console.error(error.code);  // e.g. 'invalid_api_key'
    console.error(error.type);  // e.g. 'invalid_request_error'
  } else {
    // Non-API error
    console.log(error);
  }
}

• Method name changes: Many method names have changed in v4. Refer to the provided table for the old and new names of each method.

• Removed methods: Several methods have been removed in v4. Check the list of removed methods to see if any of them are relevant to your code.

Solution 2: Migrate to `v4`

The OpenAI API you were using is `v3`, which has been deprecated. You need to migrate to `v4`. To do this, you need to use this code snippet:

import OpenAI from ‘openai’;

 const openai = new OpenAI({
    apiKey: 'my api key', // defaults to process.env["OPENAI_API_KEY"]
 });

Check out the migration guide here for more information on how to migrate from `v3` to `v4`.

Solution 3: Downgrading the OpenAI Package

If you’re using version 4 of the OpenAI Node.js library and your code expects the Configuration and OpenAIApi classes, which are no longer available in version 4, you can try downgrading to version 3 of the library. Here’s how:

1. Open your terminal or command prompt.
2. Navigate to the directory where your project is located.
3. Run the following command to uninstall the current version of the OpenAI library:

npm uninstall openai

4. Install version 3 of the OpenAI library:

npm install [email protected]

5. Ensure that you’re using the Configuration and OpenAIApi classes from the version 3 library. You can find the documentation for version 3 here.

After downgrading to version 3 of the OpenAI library, your code should recognize the Configuration and OpenAIApi classes, and the error you’re encountering should be resolved.

Solution 4: Check for Typographical Errors

It’s possible that a typographical error in the import statement is causing the issue. The error message mentions "Module ‘openai’ has no exported member ‘Configuration’", which suggests that something might be wrong with the import statement. Review the code and make sure that the import statement is correct, including the spelling of "openai" and "Configuration". Double-check the import statement, ensuring there are no extra characters, missing characters, or incorrect casing. Ensure that the import statement matches the exact spelling and capitalization as specified in the documentation provided by the library you are using.

Video Explanation: