AutoAgents 项目教程
1. 项目目录结构及介绍
AutoAgents 项目的目录结构如下:
AutoAgents/
├── config/
│ ├── config.yaml
│ └── key.yaml
├── docker/
│ └── Dockerfile
├── docs/
├── frontend/
│ └── app/
├── .gitignore
├── .gitpod.yml
├── LICENSE
├── README.md
├── common.py
├── main.py
├── requirements.txt
├── setup.py
├── startup.py
└── ws_service.py
目录介绍
- config/: 包含项目的配置文件,如
config.yaml
和key.yaml
。 - docker/: 包含 Docker 相关的文件,如
Dockerfile
。 - docs/: 包含项目的文档文件。
- frontend/app/: 包含前端应用的文件。
- .gitignore: Git 忽略文件列表。
- .gitpod.yml: Gitpod 配置文件。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍和使用说明。
- common.py: 公共模块文件。
- main.py: 项目启动文件。
- requirements.txt: 项目依赖文件。
- setup.py: 项目安装脚本。
- startup.py: 项目启动脚本。
- ws_service.py: WebSocket 服务文件。
2. 项目启动文件介绍
main.py
main.py
是 AutoAgents 项目的启动文件。它支持两种启动模式:
- 命令行模式: 通过命令行参数启动项目。
- WebSocket 服务模式: 启动 WebSocket 服务。
命令行模式
python main.py --mode commandline --llm_api_key YOUR_OPENAI_API_KEY --serpapi_key YOUR_SERPAPI_KEY --idea "Is LK-99 really a room temperature superconducting material"
WebSocket 服务模式
python main.py --mode service --host "127.0.0.1" --port 9000
3. 项目的配置文件介绍
config/config.yaml
和 config/key.yaml
config.yaml
和 key.yaml
是项目的配置文件。key.yaml
是 config.yaml
的副本,用于存储敏感信息,如 API 密钥。
配置文件优先级
config/key.yaml
config/config.yaml
- 环境变量
配置示例
# config/key.yaml
OPENAI_API_KEY: "sk-..."
OPENAI_API_BASE: "https://<YOUR_SITE>/v1"
# 环境变量
export OPENAI_API_KEY="sk-..."
export OPENAI_API_BASE="https://<YOUR_SITE>/v1"
通过以上配置,您可以灵活地管理项目的 API 密钥和其他配置项。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考