chatbot-ui 介绍
了解项目的详细信息和使用方法
Chatbot UI
Chatbot UI 是一个用于 AI 模型的开源聊天界面。
查看 演示。
更新
Chatbot UI 将会不断更新。
请期待经常性的改进。
即将推出的功能:
- 分享
- "机器人"
部署
Vercel
使用 Vercel 主机部署 Chatbot UI 的实时版本。
Docker
在本地构建:
shell1docker build -t chatgpt-ui . 2docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 chatgpt-ui
从 ghcr 拉取:
docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 ghcr.io/mckaywrigley/chatbot-ui:main
本地运行
1. 克隆仓库
bash1git clone https://github.com/mckaywrigley/chatbot-ui.git
2. 安装依赖
bash1npm i
3. 提供 OpenAI API 密钥
在仓库根目录创建一个名为 .env.local
的文件,并将您的 OpenAI API 密钥添加进去:
bash1OPENAI_API_KEY=YOUR_KEY
您可以设置
OPENAI_API_HOST
,用于在无法访问官方 OpenAI 主机时,允许用户配置替代主机以满足其特定需求。
此外,如果您有多个 OpenAI 组织,您可以设置
OPENAI_ORGANIZATION
来指定其中一个。
4. 运行应用
bash1npm run dev
5. 使用
您应该可以开始聊天了。
配置
在部署应用程序时,可以设置以下环境变量:
环境变量 | 默认值 | 描述 |
---|---|---|
OPENAI_API_KEY | 用于与 OpenAI 进行身份验证的默认 API 密钥 | |
OPENAI_API_HOST | https://api.openai.com | 基本 URL,对于 Azure,请使用 https://<endpoint>.openai.azure.com |
OPENAI_API_TYPE | openai | API 类型,可选项为 openai 或 azure |
OPENAI_API_VERSION | 2023-03-15-preview | 仅适用于 Azure OpenAI |
AZURE_DEPLOYMENT_ID | Azure OpenAI 需要此参数,详见 Azure OpenAI API | |
OPENAI_ORGANIZATION | 您的 OpenAI 组织 ID | |
DEFAULT_MODEL | gpt-3.5-turbo | 在新对话中使用的默认模型,对于 Azure,请使用 gpt-35-turbo |
NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT | 见此处 | 在新对话中使用的默认系统提示 |
NEXT_PUBLIC_DEFAULT_TEMPERATURE | 1 | 在新对话中使用的默认温度 |
GOOGLE_API_KEY | 参见[Custom Search JSON API 文档][GCSE] | |
GOOGLE_CSE_ID | 参见[Custom Search JSON API 文档][GCSE] |
如果没有提供带有 OPENAI_API_KEY
的 OpenAI API 密钥,用户将需要提供自己的密钥。
如果您没有 OpenAI API 密钥,可以在这里获取。
联系方式
如果您有任何问题,请随时在 Twitter 上联系 Mckay。