rootengine-core 0.5.0__tar.gz

rootengine_core-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 zimvir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rootengine_core-0.5.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: rootengine-core
+Version: 0.5.0
+Summary: RootEngine AI Agent Framework Core
+Author-email: zimvir <zimvir@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/zimvir/RootEngine
+Project-URL: Repository, https://github.com/zimvir/RootEngine
+Keywords: ai,agent,rootengine
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.0.0
+Dynamic: license-file
+
+# RootEngine Core
+
+AI Agent 框架的底层组件库。
+
+## 这是什么
+
+RootEngine Core 是一个用于**构建 Agent 框架的框架**。它提供：
+
+- **REIF 格式** - 结构化的 Agent 信息交换格式，统一对话、工具调用、结果的规范
+- **核心组件** - 对话管理、工具系统、LLM 适配器
+- **可组合** - 自由组合这些组件来构建你自己的 Agent
+
+如果你想从零搭建一个 Agent 系统，这是一个不错的起点。如果你想要一个开箱即用的 Agent，可能还不适合你。
+
+## 安装
+
+```bash
+pip install rootengine-core
+```
+
+要求：Python >= 3.8
+
+## REIF 是什么
+
+REIF（RootEngine Information Format）是一套信息格式规范，定义了 Agent 内部和组件之间如何交换数据：
+
+- **conversation** - 对话历史
+- **tool_registry** - 工具注册表
+- **tool_call** - 工具调用请求
+- **tool_result** - 工具执行结果
+
+使用统一格式的好处是：组件之间接口稳定，方便替换和扩展。
+
+## 快速开始
+
+### 对话管理
+
+```python
+from rootengine_core import NoToolConversation
+
+conv = NoToolConversation()
+conv.add("system", "你是一个有帮助的助手")
+conv.add("user", "你好")
+
+print(conv.messages)
+# [
+#   {"role": "system", "content": "你是一个有帮助的助手", "created_at": "..."},
+#   {"role": "user", "content": "你好", "created_at": "..."}
+# ]
+```
+
+### 工具调用
+
+```python
+from rootengine_core import Tool
+from rootengine_core.utils.reif_func import reif_create
+
+# 定义一个工具
+def greeting(name, agent=None):
+    return f"Hello, {name}!"
+
+# 工具注册表（REIF 格式）
+registry = reif_create({"category": "tool_registry"})
+registry["reif_content"] = {
+    "a1b2c3d4e5f6789012345678abcdef01": {
+        "name": "greeting",
+        "type": "function",
+        "function": {
+            "name": "greeting",
+            "description": "打招呼",
+            "parameters": {
+                "type": "object",
+                "properties": {"name": {"type": "string"}},
+                "required": ["name"]
+            }
+        }
+    }
+}
+
+# 初始化工具
+tool = Tool(
+    tool_registry_entry=registry,
+    agent=None,
+    tool_func_map={"a1b2c3d4e5f6789012345678abcdef01": greeting}
+)
+
+# 执行工具调用
+result = tool.execute({
+    "id": "call_001",
+    "type": "function",
+    "function": {
+        "registry_id": "a1b2c3d4e5f6789012345678abcdef01",
+        "arguments": {"name": "Alice"}
+    },
+    "created_at": "2024-01-01T00:00:00Z"
+})
+
+print(result)
+# {"call_id": "call_001", "type": "function",
+#  "function": {"result_content": "Hello, Alice!", "status": "success"},
+#  "created_at": "..."}
+```
+
+### LLM 适配器
+
+```python
+from rootengine_core import OpenAIAdapter
+
+adapter = OpenAIAdapter(model="gpt-4o-mini")
+# adapter.from_provider(llm_response)  # 解析 LLM 返回
+```
+
+## 状态
+
+这是一个早期项目，核心组件可用，但：
+- 文档还不完整
+- 工具系统示例较少
+- 尚未经过大规模生产验证
+
+## 模块一览
+
+| 模块 | 说明 |
+|------|------|
+| `conversation` | 对话管理 |
+| `tool` | 工具注册与执行 |
+| `llm` | LLM 适配器 |
+| `utils/reif_func` | REIF 格式创建与验证 |
+
+## 其他
+- 版本: 虽然这是发出的第一版，但其在内部已有多次迭代，故以 0.5.0 为版号发布
+- utils 里有很多好玩的东西
+## 许可证
+
+MIT

rootengine_core-0.5.0/README.md

