🌿 Agentarium

Agentarium 是一个强大的 Python 框架，旨在轻松管理和编排 AI Agent。它提供了一种灵活且直观的方式，用于在各种环境中创建、管理和协调多个 AI Agent 之间的交互。

安装 • 快速开始 • 特性 • 示例 • 文档 • 贡献

🚀 安装

pip install agentarium

🎯 快速开始

from agentarium import Agent

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

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

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

✨ 特性

• 🤖 高级 Agent 管理：创建并编排多个具有不同角色和能力的 AI Agent。
• 🔄 自主决策：Agent 可以根据上下文做出决策并采取行动。
• 💾 Checkpoint 系统：保存并恢复 Agent 的状态与交互，以实现可重现性。
• 🎭 可定制的动作：定义超出默认“对话/思考”能力之外的自定义动作。
• 🧠 记忆与上下文：Agent 会保留过往交互的记忆，以生成符合上下文的回复。
• ⚡ AI 集成：通过 aisuite 无缝集成各种 AI 提供商。
• ⚡ 性能优化：专为高效和可扩展性而构建。
• 🛠️ 可扩展架构：易于扩展和自定义，满足您的特定需求。

📚 示例

基础聊天示例

在 Agent 之间创建一个简单的聊天互动：

from agentarium import Agent

# 创建具有特定特征的 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()

添加自定义动作

为您的 Agent 增加新功能：

from agentarium import Agent, Action

# 定义一个简单的问候动作
def greet(name: str, **kwargs) -> str:
    return f"Hello, {name}!"

# 创建一个 Agent 并添加问候动作
agent = Agent.create_agent(name="Alice")
agent.add_action(
    Action(
        name="GREET",
        description="Greet someone by name",
        parameters=["name"],
        function=greet
    )
)

# 使用自定义动作
agent.execute_action("GREET", "Bob")

使用 Checkpoint

保存并恢复 Agent 状态：

from agentarium import Agent
from agentarium.CheckpointManager import CheckpointManager

# 初始化 Checkpoint 管理器
checkpoint = CheckpointManager("demo")

# 创建 Agent 并进行互动
alice = Agent.create_agent(name="Alice")
bob = Agent.create_agent(name="Bob")

alice.talk_to(bob, "What a beautiful day!")
checkpoint.update(step="interaction_1")

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

更多示例请参考 examples/ 目录。

📖 文档

Agent 创建

创建具有自定义特征的 Agent：

agent = Agent.create_agent(
    name="Alice",
    age=28,
    occupation="Software Engineer",
    location="San Francisco",
    bio="A passionate developer who loves AI"
)

LLM 配置

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

llm:
  provider: "openai"  # 使用的 LLM 提供商（任何 aisuite 支持的提供商）
  model: "gpt-4"      # 从提供商处使用的特定模型

aisuite:              # (可选) aisuite 的凭据
  openai:            # 特定提供商的配置
    api_key: "sk-..."  # 您的 API key

核心组件

• Agent：用于创建具有个性和自主行为的 AI Agent 的核心类。
• CheckpointManager：处理 Agent 状态和交互的保存与加载。
• Action：定义自定义 Agent 动作的基类。
• AgentInteractionManager：管理并追踪所有 Agent 之间的交互。

🤝 贡献

欢迎参与贡献！您可以按以下步骤操作：

1. Fork 本仓库
2. 创建一个新的分支 (git checkout -b feature/amazing-feature)
3. 做出您的更改
4. 提交您的更改 (git commit -m 'feat: add amazing feature')
5. 推送到分支 (git push origin feature/amazing-feature)
6. 提交 Pull Request

📄 许可证

本项目采用 Apache 2.0 许可证 - 详见 LICENSE 文件。

🙏 致谢

感谢所有为本项目做出贡献的人。