🌿 Agentarium

🚀 安装

pip install agentarium

🎯 快速入门

from agentarium import Agent

# 创建代理
agent1 = Agent(name="agent1")
agent2 = Agent(name="agent2")

# 代理之间的直接通信
alice.talk_to(bob, "你好 Bob！我听说你在做一些有趣的机器学习项目。")

# 代理根据上下文自主决定下一步行动
bob.act()

✨ 特性

• 🤖 高级代理管理：创建并编排具有不同角色和能力的多个 AI 代理
• 🔄 自主决策：代理可以根据其上下文做出决策并采取行动
• 💾 检查点系统：保存和恢复代理状态及交互，以实现可重复性
• 🎭 可自定义行为：定义超出默认“说话/思考”能力的自定义行为
• 🧠 记忆与上下文：代理会保留过去交互的记忆，以便进行情境化的响应
• ⚡ AI 集成：通过 aisuite 与各种 AI 提供商无缝集成
• ⚡ 性能优化：专为高效性和可扩展性而设计
• 🛠️ 可扩展架构：易于扩展和定制，以满足您的特定需求

📚 示例

基本聊天示例

创建代理之间的简单聊天交互：

from agentarium import Agent

# 创建具有特定特征的代理
alice = Agent.create_agent(name="Alice", occupation="软件工程师")
bob = Agent.create_agent(name="Bob", occupation="数据科学家")

# 直接沟通
alice.talk_to(bob, "你好 Bob！我听说你在做一些有趣的项目。")

# 让 Bob 自主决定如何回应
bob.act()

添加自定义行为

为您的代理添加新能力：

from agentarium import Agent, Action

# 定义一个简单的问候行为
def greet(name: str, **kwargs) -> str:
    return f"你好，{name}！"

# 创建代理并添加问候行为
agent = Agent.create_agent(name="Alice")
agent.add_action(
    Action(
        name="GREET",
        description="向某人问好",
        parameters=["name"],
        function=greet
    )
)

# 使用自定义行为
agent.execute_action("GREET", "Bob")

使用检查点

保存和恢复代理状态：

from agentarium import Agent
from agentarium.CheckpointManager import CheckpointManager

# 初始化检查点管理器
checkpoint = CheckpointManager("demo")

# 创建并让代理互动
alice = Agent.create_agent(name="Alice")
bob = Agent.create_agent(name="Bob")

alice.talk_to(bob, "今天天气真好！")
checkpoint.update(step="interaction_1")

# 保存当前状态
checkpoint.save()

更多示例可在 examples/ 目录中找到。

📖 文档

代理创建

创建具有自定义特征的代理：

agent = Agent.create_agent(
    name="Alice",
    age=28,
    occupation="软件工程师",
    location="旧金山",
    bio="一位热爱 AI 的热情开发者"
)

LLM 配置

使用 YAML 文件配置您的 LLM 提供商及其凭据：

llm:
  provider: "openai"  # 要使用的 LLM 提供商（aisuite 支持的任何提供商）
  model: "gpt-4"      # 提供商提供的具体模型

aisuite:              # （可选）aisuite 的凭据
  openai:            # 提供商特定的配置
    api_key: "sk-..."  # 您的 API 密钥

关键组件

• Agent：用于创建具有个性和自主行为的 AI 代理的核心类
• CheckpointManager：负责保存和加载代理状态及交互
• Action：用于定义自定义代理行为的基类
• AgentInteractionManager：管理和跟踪所有代理交互

🤝 贡献

欢迎贡献！您可以这样帮助我们：

1. 分支仓库
2. 创建新分支 (git checkout -b feature/amazing-feature)
3. 进行更改
4. 提交更改 (git commit -m 'feat: add amazing feature')
5. 推送到分支 (git push origin feature/amazing-feature)
6. 打开拉取请求

📄 许可证

本项目采用 Apache 2.0 许可证授权——详情请参阅 LICENSE 文件。

🙏 致谢

感谢所有帮助塑造 Agentarium 的贡献者 🫶

Agentarium 快速上手指南

Agentarium 是一个强大的 Python 框架，旨在轻松管理和编排多个 AI 智能体（Agents）。它提供了灵活且直观的方式来创建、管理并协调不同环境下多个智能体之间的交互。

环境准备

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

• 操作系统：Linux, macOS 或 Windows
• Python 版本：3.10 或更高版本
• 依赖管理：建议使用 pip 或虚拟环境工具（如 venv 或 conda）

安装步骤

您可以通过 PyPI 直接安装 Agentarium：

pip install agentarium

提示：如果您在中国大陆地区，建议使用国内镜像源以加速下载：

pip install agentarium -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下是创建一个简单智能体交互场景的最小化示例：

1. 创建智能体并建立对话

from agentarium import Agent

# 创建具有特定角色的智能体
alice = Agent.create_agent(name="Alice", occupation="Software Engineer")
bob = Agent.create_agent(name="Bob", occupation="Data Scientist")

# 直接通信
alice.talk_to(bob, "Hello Bob! I heard you're working on some interesting projects.")

# 让 Bob 根据上下文自主决定如何回应
bob.act()

2. 配置 LLM（可选）

若需指定大模型提供商（如 OpenAI），请在项目根目录创建配置文件（例如 config.yaml）：

llm:
  provider: "openai"
  model: "gpt-4"

aisuite:
  openai:
    api_key: "sk-..."  # 替换为您的真实 API Key

Agentarium 将自动读取该配置以驱动智能体的决策与生成能力。