@@ -0,0 +1,134 @@
+# RootEngine Core
+
+AI Agent 框架的底层组件库。
+
+## 这是什么
+
+RootEngine Core 是一个用于**构建 Agent 框架的框架**。它提供：
+
+- **REIF 格式** - 结构化的 Agent 信息交换格式，统一对话、工具调用、结果的规范
+- **核心组件** - 对话管理、工具系统、LLM 适配器
+- **可组合** - 自由组合这些组件来构建你自己的 Agent
+
+如果你想从零搭建一个 Agent 系统，这是一个不错的起点。如果你想要一个开箱即用的 Agent，可能还不适合你。
+
+## 安装
+
+```bash
+pip install rootengine-core
+```
+
+要求：Python >= 3.8
+
+## REIF 是什么
+
+REIF（RootEngine Information Format）是一套信息格式规范，定义了 Agent 内部和组件之间如何交换数据：
+
+- **conversation** - 对话历史
+- **tool_registry** - 工具注册表
+- **tool_call** - 工具调用请求
+- **tool_result** - 工具执行结果
+
+使用统一格式的好处是：组件之间接口稳定，方便替换和扩展。
+
+## 快速开始
+
+### 对话管理
+
+```python
+from rootengine_core import NoToolConversation
+
+conv = NoToolConversation()
+conv.add("system", "你是一个有帮助的助手")
+conv.add("user", "你好")
+
+print(conv.messages)
+# [
+#   {"role": "system", "content": "你是一个有帮助的助手", "created_at": "..."},
+#   {"role": "user", "content": "你好", "created_at": "..."}
+# ]
+```
+
+### 工具调用
+
+```python
+from rootengine_core import Tool
+from rootengine_core.utils.reif_func import reif_create
+
+# 定义一个工具
+def greeting(name, agent=None):
+    return f"Hello, {name}!"
+
+# 工具注册表（REIF 格式）
+registry = reif_create({"category": "tool_registry"})
+registry["reif_content"] = {
+    "a1b2c3d4e5f6789012345678abcdef01": {
+        "name": "greeting",
+        "type": "function",
+        "function": {
+            "name": "greeting",
+            "description": "打招呼",
+            "parameters": {
+                "type": "object",
+                "properties": {"name": {"type": "string"}},
+                "required": ["name"]
+            }
+        }
+    }
+}
+
+# 初始化工具
+tool = Tool(
+    tool_registry_entry=registry,
+    agent=None,
+    tool_func_map={"a1b2c3d4e5f6789012345678abcdef01": greeting}
+)
+
+# 执行工具调用
+result = tool.execute({
+    "id": "call_001",
+    "type": "function",
+    "function": {
+        "registry_id": "a1b2c3d4e5f6789012345678abcdef01",
+        "arguments": {"name": "Alice"}
+    },
+    "created_at": "2024-01-01T00:00:00Z"
+})
+
+print(result)
+# {"call_id": "call_001", "type": "function",
+#  "function": {"result_content": "Hello, Alice!", "status": "success"},
+#  "created_at": "..."}
+```
+
+### LLM 适配器
+
+```python
+from rootengine_core import OpenAIAdapter
+
+adapter = OpenAIAdapter(model="gpt-4o-mini")
+# adapter.from_provider(llm_response)  # 解析 LLM 返回
+```
+
+## 状态
+
+这是一个早期项目，核心组件可用，但：
+- 文档还不完整
+- 工具系统示例较少
+- 尚未经过大规模生产验证
+
+## 模块一览
+
+| 模块 | 说明 |
+|------|------|
+| `conversation` | 对话管理 |
+| `tool` | 工具注册与执行 |
+| `llm` | LLM 适配器 |
+| `utils/reif_func` | REIF 格式创建与验证 |
+
+## 其他
+- 版本: 虽然这是发出的第一版，但其在内部已有多次迭代，故以 0.5.0 为版号发布
+- utils 里有很多好玩的东西
+## 许可证
+
+MIT

