openai-quickstart-node

OpenAI Quickstart - Node.js 项目介绍

项目概述

openai-quickstart-node 是一个旨在帮助用户快速上手 OpenAI API 的示例聊天应用程序。该项目使用了 Chat Completions API，旨在创建一个通用的流式聊天应用程序，并提供用户界面，可以直观地展示消息的流动方式。这个项目非常适合希望探索 OpenAI 技术并将其整合到自己应用程序中的开发者。

基本请求

为了发送第一个 API 请求，用户需要确保已经安装了 OpenAI Node SDK 的相关依赖。以下是一个简单的示例代码，展示了如何通过 OpenAI Node SDK 与 OpenAI API 进行交互：

import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const completion = await openai.chat.completions.create({
    messages: [{ role: "system", content: "You are a helpful assistant." }],
    model: "gpt-3.5-turbo",
  });

  console.log(completion.choices[0]);
}

main();

这一快速入门应用基于上面的基础代码，增加了流式传输和用户界面以可视化显示消息的功能。

项目设置

要运行这个项目，用户需要完成以下步骤：

安装 Node.js
如果系统尚未安装 Node.js，用户需要从 nodejs.org 下载并安装。要求 Node.js 版本不低于 16.0.0。
克隆项目仓库
使用 Git 命令将存储库克隆到本地：
```
$ git clone <repository_url>
```
进入项目目录
在终端中导航到克隆的项目目录：
```
$ cd openai-quickstart-node
```
安装项目依赖
使用 npm 安装所需的依赖包：
```
$ npm install
```
配置环境变量
将示例环境变量文件复制为新文件：
- 在 Linux 系统：
```
$ cp .env.example .env
```
- 在 Windows 系统：
```
$ copy .env.example .env
```
添加 API 密钥
将用户的 API 密钥添加到新创建的 .env 文件中。
运行应用程序
启动应用：
```
$ npm run dev
```