pyautogan


Namepyautogan JSON
Version 0.1.1rc0 PyPI version JSON
download
home_page
SummaryAutoGenius is an agent framework.
upload_time2023-12-10 02:41:52
maintainer
docs_urlNone
authorboweniac
requires_python
license
keywords python chatgpt agent
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# AutoGan

## 介绍

AutoGan 是一个 agent frame，它为大规模 agent 群组和超长工作流而设计。
通过 AutoGan 可以将 agent 和真人员工结合，形成一系列独立的数字部门。
这些部门可以独立运作，同时又能在需要的时候，让 agent、真人员工、数字部门之间互相协作，以完成各种任务。
我们的目标是创造一个环境，能够充分发掘和利用 LLM 的最大潜力。
随着 LLM 的不断发展和进步，相信越来越多的人工任务将被接替。

* 每个 agent 可以自主选择需要交流的对象。
* 除了依赖于 LLM 本身的能力，agent 还可以借助工具函数实现更多功能，例如：代码执行、数据查询、文件读取、邮件发送等。
* 通过构建组织架构，可以将 agent 和真人员工组成数字部门，并定义各数字部门的上下级关系。
* 在默认情况下，agent 的协作对象只限于当前部门的其他 agent 或真人员工，以及子数字部门的 leader。
* agent 在执行任务时，可根据需要向其他 agent、真人员工或数字部门的 leader 发布子任务。
* agent 的对话域仅聚焦于当前任务，不会受到其他任务对话内容的影响。
* 如果一个任务的执行过程较长，那么远期的会话记录将被压缩，但任务的原始内容将始终保持不变。

## Quickstart

### install
AutoGan requires Python version >= 3.8. It can be installed from pip:

```shell
pip install pyautogan
```

### notebook
在 jupyter 中运行已创建的示例

1. 下载本仓库
    ```shell
    git clone 
    cd autogan/notebook
    ```
2. 打开 ./notebook 中的 LLM_CONFIG 文件，然后设置正确的配置
3. 开始运行 notebook

如需要 agent 执行代码，请使用 docker 环境

## 特性

### Agent
在本框架中，agent 可以是以 LLM 为核心的智能体，也可以是仅使用工具函数的自动化程序，或者是真人员工的数字化身。

所有 agent 都是在 UniversalAgent 基类之上构建的，其主要属性如下：

* **name:** 该属性相当于 agent 的地址，用于 agent 之间的相互识别与沟通，因此该属性的值应当是全局唯一的。
* **duty:** 用于向其他 agent 介绍自身职责及能力。
* **work_flow:** 用于定义 agent 自身的工作流程。
* **use_tool** 用于定义 agent 使用工具函数的方式。

框架本身已构建了一些基础的 agent，实现了网络查询、编程、邮件发送等功能，以便于用户可以快速上手。

关于 agent 的详细介绍和创建方法，可参考 notebook

### 工具使用
如想要为 agent 添加定制化功能，可以通过重写 UniversalAgent 类的 tool_function 方法来实现。

* agent 的 use_tool 属性，与 tool_function 方法的调用关系：

   | use_tool   | tool_function         |
   |:-----------|-----------------------|
   | None       | 不调用工具函数               |
   | only       | 不使用 LLM，仅调用工具函数生成结果。  |
   | join       | LLM 生成的内容将作为工具函数的输入参数 |

关于 agent 工具使用的详细介绍，可参考 notebook

### 组织架构
考虑到并非所有 agent 之间都需要建立协作关系，且过多无用的协作关系会影响到 agent 决策的准确性。
因此本框架引入了组织架构的概念，让需要相互协作的 agent 组成独立的数字部门，以更加专注于解决特定领域的问题。

创建组织架构的方式非常简单，只需要定义一个存储 agent 对象的多维列表，例如：
```python
org_structure = [customer, customer_manager, 
                    [project_manager, product_manager
                        [coder, code_execution_agent]
                     ]
                ]
```
数字部门支持上下级关系，各部门的第一个 agent 为部门的 leader，其负责与上级部门的 agent 进行沟通。
因此 leader 的 duty 属性应当概述整个部门的职测与能力。