rootengine_core-0.5.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rootengine-core"
+version = "0.5.0"
+description = "RootEngine AI Agent Framework Core"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "zimvir", email = "zimvir@qq.com"}
+]
+keywords = ["ai", "agent", "rootengine"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "jsonschema>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/zimvir/RootEngine"
+Repository = "https://github.com/zimvir/RootEngine"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rootengine_core*"]
+exclude = ["rootengine_core.test*"]
+
+[tool.setuptools.package-data]
+rootengine_core = [
+    "schema/source/**/*.json",
+    "schema_runtime/*.py",
+]

rootengine_core-0.5.0/rootengine_core/__init__.py

@@ -0,0 +1,5 @@
+
+from .conversation import NoToolConversation
+from .tool import Tool
+from .llm import BaseLLM
+from .llm.openai_adapter import OpenAIAdapter,BaseLLMAdapter

rootengine_core-0.5.0/rootengine_core/constants/conversation.py

@@ -0,0 +1,5 @@
+CONVERSATION_ROLE = [
+    "system",
+    "user",
+    "assistant"
+]

rootengine_core-0.5.0/rootengine_core/constants/framework.py

@@ -0,0 +1,17 @@
+VERSION = {
+    "reif_version":"1.0",
+    "conversation":"0.1.0",
+    "tool_registry":"0.1.0",
+    "tool_call":"0.1.0",
+    "tool_results":"0.1.0",
+    "tool_record":"0.1.0",
+
+}
+
+REIF_CATEGORY = [
+    "agent_card",
+    "conversation",
+    "tool_registry",
+    "tool_record"
+
+    ]

rootengine_core-0.5.0/rootengine_core/conversation/__init__.py

@@ -0,0 +1 @@
+from .no_tool_conversation import NoToolConversation

rootengine_core-0.5.0/rootengine_core/conversation/no_tool_conversation.py

@@ -0,0 +1,106 @@
+
+from ..constants.conversation import CONVERSATION_ROLE
+from pathlib import Path
+from ..utils.reif_func import reif_create,reif_validate
+from ..utils.time import get_iso_timestamp
+
+
+from jsonschema import validate
+
+
+from ..schema_runtime.reif_schema import get_json
+SCHEMA = get_json("conversation.no_tool_conversation")
+
+class NoToolConversation:
+    def __init__(self, conversation_entry: dict = None):
+        # 如果未传自动创建新的
+        if conversation_entry is None:
+             self.create()
+        else:
+            self.entry = conversation_entry
+
+        self.messages = self.entry["reif_content"]
+
+
+    def create(self)   -> NoToolConversation:
+        """创建新会话"""
+        self.entry = reif_create({"category": "conversation"})
+        # 确保 reif_content 存在且为空列表
+        self.entry["reif_content"] = []
+        # 链接
+        self.messages = self.entry["reif_content"]
+
+        return self
+
+    def add(
+            self ,
+            role: str,
+            content: str = None,
+            created_at: str = None,
+            extra: dict = None,
+            )   -> NoToolConversation :
+
+        """
+        向会话添加一条消息。
+
+        :param role: 消息角色，必须为 system/user/assistant/tool 之一。
+        :param content: 文本内容（对 system/user/assistant 必填，对 tool 可选）。
+
+        :param extra: 可选的扩展字典，任意附加信息。
+        :param created_at: 可选时间戳，若不提供则自动生成。
+        :return: self，支持链式调用。
+        """
+        #检验角色
+        if role not in CONVERSATION_ROLE:
+            raise ValueError(f"未知角色: {role}")
+
+        # 生成时间戳
+        if created_at is None:
+            created_at = get_iso_timestamp()
+
+
+        # 构造消息字典
+        item = {
+            "role": role,
+            "content": content,
+            "created_at": created_at
+        }
+
+        if extra:
+            item["extra"] = extra
+
+        self.messages.append(item)
+        return self
+
+    def delete(self, index: int = None):
+        """
+
+        :param index: 索引，若不填默认删除最后一个
+        :return:
+        """
+
+        if index is None:
+            self.messages.pop()
+        else:
+            self.messages.pop(index)
+        return self
+
+
+
+    def load_entry(self,entry: dict) -> NoToolConversation :
+        """加载整个 conversation 条目"""
+        self.entry = entry
+        self.messages = self.entry["reif_content"]
+        return self
+    def load_messages(self,messages: list) -> NoToolConversation :
+        self.messages = messages
+        self.entry["reif_content"] = self.messages
+        return self
+
+    def validate_schema(self) -> bool:
+        if self.reif_entry is None:
+            raise RuntimeError("无会话可校验")
+        reif_validate(self.entry)
+        validate(instance=self.messages, schema = SCHEMA)
+        return True
+

rootengine_core-0.5.0/rootengine_core/llm/__init__.py

@@ -0,0 +1,2 @@
+from .llm import BaseLLM
+from .openai_adapter import BaseLLMAdapter,OpenAIAdapter

rootengine_core-0.5.0/rootengine_core/llm/llm.py

@@ -0,0 +1,37 @@
+from typing import Optional,Dict,List,Any
+
+from abc import ABC,abstractmethod
+
+
+class BaseLLM(ABC):
+
+
+    @abstractmethod
+
+    def call(self,
+             messages:List[dict[str,Any]],
+             tool_registry:Optional[List[Dict[str, Any]]],
+             tool_choice: Optional[str],
+             **kwargs)\
+            -> Dict[str, Any]:
+        """
+
+        :param messages: 消息列表 参考 ../schema/source/llm/llm_message.json
+        :param tool_registry: 工具注册表 参考 ../schema/source/tool/tool_registry.json
+        :param tool_choice: 工具选择策略 参考 ../schema/source/llm/tool_choice.json
+        :param kwargs: 拓展任意字段
+        :return: 参考 ../schema/source/llm/llm_output.json
+
+        """
+        pass
+
+
+
+
+
+
+
+
+
+
+