agent-builder-gateway-sdk 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

{agent_builder_gateway_sdk-0.2.0.dist-info → agent_builder_gateway_sdk-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-builder-gateway-sdk
-Version: 0.2.0
+Version: 0.3.1
 Summary: Python SDK for Agent Builder Gateway - 用于 AI 构建的程序调用预制件
 Author: Agent Builder Team
 License: MIT
@@ -52,8 +52,16 @@ client = GatewayClient(jwt_token="your-jwt-token")
 
 # 或使用 API Key
 client = GatewayClient(api_key="sk-xxx")
+
+# 白名单模式（适用于 OpenHands 等白名单环境）
+client = GatewayClient()  # 无需提供认证信息
 ```
 
+**白名单模式说明**：
+- 如果你的环境已配置白名单（如 OpenHands、内部开发环境），可以直接创建客户端而无需提供认证信息
+- SDK 会以无鉴权模式发送请求，由 Gateway 基于 IP 白名单进行验证
+- 这种模式简化了开发流程，无需管理 token
+
 ### 调用预制件
 
 ```python

agent_builder_gateway_sdk-0.3.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+gateway_sdk/__init__.py,sha256=lgBWm1gkpX8nGx-weoJbpQeHRYygJu5XBhB-ienHq5I,655
+gateway_sdk/auth.py,sha256=Nx0p9FYZHBoQeN8SO2nn7MKH2y02v3UR3M8bYqhQG0w,1165
+gateway_sdk/client.py,sha256=FezonUYj9q6-TQXOArmD1VHcSzs4bHoX6ZaxC2bsx3k,7778
+gateway_sdk/exceptions.py,sha256=fIrhKC8vIaocXvyK56OEKPGHn8drvGh6nElnyR0Z71A,1897
+gateway_sdk/models.py,sha256=ge96k0Qcii7ESEwJQoO5fZwUZBcVbe2Ccgna3kPOAB8,6072
+gateway_sdk/streaming.py,sha256=nwRWxKP5bU8uIMIv_82DyFws9djnEKdAxW6S4L9KtPI,1092
+agent_builder_gateway_sdk-0.3.1.dist-info/METADATA,sha256=HfRsk9tFyBL4dEmhv2JRgsBhXF6J2kHveVGMNcOVJHw,6391
+agent_builder_gateway_sdk-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+agent_builder_gateway_sdk-0.3.1.dist-info/licenses/LICENSE,sha256=C3JXUJe4vPtoVe1lp7O4WeGtH71JWYrRaCufEoJ84K0,1076
+agent_builder_gateway_sdk-0.3.1.dist-info/RECORD,,

gateway_sdk/client.py

@@ -38,14 +38,15 @@ class GatewayClient:
             api_key: API Key（优先级高）
             jwt_token: JWT Token（用于 AI 构建的程序）
             timeout: 请求超时时间（秒）
+        
+        Note:
+            如果不提供 api_key 或 jwt_token，客户端将在无鉴权模式下工作。
+            这适用于配置了白名单的环境（如 OpenHands）。
         """
         self.base_url = base_url.rstrip("/")
         self.auth = AuthManager(api_key=api_key, jwt_token=jwt_token)
         self.timeout = timeout
 
-        if not self.auth.is_authenticated():
-            raise AuthenticationError("必须提供 api_key 或 jwt_token")
-
     def run(
         self,
         prefab_id: str,

gateway_sdk/models.py

@@ -66,13 +66,112 @@ class PrefabResult:
         return default
 
     def get_result(self) -> Any:
-        """获取业务结果"""
-        if self.output:
-            return self.output.get("result", self.output)
-        return None
+        """
+        获取完整的 output 字典（保持向后兼容）
+        
+        Returns:
+            完整的 output 字典，包含 status, output, files 等
+        """
+        return self.output
+
+    def get_function_result(self) -> Dict[str, Any]:
+        """
+        获取预制件函数的返回值（对应 manifest.returns）
+        
+        这是响应的嵌套结构：
+        - result.output 是 Gateway 的响应
+        - result.output['output'] 是预制件函数的实际返回值
+        
+        Returns:
+            预制件函数的返回值字典
+            
+        Example:
+            >>> result = client.run(...)
+            >>> function_result = result.get_function_result()
+            >>> if function_result.get('success'):
+            ...     print(function_result.get('message'))
+        """
+        if self.output and isinstance(self.output, dict):
+            return self.output.get('output', {})
+        return {}
+
+    def get_business_success(self) -> bool:
+        """
+        判断业务是否成功（检查函数返回值中的 success 字段）
+        
+        注意：
+        - result.is_success() 表示 SDK 调用成功
+        - result.get_business_success() 表示业务逻辑成功
+        
+        Returns:
+            业务是否成功
+            
+        Example:
+            >>> result = client.run(...)
+            >>> if result.is_success() and result.get_business_success():
+            ...     print("调用成功且业务成功")
+        """
+        function_result = self.get_function_result()
+        return function_result.get('success', False)
+
+    def get_business_message(self) -> str:
+        """
+        获取业务消息
+        
+        Returns:
+            业务消息字符串，如果没有消息则返回空字符串
+            
+        Example:
+            >>> result = client.run(...)
+            >>> print(f"消息: {result.get_business_message()}")
+        """
+        function_result = self.get_function_result()
+        return function_result.get('message', '')
+
+    def get_business_error(self) -> Optional[str]:
+        """
+        获取业务错误信息
+        
+        Returns:
+            错误信息字符串，如果没有错误则返回 None
+            
+        Example:
+            >>> result = client.run(...)
+            >>> if not result.get_business_success():
+            ...     print(f"错误: {result.get_business_error()}")
+        """
+        function_result = self.get_function_result()
+        return function_result.get('error')
+
+    def get_business_error_code(self) -> Optional[str]:
+        """
+        获取业务错误代码
+        
+        Returns:
+            错误代码字符串，如果没有错误码则返回 None
+            
+        Example:
+            >>> result = client.run(...)
+            >>> if not result.get_business_success():
+            ...     print(f"错误码: {result.get_business_error_code()}")
+        """
+        function_result = self.get_function_result()
+        return function_result.get('error_code')
 
     def get_files(self) -> Dict[str, List[str]]:
-        """获取输出文件"""
+        """
+        获取输出文件（S3 URL 列表）
+        
+        Returns:
+            文件字典，key 对应 manifest.files 中定义的 key
+            
+        Example:
+            >>> result = client.run(...)
+            >>> output_files = result.get_files()
+            >>> # 获取特定 key 的输出文件
+            >>> if 'output' in output_files:
+            ...     s3_url = output_files['output'][0]
+        """
         if self.output:
             return self.output.get("files", {})
         return {}

agent_builder_gateway_sdk-0.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-gateway_sdk/__init__.py,sha256=lgBWm1gkpX8nGx-weoJbpQeHRYygJu5XBhB-ienHq5I,655
-gateway_sdk/auth.py,sha256=Nx0p9FYZHBoQeN8SO2nn7MKH2y02v3UR3M8bYqhQG0w,1165
-gateway_sdk/client.py,sha256=GZh2SyQ_598ex1LebSy6ajN9F3APckn7O1u0TrpmpsU,7708
-gateway_sdk/exceptions.py,sha256=fIrhKC8vIaocXvyK56OEKPGHn8drvGh6nElnyR0Z71A,1897
-gateway_sdk/models.py,sha256=_3MspU7qDNTsCppzWxgr-sNhjdVzu6QVVZHpqw4lVMs,2731
-gateway_sdk/streaming.py,sha256=nwRWxKP5bU8uIMIv_82DyFws9djnEKdAxW6S4L9KtPI,1092
-agent_builder_gateway_sdk-0.2.0.dist-info/METADATA,sha256=tBJr9Lfbo28xXzpyxeTnXRMHqmCR6-VtY7Kx4rgZr8k,5966
-agent_builder_gateway_sdk-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-agent_builder_gateway_sdk-0.2.0.dist-info/licenses/LICENSE,sha256=C3JXUJe4vPtoVe1lp7O4WeGtH71JWYrRaCufEoJ84K0,1076
-agent_builder_gateway_sdk-0.2.0.dist-info/RECORD,,