feat: Version 0.0.12 Release

2026-02-09 01:59:19 +08:00 · 2024-08-15 00:14:00 +08:00
parent 5a60ba64ac
commit 11efe7670f
10 changed files with 178 additions and 19 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -24,6 +24,18 @@ Note - Additional remarks regarding the version.
 ***************************************************

 # Version Update History
+## [0.0.12] - 2024-08-14
+### Added
+- agentUniverse Product Version Offering
+  - The current version provides basic capabilities for agent construction, modification, and debugging, jointly launched by the difizen project. For more details, please refer to the documentation in the product platform section.
+- Monitor Component: Added knowledge and tool instance collection, supporting full-link trace sequence concatenation and providing token consumption monitoring.
+- New Web Session Module: Provides session and message persistence management capabilities.
+
+### Note
+- Optimized Knowledge Component: Users can configure and specify any number of recall results (similarity_top_k).
+- Fixed Chroma Component: Resolved issues where the embedding module was not specified.
+- Various code optimizations and documentation updates.
+
 ## [0.0.11] - 2024-07-11
 ### Added
 - DataAgent Autonomous Data Agent MVP Version Released
--- a/CHANGELOG_zh.md
+++ b/CHANGELOG_zh.md
@@ -24,6 +24,18 @@ Note - 对于版本的额外说明。
 ***************************************************

 # 版本更新记录