### 会话域
agent 之间的协作，是以任务为基础的，一个任务通常会被 agent 查分成多个子任务后，再分派给其他 agent。
每轮对话中 agent 仅会专注于当前任务内，有其参与的会话内容。
任何 agent 不会受到上级任务或子任务执行过程的影响。

### Switch
所有 agent 的回复消息，都会先被推送到 Switch，Switch 本身不会决定消息的接收方，
而是通过消息内的 @ 符号来判断将消息转发给谁。

除此之外，Switch 还负责任务的创建和任务间所属关系的维护。

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pyautogan",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python,chatgpt,agent",
    "author": "boweniac",
    "author_email": "boweniac@yeah.net",
    "download_url": "https://files.pythonhosted.org/packages/98/b4/c1a401215f330c29ca83d6556009cef6b60f82cf1ca251e01b7b4eea0861/pyautogan-0.1.1rc0.tar.gz",
    "platform": null,
    "description": "\n# AutoGan\n\n## \u4ecb\u7ecd\n\nAutoGan \u662f\u4e00\u4e2a agent frame\uff0c\u5b83\u4e3a\u5927\u89c4\u6a21 agent \u7fa4\u7ec4\u548c\u8d85\u957f\u5de5\u4f5c\u6d41\u800c\u8bbe\u8ba1\u3002\n\u901a\u8fc7 AutoGan \u53ef\u4ee5\u5c06 agent \u548c\u771f\u4eba\u5458\u5de5\u7ed3\u5408\uff0c\u5f62\u6210\u4e00\u7cfb\u5217\u72ec\u7acb\u7684\u6570\u5b57\u90e8\u95e8\u3002\n\u8fd9\u4e9b\u90e8\u95e8\u53ef\u4ee5\u72ec\u7acb\u8fd0\u4f5c\uff0c\u540c\u65f6\u53c8\u80fd\u5728\u9700\u8981\u7684\u65f6\u5019\uff0c\u8ba9 agent\u3001\u771f\u4eba\u5458\u5de5\u3001\u6570\u5b57\u90e8\u95e8\u4e4b\u95f4\u4e92\u76f8\u534f\u4f5c\uff0c\u4ee5\u5b8c\u6210\u5404\u79cd\u4efb\u52a1\u3002\n\u6211\u4eec\u7684\u76ee\u6807\u662f\u521b\u9020\u4e00\u4e2a\u73af\u5883\uff0c\u80fd\u591f\u5145\u5206\u53d1\u6398\u548c\u5229\u7528 LLM \u7684\u6700\u5927\u6f5c\u529b\u3002\n\u968f\u7740 LLM \u7684\u4e0d\u65ad\u53d1\u5c55\u548c\u8fdb\u6b65\uff0c\u76f8\u4fe1\u8d8a\u6765\u8d8a\u591a\u7684\u4eba\u5de5\u4efb\u52a1\u5c06\u88ab\u63a5\u66ff\u3002\n\n* \u6bcf\u4e2a agent \u53ef\u4ee5\u81ea\u4e3b\u9009\u62e9\u9700\u8981\u4ea4\u6d41\u7684\u5bf9\u8c61\u3002\n* \u9664\u4e86\u4f9d\u8d56\u4e8e LLM \u672c\u8eab\u7684\u80fd\u529b\uff0cagent \u8fd8\u53ef\u4ee5\u501f\u52a9\u5de5\u5177\u51fd\u6570\u5b9e\u73b0\u66f4\u591a\u529f\u80fd\uff0c\u4f8b\u5982\uff1a\u4ee3\u7801\u6267\u884c\u3001\u6570\u636e\u67e5\u8be2\u3001\u6587\u4ef6\u8bfb\u53d6\u3001\u90ae\u4ef6\u53d1\u9001\u7b49\u3002\n* \u901a\u8fc7\u6784\u5efa\u7ec4\u7ec7\u67b6\u6784\uff0c\u53ef\u4ee5\u5c06 agent \u548c\u771f\u4eba\u5458\u5de5\u7ec4\u6210\u6570\u5b57\u90e8\u95e8\uff0c\u5e76\u5b9a\u4e49\u5404\u6570\u5b57\u90e8\u95e8\u7684\u4e0a\u4e0b\u7ea7\u5173\u7cfb\u3002\n* \u5728\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cagent \u7684\u534f\u4f5c\u5bf9\u8c61\u53ea\u9650\u4e8e\u5f53\u524d\u90e8\u95e8\u7684\u5176\u4ed6 agent \u6216\u771f\u4eba\u5458\u5de5\uff0c\u4ee5\u53ca\u5b50\u6570\u5b57\u90e8\u95e8\u7684 leader\u3002\n* agent \u5728\u6267\u884c\u4efb\u52a1\u65f6\uff0c\u53ef\u6839\u636e\u9700\u8981\u5411\u5176\u4ed6 agent\u3001\u771f\u4eba\u5458\u5de5\u6216\u6570\u5b57\u90e8\u95e8\u7684 leader \u53d1\u5e03\u5b50\u4efb\u52a1\u3002\n* agent \u7684\u5bf9\u8bdd\u57df\u4ec5\u805a\u7126\u4e8e\u5f53\u524d\u4efb\u52a1\uff0c\u4e0d\u4f1a\u53d7\u5230\u5176\u4ed6\u4efb\u52a1\u5bf9\u8bdd\u5185\u5bb9\u7684\u5f71\u54cd\u3002\n* \u5982\u679c\u4e00\u4e2a\u4efb\u52a1\u7684\u6267\u884c\u8fc7\u7a0b\u8f83\u957f\uff0c\u90a3\u4e48\u8fdc\u671f\u7684\u4f1a\u8bdd\u8bb0\u5f55\u5c06\u88ab\u538b\u7f29\uff0c\u4f46\u4efb\u52a1\u7684\u539f\u59cb\u5185\u5bb9\u5c06\u59cb\u7ec8\u4fdd\u6301\u4e0d\u53d8\u3002\n\n## Quickstart\n\n### install\nAutoGan requires Python version >= 3.8. It can be installed from pip:\n\n```shell\npip install pyautogan\n```\n\n### notebook\n\u5728 jupyter \u4e2d\u8fd0\u884c\u5df2\u521b\u5efa\u7684\u793a\u4f8b\n\n1. \u4e0b\u8f7d\u672c\u4ed3\u5e93\n    ```shell\n    git clone \n    cd autogan/notebook\n    ```\n2. \u6253\u5f00 ./notebook \u4e2d\u7684 LLM_CONFIG \u6587\u4ef6\uff0c\u7136\u540e\u8bbe\u7f6e\u6b63\u786e\u7684\u914d\u7f6e\n3. \u5f00\u59cb\u8fd0\u884c notebook\n\n\u5982\u9700\u8981 agent \u6267\u884c\u4ee3\u7801\uff0c\u8bf7\u4f7f\u7528 docker \u73af\u5883\n\n## \u7279\u6027\n\n### Agent\n\u5728\u672c\u6846\u67b6\u4e2d\uff0cagent \u53ef\u4ee5\u662f\u4ee5 LLM \u4e3a\u6838\u5fc3\u7684\u667a\u80fd\u4f53\uff0c\u4e5f\u53ef\u4ee5\u662f\u4ec5\u4f7f\u7528\u5de5\u5177\u51fd\u6570\u7684\u81ea\u52a8\u5316\u7a0b\u5e8f\uff0c\u6216\u8005\u662f\u771f\u4eba\u5458\u5de5\u7684\u6570\u5b57\u5316\u8eab\u3002\n\n\u6240\u6709 agent \u90fd\u662f\u5728 UniversalAgent \u57fa\u7c7b\u4e4b\u4e0a\u6784\u5efa\u7684\uff0c\u5176\u4e3b\u8981\u5c5e\u6027\u5982\u4e0b\uff1a\n\n* **name:** \u8be5\u5c5e\u6027\u76f8\u5f53\u4e8e agent \u7684\u5730\u5740\uff0c\u7528\u4e8e agent \u4e4b\u95f4\u7684\u76f8\u4e92\u8bc6\u522b\u4e0e\u6c9f\u901a\uff0c\u56e0\u6b64\u8be5\u5c5e\u6027\u7684\u503c\u5e94\u5f53\u662f\u5168\u5c40\u552f\u4e00\u7684\u3002\n* **duty:** \u7528\u4e8e\u5411\u5176\u4ed6 agent \u4ecb\u7ecd\u81ea\u8eab\u804c\u8d23\u53ca\u80fd\u529b\u3002\n* **work_flow:** \u7528\u4e8e\u5b9a\u4e49 agent \u81ea\u8eab\u7684\u5de5\u4f5c\u6d41\u7a0b\u3002\n* **use_tool** \u7528\u4e8e\u5b9a\u4e49 agent \u4f7f\u7528\u5de5\u5177\u51fd\u6570\u7684\u65b9\u5f0f\u3002\n\n\u6846\u67b6\u672c\u8eab\u5df2\u6784\u5efa\u4e86\u4e00\u4e9b\u57fa\u7840\u7684 agent\uff0c\u5b9e\u73b0\u4e86\u7f51\u7edc\u67e5\u8be2\u3001\u7f16\u7a0b\u3001\u90ae\u4ef6\u53d1\u9001\u7b49\u529f\u80fd\uff0c\u4ee5\u4fbf\u4e8e\u7528\u6237\u53ef\u4ee5\u5feb\u901f\u4e0a\u624b\u3002\n\n\u5173\u4e8e agent \u7684\u8be6\u7ec6\u4ecb\u7ecd\u548c\u521b\u5efa\u65b9\u6cd5\uff0c\u53ef\u53c2\u8003 notebook\n\n### \u5de5\u5177\u4f7f\u7528\n\u5982\u60f3\u8981\u4e3a agent \u6dfb\u52a0\u5b9a\u5236\u5316\u529f\u80fd\uff0c\u53ef\u4ee5\u901a\u8fc7\u91cd\u5199 UniversalAgent \u7c7b\u7684 tool_function \u65b9\u6cd5\u6765\u5b9e\u73b0\u3002\n\n* agent \u7684 use_tool \u5c5e\u6027\uff0c\u4e0e tool_function \u65b9\u6cd5\u7684\u8c03\u7528\u5173\u7cfb\uff1a\n\n   | use_tool   | tool_function         |\n   |:-----------|-----------------------|\n   | None       | \u4e0d\u8c03\u7528\u5de5\u5177\u51fd\u6570               |\n   | only       | \u4e0d\u4f7f\u7528 LLM\uff0c\u4ec5\u8c03\u7528\u5de5\u5177\u51fd\u6570\u751f\u6210\u7ed3\u679c\u3002  |\n   | join       | LLM \u751f\u6210\u7684\u5185\u5bb9\u5c06\u4f5c\u4e3a\u5de5\u5177\u51fd\u6570\u7684\u8f93\u5165\u53c2\u6570 |\n\n\u5173\u4e8e agent \u5de5\u5177\u4f7f\u7528\u7684\u8be6\u7ec6\u4ecb\u7ecd\uff0c\u53ef\u53c2\u8003 notebook\n\n### \u7ec4\u7ec7\u67b6\u6784\n\u8003\u8651\u5230\u5e76\u975e\u6240\u6709 agent \u4e4b\u95f4\u90fd\u9700\u8981\u5efa\u7acb\u534f\u4f5c\u5173\u7cfb\uff0c\u4e14\u8fc7\u591a\u65e0\u7528\u7684\u534f\u4f5c\u5173\u7cfb\u4f1a\u5f71\u54cd\u5230 agent \u51b3\u7b56\u7684\u51c6\u786e\u6027\u3002\n\u56e0\u6b64\u672c\u6846\u67b6\u5f15\u5165\u4e86\u7ec4\u7ec7\u67b6\u6784\u7684\u6982\u5ff5\uff0c\u8ba9\u9700\u8981\u76f8\u4e92\u534f\u4f5c\u7684 agent \u7ec4\u6210\u72ec\u7acb\u7684\u6570\u5b57\u90e8\u95e8\uff0c\u4ee5\u66f4\u52a0\u4e13\u6ce8\u4e8e\u89e3\u51b3\u7279\u5b9a\u9886\u57df\u7684\u95ee\u9898\u3002\n\n\u521b\u5efa\u7ec4\u7ec7\u67b6\u6784\u7684\u65b9\u5f0f\u975e\u5e38\u7b80\u5355\uff0c\u53ea\u9700\u8981\u5b9a\u4e49\u4e00\u4e2a\u5b58\u50a8 agent \u5bf9\u8c61\u7684\u591a\u7ef4\u5217\u8868\uff0c\u4f8b\u5982\uff1a\n```python\norg_structure = [customer, customer_manager, \n                    [project_manager, product_manager\n                        [coder, code_execution_agent]\n                     ]\n                ]\n```\n\u6570\u5b57\u90e8\u95e8\u652f\u6301\u4e0a\u4e0b\u7ea7\u5173\u7cfb\uff0c\u5404\u90e8\u95e8\u7684\u7b2c\u4e00\u4e2a agent \u4e3a\u90e8\u95e8\u7684 leader\uff0c\u5176\u8d1f\u8d23\u4e0e\u4e0a\u7ea7\u90e8\u95e8\u7684 agent \u8fdb\u884c\u6c9f\u901a\u3002\n\u56e0\u6b64 leader \u7684 duty \u5c5e\u6027\u5e94\u5f53\u6982\u8ff0\u6574\u4e2a\u90e8\u95e8\u7684\u804c\u6d4b\u4e0e\u80fd\u529b\u3002\n\n### \u4f1a\u8bdd\u57df\nagent \u4e4b\u95f4\u7684\u534f\u4f5c\uff0c\u662f\u4ee5\u4efb\u52a1\u4e3a\u57fa\u7840\u7684\uff0c\u4e00\u4e2a\u4efb\u52a1\u901a\u5e38\u4f1a\u88ab agent \u67e5\u5206\u6210\u591a\u4e2a\u5b50\u4efb\u52a1\u540e\uff0c\u518d\u5206\u6d3e\u7ed9\u5176\u4ed6 agent\u3002\n\u6bcf\u8f6e\u5bf9\u8bdd\u4e2d agent \u4ec5\u4f1a\u4e13\u6ce8\u4e8e\u5f53\u524d\u4efb\u52a1\u5185\uff0c\u6709\u5176\u53c2\u4e0e\u7684\u4f1a\u8bdd\u5185\u5bb9\u3002\n\u4efb\u4f55 agent \u4e0d\u4f1a\u53d7\u5230\u4e0a\u7ea7\u4efb\u52a1\u6216\u5b50\u4efb\u52a1\u6267\u884c\u8fc7\u7a0b\u7684\u5f71\u54cd\u3002\n\n### Switch\n\u6240\u6709 agent \u7684\u56de\u590d\u6d88\u606f\uff0c\u90fd\u4f1a\u5148\u88ab\u63a8\u9001\u5230 Switch\uff0cSwitch \u672c\u8eab\u4e0d\u4f1a\u51b3\u5b9a\u6d88\u606f\u7684\u63a5\u6536\u65b9\uff0c\n\u800c\u662f\u901a\u8fc7\u6d88\u606f\u5185\u7684 @ \u7b26\u53f7\u6765\u5224\u65ad\u5c06\u6d88\u606f\u8f6c\u53d1\u7ed9\u8c01\u3002\n\n\u9664\u6b64\u4e4b\u5916\uff0cSwitch \u8fd8\u8d1f\u8d23\u4efb\u52a1\u7684\u521b\u5efa\u548c\u4efb\u52a1\u95f4\u6240\u5c5e\u5173\u7cfb\u7684\u7ef4\u62a4\u3002\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "AutoGenius is an agent framework.",
    "version": "0.1.1rc0",
    "project_urls": null,
    "split_keywords": [
        "python",
        "chatgpt",
        "agent"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "98b4c1a401215f330c29ca83d6556009cef6b60f82cf1ca251e01b7b4eea0861",
                "md5": "90e776cad2d493f24cd8ca16c4c43041",
                "sha256": "67b40610e1df49c53569814273ad677ae391a235a091023dfcaca26da77e3364"
            },
            "downloads": -1,
            "filename": "pyautogan-0.1.1rc0.tar.gz",
            "has_sig": false,
            "md5_digest": "90e776cad2d493f24cd8ca16c4c43041",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 38461,
            "upload_time": "2023-12-10T02:41:52",
            "upload_time_iso_8601": "2023-12-10T02:41:52.604136Z",
            "url": "https://files.pythonhosted.org/packages/98/b4/c1a401215f330c29ca83d6556009cef6b60f82cf1ca251e01b7b4eea0861/pyautogan-0.1.1rc0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-10 02:41:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pyautogan"
}
boweniac
Elapsed time: 0.52184s