agentrun-inner-test 0.0.62__py3-none-any.whl

agentrun/utils/resource.py

@@ -0,0 +1,291 @@
+"""
+This file is auto generated by the code generation script.
+Do not modify this file manually.
+Use the `make codegen` command to regenerate.
+
+当前文件为自动生成的控制 API 客户端代码。请勿手动修改此文件。
+使用 `make codegen` 命令重新生成。
+
+source: agentrun/utils/__resource_async_template.py
+
+资源基类模板 / Resource Base Template
+
+此模板用于生成资源对象的基类代码。
+This template is used to generate base class code for resource objects.
+"""
+
+from abc import abstractmethod
+import asyncio
+import time
+from typing import Awaitable, Callable, List, Optional
+
+from typing_extensions import Self
+
+from agentrun.utils.config import Config
+from agentrun.utils.exception import DeleteResourceError, ResourceNotExistError
+from agentrun.utils.log import logger
+
+from .model import BaseModel, PageableInput, Status
+
+
+class ResourceBase(BaseModel):
+    status: Optional[Status] = None
+    _config: Optional[Config] = None
+
+    @classmethod
+    @abstractmethod
+    async def _list_page_async(
+        cls,
+        page_input: PageableInput,
+        config: Optional[Config] = None,
+        **kwargs,
+    ) -> list:
+        ...
+
+    @classmethod
+    @abstractmethod
+    def _list_page(
+        cls,
+        page_input: PageableInput,
+        config: Optional[Config] = None,
+        **kwargs,
+    ) -> list:
+        ...
+
+    @classmethod
+    async def _list_all_async(
+        cls,
+        uniq_id_callback: Callable[[Self], str],
+        config: Optional[Config] = None,
+        **kwargs,
+    ) -> list:
+        all_results: List[Self] = []
+        page = 1
+        page_size = 50
+        while True:
+            page_results = await cls._list_page_async(
+                PageableInput(
+                    page_number=page,
+                    page_size=page_size,
+                ),
+                config=config,
+                **kwargs,
+            )
+            page += 1
+            all_results.extend(page_results)  # type: ignore
+            if len(page_results) < page_size:
+                break
+
+        result_set = set()
+        results: list = []
+        for item in all_results:
+            uniq_id = uniq_id_callback(item)
+            if uniq_id not in result_set:
+                result_set.add(uniq_id)
+                results.append(item)
+
+        return results
+
+    @classmethod
+    def _list_all(
+        cls,
+        uniq_id_callback: Callable[[Self], str],
+        config: Optional[Config] = None,
+        **kwargs,
+    ) -> list:
+        all_results: List[Self] = []
+        page = 1
+        page_size = 50
+        while True:
+            page_results = cls._list_page(
+                PageableInput(
+                    page_number=page,
+                    page_size=page_size,
+                ),
+                config=config,
+                **kwargs,
+            )
+            page += 1
+            all_results.extend(page_results)  # type: ignore
+            if len(page_results) < page_size:
+                break
+
+        result_set = set()
+        results: list = []
+        for item in all_results:
+            uniq_id = uniq_id_callback(item)
+            if uniq_id not in result_set:
+                result_set.add(uniq_id)
+                results.append(item)
+
+        return results
+
+    @abstractmethod
+    async def refresh_async(self, config: Optional[Config] = None) -> Self:
+        ...
+
+    @abstractmethod
+    def refresh(self, config: Optional[Config] = None) -> Self:
+        ...
+
+    @abstractmethod
+    async def delete_async(self, config: Optional[Config] = None) -> Self:
+        ...
+
+    @abstractmethod
+    def delete(self, config: Optional[Config] = None) -> Self:
+        ...
+
+    async def __wait_until_async(
+        self,
+        check_finished_callback_async: Callable[[Self], Awaitable[bool]],
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ) -> Self:
+        """等待智能体运行时进入就绪状态"""
+
+        start_time = time.time()
+        while True:
+            if await check_finished_callback_async(self):
+                return self
+
+            if time.time() - start_time > timeout_seconds:
+                raise TimeoutError("等待就绪超时")
+
+            await asyncio.sleep(interval_seconds)
+
+    def __wait_until(
+        self,
+        check_finished_callback: Callable[[Self], bool],
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ) -> Self:
+        """等待智能体运行时进入就绪状态"""
+
+        start_time = time.time()
+        while True:
+            if check_finished_callback(self):
+                return self
+
+            if time.time() - start_time > timeout_seconds:
+                raise TimeoutError("等待就绪超时")
+
+            time.sleep(interval_seconds)
+
+    async def wait_until_ready_or_failed_async(
+        self,
+        callback: Optional[Callable[[Self], None]] = None,
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ):
+        """等待智能体运行时进入就绪状态"""
+
+        async def check_ready_callback(resource: Self) -> bool:
+            await resource.refresh_async()
+            if callback:
+                callback(resource)
+            logger.debug("当前状态：%s", resource.status)
+
+            return Status.is_final_status(resource.status)
+
+        await self.__wait_until_async(
+            check_ready_callback,
+            interval_seconds=interval_seconds,
+            timeout_seconds=timeout_seconds,
+        )
+
+    def wait_until_ready_or_failed(
+        self,
+        callback: Optional[Callable[[Self], None]] = None,
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ):
+        """等待智能体运行时进入就绪状态"""
+
+        def check_ready_callback(resource: Self) -> bool:
+            resource.refresh()
+            if callback:
+                callback(resource)
+            logger.debug("当前状态：%s", resource.status)
+
+            return Status.is_final_status(resource.status)
+
+        self.__wait_until(
+            check_ready_callback,
+            interval_seconds=interval_seconds,
+            timeout_seconds=timeout_seconds,
+        )
+
+    async def delete_and_wait_until_finished_async(
+        self,
+        callback: Optional[Callable[[Self], None]] = None,
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ):
+        """等待智能体运行时被删除"""
+        try:
+            await self.delete_async()
+        except ResourceNotExistError:
+            return
+
+        async def check_deleted_callback(resource: Self) -> bool:
+            try:
+                await resource.refresh_async()
+                if callback:
+                    callback(resource)
+            except ResourceNotExistError:
+                return True
+
+            if resource.status == Status.DELETING:
+                return False
+
+            raise DeleteResourceError(f"Resource status is {resource.status}")
+
+        await self.__wait_until_async(
+            check_deleted_callback,
+            interval_seconds=interval_seconds,
+            timeout_seconds=timeout_seconds,
+        )
+
+    def delete_and_wait_until_finished(
+        self,
+        callback: Optional[Callable[[Self], None]] = None,
+        interval_seconds: int = 5,
+        timeout_seconds: int = 300,
+    ):
+        """等待智能体运行时被删除"""
+        try:
+            self.delete()
+        except ResourceNotExistError:
+            return
+
+        def check_deleted_callback(resource: Self) -> bool:
+            try:
+                resource.refresh()
+                if callback:
+                    callback(resource)
+            except ResourceNotExistError:
+                return True
+
+            if resource.status == Status.DELETING:
+                return False
+
+            raise DeleteResourceError(f"Resource status is {resource.status}")
+
+        self.__wait_until(
+            check_deleted_callback,
+            interval_seconds=interval_seconds,
+            timeout_seconds=timeout_seconds,
+        )
+
+    def set_config(self, config: Config) -> Self:
+        """设置配置
+
+        Args:
+            config: 配置
+
+        Returns:
+            Self: 当前对象
+        """
+        self._config = config
+        return self

