项目概述
Agency 是一个 Python 库,提供了一种用于创建集成代理系统的 Actor 模型框架。它通过简单易用的 API,使得用户能够灵活可扩展地将代理与传统软件系统连接,从而开发所需的任何架构。Agency 的目标是为开发者提供一个基础平台,用于创建自定义的代理应用程序,既可以作为实验探索的工具,也可作为拓展开发的基础。
特点
易于使用的 API
Agency 提供了基于类和方法的简单代理和动作定义,并具有详尽的最新文档和实用例子供参考,帮助用户快速上手。
性能与可扩展性
该库支持多进程和多线程的并发执行,同时支持 AMQP 协议,以实现网络化代理系统的功能扩展。
可观测性与控制
Agency 提供了动作和生命周期回调功能,以及访问策略和权限控制回调等机制,确保系统的安全和稳定。此外,还提供了详细的日志记录功能,便于开发者进行监控和调试。
示例应用
Agency 包含在 examples/demo
目录下的示例应用中。该应用提供了多个代理的例子供用户进行实验,其中包括两个 OpenAI 代理例子、一个 HuggingFace transformers 代理例子,以及操作系统访问示例。它还集成了 Gradio UI,提供 Docker 配置供开发和参考使用。
API 概述
在 Agency 中,所有实体都被表述为 Agent
类的实例,包括 AI 驱动的代理、软件接口或作为应用的一部分进行通信的用户。每个代理可以公开“动作”,其他代理可以在运行时发现并调用这些动作。例如,定义一个简单的数学运算代理:
class CalculatorAgent(Agent):
@action
def add(a, b):
return a + b
其他代理可以通过发送信息的方式,调用 CalculatorAgent
实例的 add
方法,如下所示:
other_agent.send({
'to': 'CalcAgent',
'action': {
'name': 'add',
'args': {
'a': 1,
'b': 2,
}
},
})
动作可设定访问策略,以确保安全性:
@action(access_policy=ACCESS_PERMITTED) # 允许随时访问
def add(a, b):
...
@action(access_policy=ACCESS_REQUESTED) # 需要审核后访问
def add(a, b):
...
代理还可以定义各种回调:
class CalculatorAgent(Agent):
...
def before_action(self, message: dict):
"""动作尝试之前调用"""
def after_action(self, message: dict, return_value: str, error: str):
"""动作尝试之后调用"""
def after_add(self):
"""代理添加到空间后调用,正式开始通信"""
def before_remove(self):
"""代理从空间中移除之前调用"""
Space
用于连接代理,代理只有在被加入同一个 Space
后才可互相通信。Agency 提供两种 Space
实现:LocalSpace
用于连接同一应用中的代理,而 AMQPSpace
通过 AMQP 服务器(如 RabbitMQ)实现网络连接代理。以下是创建 LocalSpace
并添加两个代理的简单示例:
space = LocalSpace()
space.add(CalculatorAgent, "CalcAgent")
space.add(MyAgent, "MyAgent")
# 上述代理现在可以互相通信
安装
要安装 Agency,可以使用下列命令:
pip install agency
或者
poetry add agency
示例应用
示例应用被设计为实验开发环境和库功能展示平台,其中包含多个可以互相通信的代理示例,并支持“slash”语法,便于使用者以代理身份调用动作。详细的运行说明请参考 examples/demo。
下图展示了 Gradio UI 的界面,示例展示了 OpenAIFunctionAgent
执行指令与 Host
代理进行交互。
贡献
欢迎任何形式的贡献!如果您有贡献的想法,请查看 contributing guide 以获取详细指导。