+## [0.0.12] - 2024-08-14
+### Added
+- agentUniverse产品化版本提供
+  - 当前版本提供智能体构建、修改、调试等基础能力，由difizen项目联合推出，更多详情请见文档产品化平台部分。
+- monitor组件新增对于知识、工具实例采集，支持全链路trace时序串联并提供token消耗监控
+- 新增web会话模块，提供session与message持久化管理能力
+
+### Note
+- 优化知识组件，可由用户配置指定任意召回结果数量（similarity_top_k）
+- 修复chroma组件未指定embedding模块出现异常
+- 其他部分代码优化与文档更新
+
 ## [0.0.11] - 2024-07-11
 ### Added
 - DataAgent数据自治智能体MVP版本发布
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Language version: [English](./README.md) | [中文](./README_zh.md) | [日本語
 ![](https://img.shields.io/badge/framework-agentUniverse-pink)
 ![](https://img.shields.io/badge/python-3.10%2B-blue?logo=Python)
 [![](https://img.shields.io/badge/%20license-Apache--2.0-yellow)](LICENSE)
-[![Static Badge](https://img.shields.io/badge/pypi-v0.0.11-blue?logo=pypi)](https://pypi.org/project/agentUniverse/)
+[![Static Badge](https://img.shields.io/badge/pypi-v0.0.12-blue?logo=pypi)](https://pypi.org/project/agentUniverse/)

 ![](docs/guidebook/_picture/logo_bar.jpg)
 ****************************************
@@ -55,6 +55,24 @@ We will show you how to:
 For more details, please read the [Quick Start](./docs/guidebook/en/1_3_Quick_Start.md).

 ****************************************
+## Using the Product Platform
+agentUniverse provides a local product platform capability. Please follow the steps below for a quick start:
+
+**Install via pip**
+```shell
+pip install magent-ui ruamel.yaml
+```
+
+**One-click Run**
+
+Run the [product_application.py](sample_standard_app/app/bootstrap/product_application.py) file located in sample_standard_app/app/bootstrap for a one-click start.
+
+For more details, refer to [Quick Start for Product Platform](./docs/guidebook/en/10_1_1_Product%20Platform%20Quick%20Start.md).
+
+This feature is jointly launched by [difizen](https://github.com/difizen/magent) and agentUniverse.
+
+****************************************
+
 ## Cases and Example Projects
 ### 🌟 Use Cases
 [Legal Consultation Agent](./docs/guidebook/en/7_1_1_Legal_Consultation_Case.md)
--- a/README_zh.md
+++ b/README_zh.md
@@ -5,7 +5,7 @@
 ![](https://img.shields.io/badge/framework-agentUniverse-pink)
 ![](https://img.shields.io/badge/python-3.10%2B-blue?logo=Python)
 [![](https://img.shields.io/badge/%20license-Apache--2.0-yellow)](LICENSE)
-[![Static Badge](https://img.shields.io/badge/pypi-v0.0.11-blue?logo=pypi)](https://pypi.org/project/agentUniverse/)
+[![Static Badge](https://img.shields.io/badge/pypi-v0.0.12-blue?logo=pypi)](https://pypi.org/project/agentUniverse/)

 ![](docs/guidebook/_picture/logo_bar.jpg)
 ****************************************
@@ -51,6 +51,23 @@ pip install agentUniverse
 * 对agent进行快速服务化

 详情请阅读[快速开始](docs/guidebook/zh/1_3_%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md) 。
+****************************************
+## 产品化平台使用
+agentUniverse提供基于本地的产品化平台能力，请按照如下步骤快速启动
+
+**通过pip安装**
+```shell
+pip install magent-ui ruamel.yaml
+```
+
+**一键运行**
+
+运行sample_standard_app/app/boostrap下的[product_application.py](sample_standard_app/app/bootstrap/product_application.py)文件，一键启动。
+
+更多详情参考 [产品化平台快速开始](./docs/guidebook/zh/10_1_1_产品化平台快速开始.md)
+
+本功能由 [difizen](https://github.com/difizen/magent) X agentUniverse联合推出。
+
 ****************************************
 ## 案例与样例工程
 ### 🌟 使用案例
--- a/docs/guidebook/_picture/product_start.png
+++ b/docs/guidebook/_picture/product_start.png
--- a/docs/guidebook/en/0_index.md
+++ b/docs/guidebook/en/0_index.md
@@ -93,10 +93,13 @@
  * 6.4.1 [Financial Event Analysis Case](./6_4_1_Financial_Event_Analysis_Case.md)
 * 6.5 [Andrew Ng's Reflexive Workflow Translation Agent Replication](./7_1_1_Translation_Case.md)

-**7. Series of Articles**
+**7.Product Platform**
+* 7.1 [Quick Use](./10_1_1_Product Platform Quick Start.md)

-**8. Frequently Asked Questions (FAQ)**
+**8. Series of Articles**

-**[9.Citation](9_1_Citation.md)**
+**9. Frequently Asked Questions (FAQ)**

-**[10. Contact Us](6_1_Contact_Us.md)**
+**[10.Citation](9_1_Citation.md)**
+
+**[11. Contact Us](6_1_Contact_Us.md)**
--- a/docs/guidebook/en/10_1_1_Product
+++ b/docs/guidebook/en/10_1_1_Product
@@ -0,0 +1,91 @@
+# Product Platform Quick Start
+In this section, we will show you how to:
+
+* Start the agentUniverse productized service
+* Configure the agentUniverse product modules
+* Quickly get started with productized features
+* Debug and experience agents online, optimizing agent performance
+
+## Environment and Application Engineering Preparation
+### Application Engineering Preparation
+We have placed the **product module samples** in the agentUniverse’s sample_standard_app project. You can view them [here](../../../sample_standard_app/app/core/product). This part can be configured in the background through YAML, and of course, these functions can be automatically created and managed through the product page.
+
+### Installing Dependencies
+**Using pip**
+```shell
+pip install magent-ui ruamel.yaml
+```
+
+### Configuration File
+If you have previously used aU’s sample project, please add the following information to the `config.toml` file configuration to include the product module path, as configured in sample_standard_app:
+```toml
+# Ignore the context content.
+[CORE_PACKAGE]
+# Scan and register product components for all paths under this list, with priority over the default.
+product = ['sample_standard_app.app.core.product']
+# Ignore the context content.
+```
+If you are using aU for the first time, you can directly use the latest sample project’s `config.toml`.
+
+#### Private Configuration File
+Of course, when using the agent, you need to pre-configure the various LLM model keys/Tool keys, otherwise, the overall process of the agent cannot be connected. This part is currently not provided in the product page configuration management. Please reuse aU’s original key configuration method. In future versions, we will directly provide key management capabilities for each model in the product.
+
+
+## Using the agentUniverse Product Platform
+### Starting the Product Service
+Run the [product_application](../../../sample_standard_app/app/bootstrap/product_application.py) file located in `sample_standard_app/app/bootstrap` to start with one click.
+
+![img.png](../_picture/product_start.png)
+
+After a successful start, it will automatically redirect to the product homepage, which includes system presets and your custom Agent/Tool/Knowledge product modules.
+![agentuniverse_product_homepage](../_picture/agentuniverse_product_homepage.png)
+
+### Experience the Agent
+As shown in the image above, click the chat button on the right of the peer multi-agent group to enter the conversation page.
+
+The conversation management system includes the last 10 agent conversation history records, allowing you to directly engage in multi-turn dialogues and experience the capabilities of the peer multi-agent group (default is streaming dialogue, and the multi-agent group includes the intermediate thinking process).
+![agentuniverse_product_agent_chat](../_picture/agentuniverse_product_agent_chat.png)
+
+### Debugging the Agent
+On the product homepage, click the edit button on the left of the agent to enter the online debugging page.
+
+You can debug the agent’s Prompt/Tool/Knowledge/LLM online. Click the save button, and aU-product will automatically save the configuration to the corresponding yaml file.
+![agentuniverse_product_agent_editor](../_picture/agentuniverse_product_agent_editor.png)
+
+Click the debug button in the upper right corner of the image above to view the Trace information, including token consumption, call chain, and latency of the agent’s specific invocation process.
+![agentuniverse_product_agent_trace](../_picture/agentuniverse_product_agent_trace.png)
+
+## Configuring agentUniverse Product Modules
+### Creating Product Modules
+```yaml
+id: demo_rag_agent
+nickname: rag智能体
+type: AGENT
+opening_speech: |
+  欢迎使用rag chatbot！根据您的提问，我将结合实时信息及我个人掌握的知识，给您提供合理的解答。
+  你可以这样问我：
+  问题1: 巴黎奥运会中国获得了几块奖牌
+  问题2: 巴菲特为什么减持苹果股票
+avatar: ../../../resources/rag_agent_logo.png
+metadata:
+  class: AgentProduct
+  module: agentuniverse_product.base.agent_product
+  type: PRODUCT
+```
+
+As shown in the yaml file above:
+
+- `product id` corresponds to `name` in the agent yaml
+- `type` corresponds to `AGENT`
+- `metadata` is configured as the value shown above
+- Other parameters can be configured as needed (the same applies to tool/knowledge modules)
+
+### Configuring Global Config
+In the global `config.toml`, configure the package scan path corresponding to the product module. With one click, you can start the product platform and display the corresponding agent/tool/knowledge information.
+
+## More
+The agentUniverse-product platform is continuously iterating, and more convenient and useful features will be available for community users to experience in the future. We also welcome your valuable suggestions.
+
+This feature is jointly launched by [difizen](https://github.com/difizen/magent) and agentUniverse.
+
+Let’s explore and progress together!
--- a/docs/guidebook/zh/0_目录.md
+++ b/docs/guidebook/zh/0_目录.md
@@ -97,10 +97,13 @@
  * 6.4.1 [金融事件分析案例](./6_4_1_金融事件分析案例.md)
 * 6.5 [吴恩达反思工作流翻译智能体复刻](./7_1_1_翻译案例.md)

-**7.系列文章**
+**7.产品化平台**
+* 7.1 [快速使用](./10_1_1_产品化平台快速开始.md)

-**8.常见问题FAQ**
+**8.系列文章**

-**[9.研究文献](9_1_研究文献.md)**
+**9.常见问题FAQ**

-**[10.联系我们](6_1_联系我们.md)**
+**[10.研究文献](9_1_研究文献.md)**
+
+**[11.联系我们](6_1_联系我们.md)**
--- a/docs/guidebook/zh/10_1_1_产品化平台快速开始.md
+++ b/docs/guidebook/zh/10_1_1_产品化平台快速开始.md
@@ -6,12 +6,8 @@
 * 在线调试和体验智能体，优化智能体效果

 ## 环境与应用工程准备
-
-
 ### 应用工程准备
-我们将**产品化模块样例**放在了agentUniverse的sample_standard_app工程中，你可以到 [这里](../../../sample_standard_app/app/core/product) 查看。
-
-产品化底层能力沉淀在agentuniverse_product package下，欢迎查看。
+我们将**产品化模块样例**放在了agentUniverse的sample_standard_app工程中，你可以到 [这里](../../../sample_standard_app/app/core/product) 查看。这部分可以在后台通过yaml配置，当然通过产品页面可以自动创建和管理这些功能。

 ### 安装依赖
 **通过pip安装**
@@ -20,7 +16,7 @@ pip install magent-ui ruamel.yaml
 ```

 ### 配置文件
-在您的工程`config.toml`文件中，增加产品化模块路径，如sample_standard_app中配置的：
+如果您之前已经使用过aU的样例工程，请在`config.toml`文件配置中加入下列信息，增加产品化模块路径，如sample_standard_app中配置的：
 ```toml
 # 上下文内容忽略
 [CORE_PACKAGE]
@@ -28,14 +24,17 @@ pip install magent-ui ruamel.yaml
 product = ['sample_standard_app.app.core.product']
 # 上下文内容忽略
 ```
+如果您是第一次使用aU直接使用最新样例工程的`config.toml`即可。

 #### 私有配置文件
-当然您使用智能体时，用到的各类LLM模型密钥/Tool工具密钥等也需提前配置好，否则无法串联智能体整体流程。
+当然您使用智能体时，用到的各类LLM模型密钥/Tool工具密钥等也需提前配置好，否则无法串联智能体整体流程。该部分目前没有在产品页面提供配置管理，请复用aU原本的密钥配置方式，在后续版本中我们将直接在产品化中提供各个模型的密钥管理能力。


 ## 使用agentUniverse产品化平台
 ### 启动产品化服务
-通过运行sample_standard_app/app/boostrap下的[product_application](../../../sample_standard_app/app/bootstrap/product_application.py)文件，一键启动。
+运行sample_standard_app/app/boostrap下的[product_application](../../../sample_standard_app/app/bootstrap/product_application.py)文件，一键启动。
+
+![img.png](../_picture/product_start.png)

 启动成功后，自动跳转产品化主页，主页包含系统预制和您自定义的Agent/Tool/Knowledge产品模块。
 ![agentuniverse_product_homepage](../_picture/agentuniverse_product_homepage.png)
@@ -84,4 +83,6 @@ metadata:
 ## 更多
 agentUniverse-product产品化平台在持续迭代中，后续会有更多便捷好用的功能供社区用户体验，也欢迎大家提出宝贵建议。

+本功能由 [difizen](https://github.com/difizen/magent) X agentUniverse联合推出。
+
 让我们共同探索，共同进步！
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "agentUniverse"
-version = "0.0.11"
+version = "0.0.12"
 description = "agentUniverse is a framework for developing applications powered by multi-agent base on large language model."

 authors = ["AntGroup <jerry.zzw@antgroup.com>"]
@@ -11,6 +11,7 @@ packages = [
    { include = "agentuniverse" },
    { include = "agentuniverse_connector" },
    { include = "agentuniverse_extension" },
+    { include = "agentuniverse_product" },
 ]
 include = ["*.yaml"]
 classifiers = [
@@ -56,6 +57,7 @@ pandas = "^2.2.2"
 pyarrow = "^16.1.0"
 duckduckgo-search = "^6.1.7"
 wikipedia= "^1.4.0"
+openpyxl = "^3.1.5"

 [tool.poetry.extras]
 log_ext = ["aliyun-log-python-sdk"]