GPTvsGPT 项目使用教程
1. 项目的目录结构及介绍
GPTvsGPT/
├── LICENSE
├── README.md
├── main.py
└── requirements.txt
- LICENSE: 项目许可证文件,本项目使用 MIT 许可证。
- README.md: 项目说明文件,包含项目的基本介绍和使用方法。
- main.py: 项目的启动文件,包含主要的逻辑代码。
- requirements.txt: 项目依赖文件,列出了运行项目所需的 Python 包。
2. 项目的启动文件介绍
main.py 是项目的启动文件,主要功能是模拟两个 AI 助手之间的对话。以下是文件的主要内容和功能介绍:
import os
import openai
# 设置 OpenAI API 密钥
openai.api_key = os.getenv("OPENAI_API_KEY")
# 定义助手参数
assistant_1_params = {
'name': "Assistant 1",
'instructions': "You are a helpful assistant.",
'tools': [],
'model': "gpt-3.5-turbo-1106"
}
assistant_2_params = {
'name': "Assistant 2",
'instructions': "You are a sarcastic assistant.",
'tools': [],
'model': "gpt-3.5-turbo-1106"
}
# 定义对话函数
def converse(assistant_1, assistant_2, topic, num_messages):
# 实现对话逻辑
pass
# 示例使用
converse(assistant_1_params, assistant_2_params, "global warming", 5)
- 导入模块: 导入了
os
和openai
模块。 - 设置 API 密钥: 从环境变量中获取 OpenAI API 密钥。
- 定义助手参数: 定义了两个助手的参数,包括名称、指令和模型。
- 定义对话函数: 定义了一个
converse
函数,用于模拟两个助手之间的对话。 - 示例使用: 调用
converse
函数进行示例对话。
3. 项目的配置文件介绍
requirements.txt 是项目的配置文件,列出了运行项目所需的 Python 包。以下是文件内容:
openai
- openai: 需要安装
openai
包以使用 OpenAI API。
4. 环境变量设置
在运行项目之前,需要设置 OpenAI API 密钥作为环境变量。可以通过以下命令设置:
export OPENAI_API_KEY='your_api_key_here'
5. 运行项目
在设置好环境变量后,可以通过以下命令运行项目:
python main.py
通过以上步骤,您可以成功运行并使用 GPTvsGPT 项目。