II-Agent 项目启动与配置教程

1. 项目目录结构及介绍

II-Agent 项目的目录结构如下：

ii-agent/
├── assets/             # 静态资源文件
├── frontend/           # 前端代码目录
│   ├── node_modules/   # 前端依赖包
│   ├── public/         # 公共静态文件
│   └── src/            # 前端源代码
├── src/                # 核心逻辑目录
│   ├── ii_agent/       # II-Agent 核心实现
│   ├── agents/         # 代理实现
│   ├── llm/            # 语言模型客户端接口
│   ├── tools/          # 工具实现
│   └── utils/          # 工具函数
├── tests/              # 测试文件
├── .gitignore          # Git 忽略文件
├── .pre-commit-config.yaml  # pre-commit 配置文件
├── .python-version     # 指定 Python 版本
├── LICENSE             # 许可证文件
├── README.md           # 项目说明文件
├── cli.py              # 命令行接口
├── pyproject.toml      # Python 项目配置文件
├── run_gaia.py         # 运行 GAIA 测试的脚本
└── ws_server.py        # WebSocket 服务器脚本

• assets/：存放静态资源文件，如图片、视频等。
• frontend/：前端代码目录，包含了前端的所有代码和资源。
• src/：项目的核心逻辑目录，包含了代理的实现、语言模型的接口、工具的实现以及工具函数。
• tests/：测试代码目录，用于存放项目的单元测试和集成测试。
• .gitignore：配置 Git 忽略规则，避免将不必要的文件提交到版本控制。
• .pre-commit-config.yaml：pre-commit 配置文件，用于在提交代码前自动执行一些格式化操作。
• .python-version：指定项目所需的 Python 版本。
• LICENSE：项目的许可证文件，本项目采用 Apache-2.0 许可。
• README.md：项目说明文件，包含了项目的基本信息和使用说明。
• cli.py：命令行接口，用于通过命令行与 II-Agent 交互。
• pyproject.toml：Python 项目配置文件，定义了项目的依赖和构建过程。
• run_gaia.py：运行 GAIA 测试的脚本，用于评估 II-Agent 的性能。
• ws_server.py：WebSocket 服务器脚本，用于与前端进行通信。

2. 项目的启动文件介绍

项目的启动文件主要有两个：cli.py 和 ws_server.py。

• cli.py：命令行接口文件，用于启动命令行版本的 II-Agent。通过设置环境变量 ANTHROPIC_API_KEY 或 GOOGLE_APPLICATION_CREDENTIALS 来指定使用的 API 密钥，然后运行 python cli.py 来启动。

• ws_server.py：WebSocket 服务器文件，用于启动 WebSocket 服务器以便与前端进行通信。同样需要设置环境变量来指定 API 密钥，然后运行 python ws_server.py 来启动。

3. 项目的配置文件介绍

项目的配置文件主要包括 .env 文件和环境变量的设置。

• .env 文件：位于前端目录下，用于存放前端相关的环境变量，如 API URL 等。

• 环境变量：在项目根目录下创建一个 .env 文件，用于存放项目运行所需的环境变量。以下是一些示例环境变量：

  OPENAI_API_KEY=your_openai_key
  OPENAI_AZURE_ENDPOINT=your_azure_endpoint
  TAVILY_API_KEY=your_tavily_key
  JINA_API_KEY=your_jina_key
  FIRECRAWL_API_KEY=your_firecrawl_key
  SERPAPI_API_KEY=your_serpapi_key
  STATIC_FILE_BASE_URL=http://localhost:8000/
  ANTHROPIC_API_KEY=your_anthropic_key
  GOOGLE_APPLICATION_CREDENTIALS=your_google_credentials
  

确保在启动项目前设置好这些环境变量，以保证项目可以正确地访问到所需的 API 和资源。