refactor: move clients to sdk package

innsd · innsd · commit a1d4e4c27bf0 · 2025-12-01T12:38:56.000+08:00
(cherry picked from commit 0dc6d5696f4db9d2c8fc3cac5c7cad8a203972bd)
diff --git a/agentkit/sdk/__init__.py b/agentkit/sdk/__init__.py
@@ -0,0 +1,14 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
diff --git a/agentkit/sdk/identity/__init__.py b/agentkit/sdk/identity/__init__.py
diff --git a/agentkit/sdk/identity/auth.py b/agentkit/sdk/identity/auth.py
@@ -18,7 +18,7 @@
 from typing import Any, Callable
 
 from agentkit.utils.credential import get_credential_from_vefaas_iam
-from agentkit.utils.ve_sign import ve_request
+from agentkit.utils.ve_sign import ve_request, get_identity_host_info
 
 
 def requires_api_key(*, provider_name: str, into: str = "api_key"):
@@ -37,6 +37,7 @@ def _get_api_key() -> str:
             access_key = os.getenv("VOLCENGINE_ACCESS_KEY")
             secret_key = os.getenv("VOLCENGINE_SECRET_KEY")
             session_token = ""
+            host, version, service, region = get_identity_host_info()
 
             if not (access_key and secret_key):
                 cred = get_credential_from_vefaas_iam()
@@ -53,10 +54,10 @@ def _get_api_key() -> str:
                 header={"X-Security-Token": session_token} if session_token else {},
                 ak=access_key,
                 sk=secret_key,
-                version="2023-10-01",
-                service="cis_test",
-                host="open.volcengineapi.com",
-                region="cn-beijing",
+                version=version,
+                service=service,
+                host=host,
+                region=region,
             )
 
             try:
diff --git a/agentkit/sdk/knowledge/__init__.py b/agentkit/sdk/knowledge/__init__.py
@@ -11,9 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-from agentkit.knowledge.knowledge import AgentkitKnowledge
-from agentkit.knowledge.knowledge_all_types import (
+from .client import AgentkitKnowledge
+from .types import (
     ListKnowledgeBasesRequest,
     ListKnowledgeBasesResponse,
     AddKnowledgeBaseRequest,
@@ -25,8 +24,6 @@
     KnowledgeBasesForListKnowledgeBases,
     KnowledgeBasesForAddKnowledgeBase,
     ConnectionInfosForGetKnowledgeConnectionInfo,
-    KnowledgeBasesItem,
-    FiltersItem,
 )
 
 __all__ = [
@@ -44,4 +41,4 @@
     "ConnectionInfosForGetKnowledgeConnectionInfo",
     "KnowledgeBasesItem",
     "FiltersItem",
-]
+]
diff --git a/agentkit/sdk/knowledge/client.py b/agentkit/sdk/knowledge/client.py
@@ -19,7 +19,7 @@
 
 from typing import Dict
 from agentkit.client import BaseAgentkitClient
