CoI-Agent 项目使用与配置指南

CoI-Agent 项目使用与配置指南

CoI-Agent Official code for paper: Chain of Ideas: Revolutionizing Research via Novel Idea Development with LLM Agents 项目地址: https://gitcode.com/gh_mirrors/co/CoI-Agent

1. 项目目录结构及介绍

CoI-Agent 项目目录结构如下：

CoI-Agent/
├── assets/                   # 存放静态资源
├── dataset/                  # 评价数据和相关结果
├── prompts/                  # 提示文件
├── searcher/                 # 搜索模块
├── .DS_Store
├── LICENSE                   # 开源协议文件
├── LLM.py                    # 语言模型模块
├── README.md                 # 项目说明文件
├── __init__.py               # 初始化文件
├── agents.py                 # 代理模块
├── config.yaml               # 配置文件
├── main.py                   # 主程序文件
├── requirements.txt          # 项目依赖文件
└── utils.py                  # 工具模块

• assets/: 存放项目的静态资源。
• dataset/: 包含评价数据以及CoI生成的结果。
• prompts/: 存放提示文件，用于与语言模型交互。
• searcher/: 实现搜索功能的模块。
• .DS_Store: Mac系统下的目录存储文件，可忽略。
• LICENSE: Apache-2.0 协议，项目的开源协议。
• LLM.py: 实现语言模型的类。
• README.md: 项目说明文件，介绍了项目的相关信息和使用方法。
• __init__.py: Python 包初始化文件。
• agents.py: 定义项目中使用的代理。
• config.yaml: 项目的配置文件。
• main.py: 项目的主程序文件，用于启动和运行整个项目。
• requirements.txt: 项目依赖的Python库列表。
• utils.py: 存放项目中通用的工具函数。

2. 项目的启动文件介绍

项目的启动文件是 main.py，该文件负责初始化配置、加载模型、处理用户输入，并启动整个CoI-Agent系统。以下是 main.py 的主要功能：

• 加载配置文件：读取 config.yaml 中的配置信息。
• 初始化模型：根据配置信息，初始化语言模型。
• 处理输入：接收用户输入的研究主题。
• 生成想法：使用语言模型生成新的研究想法。

3. 项目的配置文件介绍

项目的配置文件是 config.yaml，它包含了项目运行时所需的所有配置信息。以下是 config.yaml 的主要配置项：

• SEMENTIC_SEARCH_API_KEY: 用于语义搜索的API密钥。
• is_azure: 是否使用Azure的OpenAI服务。
• AZURE_OPENAI_ENDPOINT: Azure OpenAI服务的终端地址。
• AZURE_OPENAI_KEY: Azure OpenAI服务的访问密钥。
• AZURE_OPENAI_API_VERSION: Azure OpenAI服务的API版本。
• OPENAI_API_KEY: OpenAI服务的访问密钥。
• OPENAI_BASE_URL: OpenAI服务的基础URL。
• EMBEDDING_API_KEY: 嵌入向量API的访问密钥。
• EMBEDDING_API_ENDPOINT: 嵌入向量API的终端地址。
• EMBEDDING_MODEL: 使用的嵌入向量模型。
• MAIN_LLM_MODEL: 主语言模型。
• CHEAP_LLM_MODEL: 经济型语言模型。

在运行项目之前，需要根据实际情况填写或修改这些配置项。

CoI-Agent Official code for paper: Chain of Ideas: Revolutionizing Research via Novel Idea Development with LLM Agents 项目地址: https://gitcode.com/gh_mirrors/co/CoI-Agent