OpenAI SDK 前端入门探索

本文介绍了如何使用 OpenAI SDK 在 TypeScript 或 JavaScript 中访问 OpenAI REST API。

GitHub 仓库： openai-node

1. 安装

首先，你需要安装 OpenAI SDK。可以通过以下命令进行安装：

npm install openai

2. 使用说明

本库的完整 API 文档可以在 api.md 文件中找到，并且还提供了许多代码示例。以下代码演示了如何使用聊天完成 API。

示例代码

新建一个 index.ts 文件，内容如下：

// index.ts
import OpenAI from 'openai';

const OPENAI_API_KEY = '*****'; // 替换为你的 OpenAI API Key
const baseURL = 'https://api.chatanywhere.tech/v1'; // 替换为你的 API 地址
const model = 'gpt-4'; // 替换为你想使用的模型

const openai = new OpenAI({
  apiKey: OPENAI_API_KEY, // 默认参数，可以省略
  baseURL: baseURL
});

async function main() {
  const stream = await openai.beta.chat.completions.stream({
    model: model,
    messages: [{ role: 'user', content: '把"写给未来的我的一封信"翻译成英文' }],
    stream: true,
  });

  stream.on('content', (delta, snapshot) => {
    process.stdout.write(delta);
  });

  // 或者可以使用以下等效代码：
  // for await (const chunk of stream) {
  //   process.stdout.write(chunk.choices[0]?.delta?.content || '');
  // }

  const chatCompletion = await stream.finalChatCompletion();
  console.log(chatCompletion); // {id: "…", choices: […], …}
}

main();

获取 API Key

apiKey 是用于访问 OpenAI API 的凭证，可以在 OpenAI 官网 上申请获取。由于目前国内无法直接注册获取 API Key，你可以参考 知乎上的方法 获取免费的 API Key 进行测试。

关于 baseURL

上述示例中的 baseURL 来自 GPT_API_free 项目中的免费转发 Host1，注意需要在 URL 后加上 /v1。

3. 运行 index.ts 文件

你可以使用 ts-node 直接运行 TypeScript 文件。

1. 安装依赖

首先，确保你已经安装了 ts-node 和 typescript：

npm install -g ts-node typescript
# 或者本地安装（推荐）
npm install --save-dev ts-node typescript

2. 配置 tsconfig.json

确保你的 tsconfig.json 文件配置正确，示例如下：

{
  "compilerOptions": {
    "module": "CommonJS",  // Node.js 使用 CommonJS
    "target": "ES6",
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

3. 运行命令

使用以下命令运行 index.ts 文件：

npx ts-node index.ts

运行结果

运行成功后，你将在终端中看到输出结果如下：

---

通过以上步骤，你可以轻松地在 TypeScript 或 JavaScript 项目中使用 OpenAI SDK 进行开发。如果你有任何问题，可以参考 官方文档 或在社区中寻求帮助。