项目介绍:ChatGPT-API Demo
简介
ChatGPT-API Demo 是一个基于 OpenAI GPT-3.5 Turbo API 的演示项目。它展示了如何使用 OpenAI 提供的强大自然语言处理功能。在项目的实时演示之前,由于 OpenAI API Key 的限制已经用尽,所以当前 demo 网站不可用。
关于 Anse
如果用户希望体验更多功能,如多聊天和图像生成,可以关注新推出的项目 Anse,该项目提供了更加丰富的功能集成。
如何在本地运行
要在本地启动 ChatGPT-API Demo,需要以下几个预备步骤:
- Node.js 环境:确保开发和部署环境使用的是
Node v18
或更高版本。 - PNPM 管理工具:推荐使用 PNPM 管理依赖。如果没有安装,可以使用 npm 安装。
- OPENAI_API_KEY:从 OpenAI 获取 API Key,用于访问 OpenAI 的服务。
步骤
- 安装项目依赖:
pnpm install
- 复制
.env.example
文件并重命名为.env
,然后将获得的 OpenAI API Key 添加到.env
文件中。 - 运行项目:
项目将在pnpm run dev
http://localhost:3000/
上运行。
项目部署
该项目可以通过多个平台进行部署,如 Vercel、Netlify、Docker 和 Sealos。
Vercel 部署
在 Vercel 上,用户可以通过简单的配置直接部署项目,并支持通过环境变量设定网站密码。
Netlify 部署
在 Netlify 上,用户可以通过 GitHub 连接项目,并通过界面配置环境变量等参数来完成部署。
Docker 部署
Docker 部署可以使用直接运行命令或 Docker Compose 文件进行部署,支持设置项目信息的环境变量。
Sealos 部署
Sealos 提供了简单的图形化界面,用户可以填写项目信息,快速部署应用程序。
环境变量说明
该项目支持多种环境变量来控制网站的行为:
OPENAI_API_KEY
:用于访问 OpenAI API 的个人密钥。HTTPS_PROXY
:为 OpenAI API 提供代理。OPENAI_API_BASE_URL
:OpenAI API 的自定义基础 URL。HEAD_SCRIPTS
:页面</head>
前插入的脚本。PUBLIC_SECRET_KEY
:用于项目的私密字符串。SITE_PASSWORD
:网站的访问密码。OPENAI_API_MODEL
:使用的模型 ID,默认是gpt-3.5-turbo
。
常见问题
- 无法连接到 OpenAI API:需要配置
HTTPS_PROXY
环境变量。 - Node 版本问题:Node 需要是 v18 或更高版本。
- 加速国内访问:可以参考相关教程不需要代理的部署方式。
贡献
该项目的存在依赖于所有参与贡献的人员,欢迎更多人加入项目的开发和完善。
许可协议
该项目由 MIT 许可协议授权。