AgentForge

AgentForge 是一个低代码框架，用于快速开发、测试和迭代由 AI 驱动的自主智能体及认知架构。其核心概念——灵活的 智能体、声明式的 组件 和集成的 记忆——使得用户能够以最少的代码实现简单的智能体应用，同时也能构建复杂的多智能体协同系统。

AgentForge 兼容多种大语言模型，包括 OpenAI、Google 的 Gemini、Anthropic 的 Claude，以及通过 Ollama 或 LMStudio 运行的本地模型。这使您可以根据需要为不同的智能体选择不同的模型。

无论您是 AI 智能体领域的初学者，还是正在构建先进的认知系统，AgentForge 都能为您提供工具，帮助您打造智能化、模型无关且数据库兼容性强的自主智能体。

---

目录

1. 功能特性
2. 文档
3. 贡献
4. 联系我们
5. 许可证

---

功能特性

使用以下功能构建智能体和认知架构（多智能体系统）：

• 声明式组件：通过简单的 YAML 文件编排多智能体工作流、分支逻辑和记忆。组件是将智能体组合成复杂、可重用工作流的主要方式。
• 可定制智能体：使用 YAML 提示模板和配置定义智能体。
• 集成记忆：为智能体和组件添加上下文记忆，实现连贯、具备情境感知能力的交互。记忆节点在组件中声明，并自动提供给智能体使用。
• 角色设定：利用角色 YAML 文件配置智能体的身份、风格和背景信息。
• 动态提示模板：使用可根据不同情境和记忆内容自适应的灵活提示模板。
• 模型无关性：可根据需求为不同智能体选用不同的大语言模型。
• 实时提示编辑：无需重启系统即可实时修改提示。
• OpenAI、Google 和 Anthropic API 支持：与主流大语言模型 API 集成。
• 开源模型支持：通过 Ollama 和 LMStudio 利用本地模型。

注意：从本版本开始，动作和工具已被弃用，未来版本将采用基于 MCP 标准的新系统替代。

---

文档

全面的文档可以帮助您快速上手并深入学习：

入门指南

• 安装指南：逐步指导您安装 AgentForge。
• 使用 AgentForge：通过示例学习如何运行智能体、创建自定义智能体以及构建认知架构。
• 先决条件指南：详细说明所有安装前的要求和依赖项。
• 故障排除指南：提供常见问题及特定平台问题的解决方案。

核心概念

• 智能体：创建并定制用于各种任务的单个 AI 智能体。
• 组件：使用 YAML 配置设计具有分支逻辑和记忆的多智能体工作流。组件是 AgentForge 中构建和运行多智能体系统的主要方式。
• 记忆：为您的智能体和组件添加上下文记忆，以实现更连贯、更具情境感知能力的交互。记忆以声明式方式在组件中管理，并可在智能体提示中访问。
• API 集成：了解 AgentForge 如何与各类大型语言模型 API 连接。
• 角色设定：使用角色设定封装智能体的身份、风格和可重用知识。
• 设置：配置模型、存储和系统行为。
• 存储：AgentForge 使用 ChromaDB 作为其向量存储实现来管理记忆。
• 工具与动作：已弃用——将在未来版本中被基于 MCP 的系统取代。
• 实用工具：探索增强系统功能的实用函数和工具。

---

贡献

我们欢迎包含改进或错误修复的问题和拉取请求！

特别说明

我们正在寻找一位对开源充满热情的 UI/UX 合作者，协助我们为 AgentForge 开发前端界面。需要明确的是，这不是一份有偿职位或正式工作；我们只是两位后端开发者，希望与有兴趣贡献前端技能的人合作，共同为项目付出努力并相互学习。如果您有意参与合作，请参阅下方的 联系我们。

---

联系我们

• 邮箱：contact@agentforge.net
• Discord：加入我们的 Discord 服务器

---

许可证

本项目采用 GNU 通用公共许可证 v3.0 许可。更多详情请参阅 LICENSE。

AgentForge 快速上手指南

AgentForge 是一个低代码框架，旨在快速开发、测试和迭代 AI 驱动的自主代理（Agents）及认知架构。它支持通过 YAML 文件声明式地编排多代理工作流，并兼容 OpenAI、Google Gemini、Anthropic Claude 以及本地模型（Ollama/LMStudio）。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux、macOS 或 Windows
• Python 版本：必须为 Python 3.11
• 包管理工具：pip (通常随 Python 安装)
• API 密钥：根据您选择的模型提供商（如 OpenAI, Anthropic 等），需提前准备好对应的 API Key。若使用本地模型，请先安装并运行 Ollama 或 LMStudio。

提示：国内开发者建议使用国内镜像源加速 Python 包下载，例如清华源或阿里源。

安装步骤

1. 创建虚拟环境（推荐）

为避免依赖冲突，建议先创建一个独立的虚拟环境：

python3.11 -m venv agentforge-env
source agentforge-env/bin/activate  # Linux/macOS
# agentforge-env\Scripts\activate   # Windows

2. 安装 AgentForge

使用 pip 进行安装。国内用户可添加 -i 参数指定镜像源以加快下载速度：

# 使用默认源
pip install agentforge

# 或使用清华大学镜像源（推荐国内用户）
pip install agentforge -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 验证安装

安装完成后，检查版本以确保安装成功：

python -c "import agentforge; print(agentforge.__version__)"

基本使用

AgentForge 的核心在于通过 YAML 配置文件定义代理（Agents）、角色（Personas）和认知模块（Cogs）。以下是一个最简化的使用流程示例。

1. 配置项目结构

在项目根目录下，通常需要建立以下目录结构来存放配置文件：

my_project/
├── agents/       # 存放代理配置
├── personas/     # 存放角色设定
├── cogs/         # 存放工作流编排
└── settings.yaml # 全局设置（配置 API Key 和模型）

2. 配置全局设置 (settings.yaml)

编辑 settings.yaml 文件，配置您的 LLM 提供商和 API 密钥：

llm:
  default_provider: openai  # 可选：openai, anthropic, google, ollama
  api_key: "sk-your-api-key-here"
  
# 如果使用本地 Ollama 模型
# llm:
#   default_provider: ollama
#   model_name: llama3

3. 定义一个简单代理 (agents/simple_agent.yaml)

创建一个简单的代理配置文件，定义其提示词模板：

name: SimpleAssistant
description: A basic helpful assistant
prompt_template: |
  You are a helpful assistant named {{ persona.name }}.
  Current context: {{ memory.context }}
  
  User: {{ input }}
  Assistant:

4. 定义角色 (personas/helper.yaml)

为代理赋予特定的身份和风格：

name: HelperBot
style: Friendly and concise
background: An AI assistant designed to help with coding tasks.

5. 运行代理

配置完成后，您可以通过 Python 脚本加载并运行代理。以下是一个基础的运行示例代码：

from agentforge.agents import Agent
from agentforge.personas import Persona
from agentforge.memory import Memory

# 初始化组件
persona = Persona.load("helper")
agent = Agent.load("simple_agent", persona=persona)
memory = Memory()

# 添加上下文记忆（可选）
memory.add_context("User is learning Python.")

# 运行代理
response = agent.run(input="How do I start a list in Python?", memory=memory)

print(response)

6. 进阶：使用 Cogs 编排工作流

对于多代理协作，您可以使用 Cogs（YAML 文件）来定义复杂的分支逻辑和记忆流转，无需编写额外代码。只需在 cogs/ 目录下定义流程，然后通过框架指令执行即可实现多代理协同任务。

---

更多详细的高级用法、自定义记忆节点及多代理编排示例，请参考官方文档中的 Using AgentForge 章节。