-from agentkit.knowledge.types import (
+from agentkit.sdk.knowledge.types import (
     AddKnowledgeBaseRequest,
     AddKnowledgeBaseResponse,
     DeleteKnowledgeBaseRequest,
diff --git a/agentkit/sdk/knowledge/types.py b/agentkit/sdk/knowledge/types.py
@@ -133,7 +133,6 @@ class ListKnowledgeBasesRequest(KnowledgeBaseModel):
 class ListKnowledgeBasesResponse(KnowledgeBaseModel):
     knowledge_bases: Optional[list[KnowledgeBasesForListKnowledgeBases]] = Field(default=None, alias="KnowledgeBases")
     next_token: Optional[str] = Field(default=None, alias="NextToken")
-    knowledge_bases: Optional[list[KnowledgeBasesForListKnowledgeBases]] = Field(default=None, alias="KnowledgeBases")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
diff --git a/agentkit/sdk/mcp/__init__.py b/agentkit/sdk/mcp/__init__.py
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from agentkit.mcp.mcp import AgentkitMCP
-from agentkit.mcp.mcp_all_types import (
+from .client import AgentkitMCPClient
+from .types import (
     # MCP Service
     CreateMCPServiceRequest,
     CreateMCPServiceResponse,
@@ -46,7 +46,7 @@
 )
 
 __all__ = [
-    "AgentkitMCP",
+    "AgentkitMCPClient",
     # MCP Service
     "CreateMCPServiceRequest",
     "CreateMCPServiceResponse",
diff --git a/agentkit/sdk/mcp/client.py b/agentkit/sdk/mcp/client.py
@@ -19,7 +19,7 @@
 
 from typing import Dict
 from agentkit.client import BaseAgentkitClient
-from agentkit.mcp.types import (
+from .types import (
     CreateMCPServiceRequest,
     CreateMCPServiceResponse,
     CreateMCPToolsetRequest,
diff --git a/agentkit/sdk/mcp/types.py b/agentkit/sdk/mcp/types.py
@@ -498,7 +498,6 @@ class ListMCPToolsetsRequest(MCPBaseModel):
 class ListMCPToolsetsResponse(MCPBaseModel):
     mcp_toolsets: Optional[list[MCPToolsetsForListMCPToolsets]] = Field(default=None, alias="MCPToolsets")
     next_token: Optional[str] = Field(default=None, alias="NextToken")
-    mcp_toolsets: Optional[list[MCPToolsetsForListMCPToolsets]] = Field(default=None, alias="MCPToolsets")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
@@ -620,7 +619,6 @@ class ListMCPServicesRequest(MCPBaseModel):
 class ListMCPServicesResponse(MCPBaseModel):
     mcp_services: Optional[list[MCPServicesForListMCPServices]] = Field(default=None, alias="MCPServices")
     next_token: Optional[str] = Field(default=None, alias="NextToken")
-    mcp_services: Optional[list[MCPServicesForListMCPServices]] = Field(default=None, alias="MCPServices")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
diff --git a/agentkit/sdk/memory/__init__.py b/agentkit/sdk/memory/__init__.py
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from agentkit.memory.memory import AgentkitMemory
-from agentkit.memory.memory_all_types import (
+from .client import AgentkitMemoryClient
+from .types import (
     CreateMemoryCollectionRequest,
     CreateMemoryCollectionResponse,
     UpdateMemoryCollectionRequest,
@@ -41,7 +41,7 @@
 )
 
 __all__ = [
-    "AgentkitMemory",
+    "AgentkitMemoryClient",
     "CreateMemoryCollectionRequest",
     "CreateMemoryCollectionResponse",
     "UpdateMemoryCollectionRequest",
diff --git a/agentkit/sdk/memory/client.py b/agentkit/sdk/memory/client.py
@@ -19,7 +19,7 @@
 
 from typing import Dict
 from agentkit.client import BaseAgentkitClient
-from agentkit.memory.types import (
+from agentkit.sdk.memory.types import (
     AddMemoryCollectionRequest,
     AddMemoryCollectionResponse,
     CreateMemoryCollectionRequest,
diff --git a/agentkit/sdk/memory/types.py b/agentkit/sdk/memory/types.py
@@ -206,7 +206,6 @@ class ListMemoryCollectionsRequest(MemoryBaseModel):
 class ListMemoryCollectionsResponse(MemoryBaseModel):
     memories: Optional[list[MemoriesForListMemoryCollections]] = Field(default=None, alias="Memories")
     next_token: Optional[str] = Field(default=None, alias="NextToken")
-    memories: Optional[list[MemoriesForListMemoryCollections]] = Field(default=None, alias="Memories")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
diff --git a/agentkit/sdk/runtime/__init__.py b/agentkit/sdk/runtime/__init__.py
diff --git a/agentkit/sdk/runtime/client.py b/agentkit/sdk/runtime/client.py
@@ -19,7 +19,7 @@
 
 from typing import Dict
 from agentkit.client import BaseAgentkitClient
-from agentkit.runtime.types import (
+from agentkit.sdk.runtime.types import (
     CreateRuntimeRequest,
     CreateRuntimeResponse,
     DeleteRuntimeRequest,
diff --git a/agentkit/sdk/runtime/types.py b/agentkit/sdk/runtime/types.py
@@ -436,7 +436,6 @@ class ListRuntimeVersionsRequest(RuntimeTypeBaseModel):
 class ListRuntimeVersionsResponse(RuntimeTypeBaseModel):
     agent_kit_runtime_versions: Optional[list[AgentKitRuntimeVersionsForListRuntimeVersions]] = Field(default=None, alias="AgentKitRuntimeVersions")
     next_token: Optional[str] = Field(default=None, alias="NextToken")
-    agent_kit_runtime_versions: Optional[list[AgentKitRuntimeVersionsForListRuntimeVersions]] = Field(default=None, alias="AgentKitRuntimeVersions")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
diff --git a/agentkit/sdk/tools/__init__.py b/agentkit/sdk/tools/__init__.py
@@ -12,6 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from agentkit.tools.tools import AgentkitTools
 
-__all__ = ["AgentkitTools"]
diff --git a/agentkit/sdk/tools/client.py b/agentkit/sdk/tools/client.py
@@ -19,7 +19,7 @@
 
 from typing import Dict
 from agentkit.client import BaseAgentkitClient
-from agentkit.tools.types import (
+from agentkit.sdk.tools.types import (
     CreateSessionRequest,
     CreateSessionResponse,
     CreateToolRequest,
diff --git a/agentkit/sdk/tools/types.py b/agentkit/sdk/tools/types.py
@@ -273,7 +273,6 @@ class ListToolsResponse(ToolsBaseModel):
     tools: Optional[list[ToolsForListTools]] = Field(default=None, alias="Tools")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
-    tools: Optional[list[ToolsForListTools]] = Field(default=None, alias="Tools")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
 
 
@@ -302,7 +301,6 @@ class ListSessionsResponse(ToolsBaseModel):
     session_infos: Optional[list[SessionInfosForListSessions]] = Field(default=None, alias="SessionInfos")
     page_number: Optional[int] = Field(default=None, alias="PageNumber")
     page_size: Optional[int] = Field(default=None, alias="PageSize")
-    session_infos: Optional[list[SessionInfosForListSessions]] = Field(default=None, alias="SessionInfos")
     total_count: Optional[int] = Field(default=None, alias="TotalCount")
 
 
diff --git a/agentkit/toolkit/cli/cli_status.py b/agentkit/toolkit/cli/cli_status.py
@@ -53,14 +53,16 @@ def status_command(
             'running': 'green',
             'stopped': 'yellow',
             'not_deployed': 'dim',
-            'unknown': 'dim'
+            'error': 'red',
+            'unknown': 'dim',
         }.get(status_str, 'white')
         
         status_icon = {
             'running': '✅',
             'stopped': '⏸️',
             'not_deployed': '⚫',
-            'unknown': '❓'
+            'error': '❌',
+            'unknown': '❓',
         }.get(status_str, '●')
         
         console.print(f"\n[bold {status_color}]{status_icon} Service Status: {status_str.upper()}[/bold {status_color}]\n")
diff --git a/agentkit/toolkit/runners/ve_agentkit.py b/agentkit/toolkit/runners/ve_agentkit.py
@@ -27,8 +27,8 @@
 from agentkit.toolkit.reporter import Reporter
 from agentkit.toolkit.errors import ErrorCode
 from agentkit.utils.misc import generate_runtime_name, generate_runtime_role_name, generate_apikey_name, generate_client_token
-from agentkit.runtime.client import AgentkitRuntimeClient
-import agentkit.runtime.types as runtime_types
+from agentkit.sdk.runtime.client import AgentkitRuntimeClient
+import agentkit.sdk.runtime.types as runtime_types
 
 from agentkit.toolkit.volcengine.iam import VeIAM
 
@@ -194,12 +194,10 @@ def status(self, config: VeAgentkitRunnerConfig) -> StatusResult:
                     metadata={"message": "Runtime not deployed"}
                 )
             
-            # Get Runtime information
             runtime = self.agentkit_runtime_client.get_runtime(runtime_types.GetRuntimeRequest(runtime_id=runner_config.runtime_id))
             if not runner_config.runtime_apikey:
                 runner_config.runtime_apikey = runtime.authorizer_configuration.key_auth.api_key
 
-            # Check endpoint connectivity
             ping_status = None
             public_endpoint = self.get_public_endpoint_of_runtime(runtime)
             if runtime.status == RUNTIME_STATUS_READY and public_endpoint:
@@ -214,7 +212,6 @@ def status(self, config: VeAgentkitRunnerConfig) -> StatusResult:
                     logger.error(f"Failed to check endpoint connectivity: {str(e)}")
                     ping_status = False
             
-            # Map Runtime status to standard status
             if runtime.status == RUNTIME_STATUS_READY:
                 status = "running"
             elif runtime.status == RUNTIME_STATUS_ERROR:
diff --git a/agentkit/utils/ve_sign.py b/agentkit/utils/ve_sign.py
@@ -281,8 +281,17 @@ def get_volc_ak_sk_region(service: str = ""):
 
 
 def get_volc_agentkit_host_info():
-    # 优先使用新的 VOLCENGINE_* 环境变量，兼容旧的 VOLC_* 环境变量
     host = os.getenv("VOLCENGINE_AGENTKIT_HOST") or os.getenv("VOLC_AGENTKIT_HOST")
     api_version = os.getenv("VOLCENGINE_AGENTKIT_API_VERSION") or os.getenv("VOLC_AGENTKIT_API_VERSION")
     service_code = os.getenv("VOLCENGINE_AGENTKIT_SERVICE") or os.getenv("VOLC_AGENTKIT_SERVICE")
     return host if host else "open.volcengineapi.com", api_version if api_version else "2025-10-30", service_code if service_code else "agentkit"
+
+
+
+def get_identity_host_info():
+    host = os.getenv("VOLCENGINE_IDENTITY_HOST") or os.getenv("VOLC_IDENTITY_HOST")
+    api_version = os.getenv("VOLCENGINE_IDENTITY_API_VERSION") or os.getenv("VOLC_IDENTITY_API_VERSION")
+    service_code = os.getenv("VOLCENGINE_IDENTITY_SERVICE") or os.getenv("VOLC_IDENTITY_SERVICE")
+    region = os.getenv("VOLCENGINE_IDENTITY_REGION") or os.getenv("VOLC_IDENTITY_REGION")
+    return host if host else "open.volcengineapi.com", api_version if api_version else "2023-10-01", service_code if service_code else "cis_test", region if region else "cn-beijing"
+
diff --git a/docs/content/3.agentkit-sdk/1.overview.md b/docs/content/3.agentkit-sdk/1.overview.md
@@ -212,7 +212,7 @@ if __name__ == "__main__":
 ### 使用 Platform 服务
 
 ```python
-from agentkit.memory import AgentkitMemory
+from agentkit.sdk.memory import AgentkitMemory
 from agentkit.base_client import ApiConfig
 
 # 初始化客户端