agentrun_inner_test-0.0.62.dist-info/METADATA

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: agentrun-inner-test
+Version: 0.0.62
+Summary: Alibaba Cloud Agent Run SDK
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: crcmod>=1.7
+Requires-Dist: pydantic>=2.12.4
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: litellm>=1.79.3
+Requires-Dist: alibabacloud-devs20230714>=2.4.1
+Requires-Dist: pydash>=8.0.5
+Requires-Dist: alibabacloud-agentrun20250910>=5.2.0
+Requires-Dist: alibabacloud_tea_openapi>=0.4.2
+Requires-Dist: alibabacloud_bailian20231229>=2.6.2
+Requires-Dist: agentrun-mem0ai>=0.0.6
+Provides-Extra: server
+Requires-Dist: fastapi>=0.104.0; extra == "server"
+Requires-Dist: uvicorn>=0.24.0; extra == "server"
+Requires-Dist: ag-ui-protocol>=0.1.10; extra == "server"
+Provides-Extra: langchain
+Requires-Dist: langchain>=1.0.0; python_version >= "3.10" and extra == "langchain"
+Requires-Dist: langchain-openai>=1.0.0; python_version >= "3.10" and extra == "langchain"
+Provides-Extra: google-adk
+Requires-Dist: google-adk>=1.18.0; extra == "google-adk"
+Provides-Extra: agentscope
+Requires-Dist: agentscope>=0.1.6; extra == "agentscope"
+Provides-Extra: crewai
+Requires-Dist: crewai>=1.6.0; extra == "crewai"
+Provides-Extra: pydantic-ai
+Requires-Dist: pydantic-ai>=1.22.0; python_version >= "3.10" and extra == "pydantic-ai"
+Provides-Extra: playwright
+Requires-Dist: playwright>=1.40.0; extra == "playwright"
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.21.2; python_version >= "3.10" and extra == "mcp"
+Dynamic: license-file
+
+# AgentRun Python SDK
+
+<div align="center">
+
+[![PyPI version](https://img.shields.io/pypi/v/agentrun-sdk.svg)](https://pypi.org/project/agentrun-sdk/)
+[![License](https://img.shields.io/github/license/Serverless-Devs/agentrun-sdk-python.svg)](https://github.com/Serverless-Devs/agentrun-sdk-python/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-agent.run-blue.svg)](https://docs.agent.run)
+[![GitHub stars](https://img.shields.io/github/stars/Serverless-Devs/agentrun-sdk-python.svg?style=social)](https://github.com/Serverless-Devs/agentrun-sdk-python)
+[![GitHub issues](https://img.shields.io/github/issues/Serverless-Devs/agentrun-sdk-python.svg)](https://github.com/Serverless-Devs/agentrun-sdk-python/issues)
+
+</div>
+
+AgentRun Python SDK 是阿里云 AgentRun 服务的 Python 客户端库，提供简洁易用的 API 来管理 AI Agent 运行时环境。
+
+## ✨ 特性
+
+- 🎯 **简洁 API** - 面向对象的设计，直观易用
+- ⚡ **异步支持** - 同时提供同步和异步接口
+- 🔧 **类型提示** - 完整的类型注解，IDE 友好
+- 🔐 **多种认证** - 支持 Access Key、STS Token 等
+- 🌐 **多区域** - 支持阿里云所有可用区域
+- 📝 **详细文档** - 完善的代码注释和示例
+
+## 📦 安装
+
+### 使用 pip 安装
+
+```bash
+pip install agentrun-sdk
+```
+
+可选依赖项
+- `server`: 使用 AgentRunServer 集成 HTTP 服务
+- `playwright：使用` Browser Sandbox 并集成 playwright
+- `mcp：使用` MCP ToolSet
+- `agentscope：集成` AgentScope
+- `langchain：集成` LangChain
+- `google`-adk：集成 Google ADK
+- `crewai：集成` CrewAI
+- `pydantic`-ai：集成 PydanticAI
+
+假设您需要使用 agentscope，并且需要用到 Browser Sandbox，AgentRun 上的 MCP 服务，那么您应该通过如下方式安装
+```bash
+pip install agentrun-sdk[playwright,mcp,agentscope]
+```
+
+
+### 依赖要求
+
+- Python 3.10 或更高版本
+
+## 🚀 快速开始
+
+你可以使用任意您喜欢的框架进行 Agent 开发，这里以 langchain 为例
+
+### 1. 安装 Serverless Devs
+
+运行脚手架，您需要使用 Serverless Devs 工具，请参考对应 [安装教程](https://serverless-devs.com/docs/user-guide/install)
+> 如果您拥有 NodeJS 开发环境，可以使用 `npm i -g @serverless-devs/s` 快速安装 Serverless Devs
+> 您也可以直接下载 [Serverless Devs 二进制程序](https://github.com/Serverless-Devs/Serverless-Devs/releases) 使用 Serverless Devs
+
+
+### 2. 创建模板
+
+使用快速创建脚手架创建您的 Agent
+
+**注意！** 您需要确保您的 python 环境在 3.10 以上
+
+```bash
+# 初始化模板
+s init agentrun-quick-start-langchain
+
+# 按照实际情况进入代码目录
+cd agentrun-quick-start-langchain/code
+
+# 初始化虚拟环境并安装依赖
+uv venv && uv pip install -r requirements.txt
+```
+
+### 3. 配置认证信息
+
+设置环境变量（建议通过 `.env` 配置您的环境变量）
+
+```bash
+export AGENTRUN_ACCESS_KEY_ID="your-access-key-id"
+export AGENTRUN_ACCESS_KEY_SECRET="your-access-key-secret"
+export AGENTRUN_ACCOUNT_ID="your-account-id"
+export AGENTRUN_REGION="cn-hangzhou"
+```
+
+### 4. 了解 Agent 如何与 LangChain 集成
+
+
+使用 `from agentrun.integration.langchain import model, sandbox_toolset` 导入 langchain 的集成能力，这里默认提供了 `model`、`sandbox_toolset`、`toolset`，可以快速创建 langchain 可识别的大模型、工具
+同时，通过 AgentRunServer 可以快速开放 HTTP Server 供其他业务集成
+
+```python
+from agentrun.integration.langchain import model, sandbox_toolset
+from agentrun.sandbox import TemplateType
+from agentrun.server import AgentRequest, AgentRunServer
+from agentrun.utils.log import logger
+
+# 请替换为您已经创建的 模型 和 沙箱 名称
+MODEL_NAME = "<your-model-name>"
+SANDBOX_NAME = "<your-sandbox-name>"
+
+if MODEL_NAME.startswith("<"):
+    raise ValueError("请将 MODEL_NAME 替换为您已经创建的模型名称")
+
+code_interpreter_tools = []
+if SANDBOX_NAME and not SANDBOX_NAME.startswith("<"):
+    code_interpreter_tools = sandbox_toolset(
+        template_name=SANDBOX_NAME,
+        template_type=TemplateType.CODE_INTERPRETER,
+        sandbox_idle_timeout_seconds=300,
+    )
+else:
+    logger.warning("SANDBOX_NAME 未设置或未替换，跳过加载沙箱工具。")
+
+# ...
+
+# 自动启动 http server，提供 OpenAI 协议
+AgentRunServer(invoke_agent=invoke_agent).start()
+```
+
+### 5. 调用 Agent
+
+```bash
+curl 127.0.0.1:9000/openai/v1/chat/completions \
+  -XPOST \
+  -H "content-type: application/json" \
+  -d '{"messages": [{"role": "user", "content": "通过代码查询现在是几点?"}], "stream":true}'
+```
+
+### 6. 部署项目
+
+项目中已经存在 `s.yaml` 文件，这是 Serverless Devs 的部署配置文件，通过这个文件，您可以配置当前 Agent 在 Agent Run 上的名称、CPU/内存规格、日志投递信息
+
+在示例情况下，您只需要简单修改该文件即可。修改 `role` 字段为授信给阿里云函数计算（FC）服务，需要拥有AliyunAgentRunFullAccess权限的角色（如果您拥有精细化权限控制的需求，可以根据实际使用的 API 收敛权限）
+
+> 您可以点击此[快速授权链接](https://ram.console.aliyun.com/authorize?request=%7B%22template%22%3A%22OldRoleCommonAuthorize%22%2C%22referrer%22%3A%22https%3A%2F%2Ffunctionai.console.aliyun.com%2Fcn-hangzhou%2Fexplore%22%2C%22payloads%22%3A%5B%7B%22missionId%22%3A%22OldRoleCommonAuthorize.FC%22%2C%22roleName%22%3A%22agentRunRole%22%2C%22roleDescription%22%3A%22AgentRun%20auto%20created%20role.%22%2C%22rolePolicies%22%3A%5B%7B%22policyName%22%3A%22AliyunAgentRunFullAccess%22%7D%2C%7B%22policyName%22%3A%22AliyunDevsFullAccess%22%7D%5D%7D%5D%2C%22callback%22%3A%22https%3A%2F%2Ffunctionai.console.aliyun.com%22%7D)，创建一个符合相关权限的角色agentRunRole。
+> 
+> 此快速创建角色的RoleArn为：acs:ram::{您的阿里云主账号 ID}:role/agentRunRole
+
+```yaml
+role: acs:ram::{您的阿里云主账号 ID}:role/{您的阿里云角色名称}
+```
+
+> 如果在未来的使用中遇到了任何 Serverless Devs 相关问题，都可以参考 [Serverless Devs 相关文档](https://serverless-devs.com/docs/overview)
+
+在部署前，您需要配置您的部署密钥，使用 `s config add` 进入交互式密钥管理，并按照引导录入您在阿里云的 Access Key ID 与 Access Key Secret。在录入过程中，您需要短期记忆一下您输入的密钥对名称（假设为 `agentrun-deploy`）
+
+配置完成后，需要首先执行`s build`构建，该步骤依赖本地的`docker`服务，对代码目录下的`requirements.txt`进行构建，以便部署在云端。
+
+随后即可执行`s deploy`进行部署操作。
+
+```bash
+s build
+s deploy -a agentrun-deploy
+# agentrun-deploy 是您使用的密钥对名称，也可以将该名称写入到 s.yaml 开头的 access: 字段中
+```
+
+### 7. 在线上进行调用
+
+部署完成后，您可以看到如下格式的输出
+```
+endpoints: 
+      - 
+        id:          ...
+        arn:         ...
+        name:        ...
+        url:         https://12345.agentrun-data.cn-hangzhou.aliyuncs.com/agent-runtimes/abcd/endpoints/prod/invocations
+```
+
+此处的 url 为您的 Agent 调用地址，将实际的请求 path 拼接到该 base url 后，即可调用云上的 Agent 资源
+
+```bash
+curl https://12345.agentrun-data.cn-hangzhou.aliyuncs.com/agent-runtimes/abcd/endpoints/prod/invocations/openai/v1/chat/completions \
+  -XPOST \
+  -H "content-type: application/json" \
+  -d '{"messages": [{"role": "user", "content": "通过代码查询现在是几点?"}], "stream":true}'
+```
+
+## ⚙️ 配置说明
+
+### Config 类
+
+用于配置认证信息和客户端参数。
+
+```python
+from agentrun.utils.config import Config
+
+config = Config(
+    access_key_id="your-key-id",            # Access Key ID
+    access_key_secret="your-secret",        # Access Key Secret
+    security_token="your-sts-token",        # 可选：STS Token
+    token="token",                          # 数据链路 token（可以在无 AK 情况下调用数据链路）
+    headers={},                             # 附加的请求头
+    account_id="your-account-id",           # 账号 ID
+    region_id="cn-hangzhou",                # 区域
+    timeout=30,                             # 可选：请求超时（秒）
+    control_endpoint="",                    # 可选：自定义控制端点
+    data_endpoint="",                       # 可选：自定义数据端点
+)
+
+# 使用配置创建客户端
+client = agent_runtime.AgentRuntimeClient()
+agent = client.create(input_config, config=config)
+```
+
+### 环境变量
+
+SDK 会自动读取以下环境变量：
+
+| 环境变量 | 说明 | 备用变量 |
+|---------|------|---------|
+| `AGENTRUN_ACCESS_KEY_ID` | Access Key ID | `ALIBABA_CLOUD_ACCESS_KEY_ID` |
+| `AGENTRUN_ACCESS_KEY_SECRET` | Access Key Secret | `ALIBABA_CLOUD_ACCESS_KEY_SECRET` |
+| `AGENTRUN_SECURITY_TOKEN` | STS Token | `ALIBABA_CLOUD_SECURITY_TOKEN` |
+| `AGENTRUN_ACCOUNT_ID` | 账号 ID | `FC_ACCOUNT_ID` |
+| `AGENTRUN_REGION` | 区域 | `FC_REGION` |
+| `AGENTRUN_CONTROL_ENDPOINT` | 控制端点 | - |
+| `AGENTRUN_DATA_ENDPOINT` | 数据端点 | - |
+| `AGENTRUN_SDK_DEBUG` | 开启 DEBUG 日志 | - |
+