arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/agent/create_agent_request.py

@@ -0,0 +1,65 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, List, Optional
+
+from arkruntime._models import BaseModel
+
+from .agent_skill_ref import AgentSkillRef
+from .mcp_server import MCPServer
+from .model_config import ModelConfig
+from .multiagent_config import MultiagentConfig
+from .tag import Tag
+from .tool_item import ToolItem
+
+
+class CreateAgentRequest(BaseModel):
+    """
+    创建 Agent 的请求体。
+    """
+
+    name: str
+    """
+    人类可读名称。
+    """
+    model: ModelConfig
+    """
+    模型配置。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    system: Optional[str] = None
+    """
+    System prompt。
+    """
+    mcp_servers: Optional[List[MCPServer]] = None
+    """
+    MCP 服务器列表。
+    """
+    tools: Optional[List[ToolItem]] = None
+    """
+    工具配置数组。
+    """
+    skills: Optional[List[AgentSkillRef]] = None
+    """
+    Skill 引用列表。
+    """
+    multiagent: Optional[MultiagentConfig] = None
+    """
+    多 Agent 编排拓扑。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据。
+    """
+    tags: Optional[List[Tag]] = None
+    """
+    资源标签。
+    """

arkruntime/types/agent/delete_agent_response.py

@@ -0,0 +1,20 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from arkruntime._models import BaseModel
+
+
+class DeleteAgentResponse(BaseModel):
+    """
+    Delete Agent 响应体。
+    """
+
+    id: str
+    """
+    被删除的 Agent ID。
+    """

arkruntime/types/agent/list_agents_response.py

@@ -0,0 +1,32 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from arkruntime._models import BaseModel
+
+from .agent import Agent
+
+
+class ListAgentsResponse(BaseModel):
+    """
+    List Agents / List Agent Versions 响应体。
+    """
+
+    data: List[Agent]
+    """
+    本页 Agent 列表。
+    """
+    next_page: Optional[str] = None
+    """
+    下一页页码；无更多数据时为空字符串或缺省。
+    """
+    total: Optional[int] = None
+    """
+    命中总条数（可选，服务器决定是否返回）。
+    """

arkruntime/types/agent/mcp_server.py

@@ -0,0 +1,30 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from arkruntime._models import BaseModel
+
+from .mcp_server_type import MCPServerType
+
+
+class MCPServer(BaseModel):
+    """
+    一个外接 MCP 服务器。
+    """
+
+    name: str
+    """
+    在本 Agent 内唯一，被 `tools[].mcp_server_name` 引用。
+    """
+    type: MCPServerType
+    """
+    MCP server 类型，当前固定 `"url"`。
+    """
+    url: str
+    """
+    MCP server URL。
+    """

arkruntime/types/agent/mcp_server_type.py

@@ -0,0 +1,16 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal
+
+from typing_extensions import TypeAliasType
+
+MCPServerType = TypeAliasType("MCPServerType", Literal["url"])
+"""
+MCP Server 类型。
+"""

arkruntime/types/agent/model_config.py

@@ -0,0 +1,28 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .model_speed import ModelSpeed
+
+
+class ModelConfig(BaseModel):
+    """
+    Agent 引用的模型配置。
+    """
+
+    id: str
+    """
+    模型 ID，例如 `claude-opus-4-7` / `claude-sonnet-4-6` / `claude-haiku-4-5`。
+    """
+    speed: Optional[ModelSpeed] = None
+    """
+    速度档位。空字符串走默认（并非所有模型都支持 `fast`）。
+    """

arkruntime/types/agent/model_speed.py

@@ -0,0 +1,18 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ModelSpeed(str, Enum):
+    """
+    模型速度档位。空字符串走默认。
+    """
+
+    standard = "standard"
+    fast = "fast"

arkruntime/types/agent/multiagent_config.py

@@ -0,0 +1,29 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List
+
+from arkruntime._models import BaseModel
+
+from .agent_ref import AgentRef
+from .multiagent_type import MultiagentType
+
+
+class MultiagentConfig(BaseModel):
+    """
+    多 Agent 协调拓扑。
+    """
+
+    type: MultiagentType
+    """
+    拓扑类型。
+    """
+    agents: List[AgentRef]
+    """
+    下属 Agent 数组，1–20 项；深度限制为 1（被引用的 Agent 自身不能再有 `multiagent`）。
+    """

arkruntime/types/agent/multiagent_type.py

@@ -0,0 +1,16 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal
+
+from typing_extensions import TypeAliasType
+
+MultiagentType = TypeAliasType("MultiagentType", Literal["coordinator"])
+"""
+多 Agent 拓扑类型。
+"""

arkruntime/types/agent/permission_policy.py

@@ -0,0 +1,22 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from arkruntime._models import BaseModel
+
+from .permission_policy_type import PermissionPolicyType
+
+
+class PermissionPolicy(BaseModel):
+    """
+    工具调用许可策略。
+    """
+
+    type: PermissionPolicyType
+    """
+    策略类型。
+    """

arkruntime/types/agent/permission_policy_type.py

@@ -0,0 +1,18 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PermissionPolicyType(str, Enum):
+    """
+    工具调用许可策略类型。
+    """
+
+    always_allow = "always_allow"
+    always_ask = "always_ask"

arkruntime/types/agent/skill_ref_type.py

@@ -0,0 +1,19 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SkillRefType(str, Enum):
+    """
+    Skill 引用类型。
+    """
+
+    anthropic = "anthropic"
+    custom = "custom"
+    skill_hub = "skill_hub"

arkruntime/types/agent/tag.py

@@ -0,0 +1,26 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+
+class Tag(BaseModel):
+    """
+    资源标签。key 必填，value 可空。
+    """
+
+    key: str
+    """
+    标签 key。
+    """
+    value: Optional[str] = None
+    """
+    标签 value；可空。
+    """

arkruntime/types/agent/tool_config.py

@@ -0,0 +1,32 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .permission_policy import PermissionPolicy
+
+
+class ToolConfig(BaseModel):
+    """
+    toolset 类型工具的单条配置项。
+    """
+
+    name: str
+    """
+    工具名。
+    """
+    enabled: Optional[bool] = None
+    """
+    是否启用；缺省走 `default_config.enabled`。
+    """
+    permission_policy: Optional[PermissionPolicy] = None
+    """
+    许可策略；缺省走 `default_config.permission_policy`。
+    """

arkruntime/types/agent/tool_default_config.py

@@ -0,0 +1,28 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .permission_policy import PermissionPolicy
+
+
+class ToolDefaultConfig(BaseModel):
+    """
+    toolset 类型工具的默认配置。
+    """
+
+    enabled: Optional[bool] = None
+    """
+    默认是否启用。
+    """
+    permission_policy: Optional[PermissionPolicy] = None
+    """
+    默认许可策略。
+    """

arkruntime/types/agent/tool_item.py

@@ -0,0 +1,57 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from arkruntime._models import BaseModel
+
+from .tool_config import ToolConfig
+from .tool_default_config import ToolDefaultConfig
+
+
+class ToolItem(BaseModel):
+    """
+    一条工具配置。按 `type` 分三类：
+    - `agent_toolset_<date>`：内置工具集（当前默认 `agent_toolset_20260701`；
+    存量 `agent_toolset_20260401` 仍兼容）
+    - `mcp_toolset`：来自 `mcp_servers[]` 的工具集
+    - `custom`：客户端执行的自定义工具
+
+    所有变体字段合并在一个 model 里，未使用的字段留空即可（proto oneof
+    风格；wire 上就是同一个 JSON 对象按 `type` 决定语义）。
+    """
+
+    type: str
+    """
+    工具 type。
+    """
+    configs: Optional[List[ToolConfig]] = None
+    """
+    toolset 类专用。
+    """
+    default_config: Optional[ToolDefaultConfig] = None
+    """
+    toolset 类专用；未在 `configs` 里显式列出的工具走此默认。
+    """
+    mcp_server_name: Optional[str] = None
+    """
+    `mcp_toolset` 专用；须匹配 `mcp_servers[].name`。
+    """
+    name: Optional[str] = None
+    """
+    `custom` 专用；1–128 字符，`[A-Za-z0-9_-]`。
+    """
+    description: Optional[str] = None
+    """
+    `custom` 专用；1–1024 字符。
+    """
+    input_schema: Optional[str] = None
+    """
+    `custom` 专用；承载 JSON Schema 的字符串形态
+    （wire 上是 JSON-encoded string，非 nested object）。
+    """

arkruntime/types/agent/update_agent_request.py

@@ -0,0 +1,70 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, List, Optional
+
+from arkruntime._models import BaseModel
+
+from .agent_skill_ref import AgentSkillRef
+from .mcp_server import MCPServer
+from .model_config import ModelConfig
+from .multiagent_config import MultiagentConfig
+from .tool_item import ToolItem
+
+
+class UpdateAgentRequest(BaseModel):
+    """
+    更新 Agent 的请求体。语义：
+    - 省略 = 保留
+    - 空字符串/null = 清空（仅 description / system / 数组类）
+    - `name` / `model` 不可清空
+    - `metadata` 走 patch
+    - `mcp_servers` / `tools` / `skills` 整体替换
+    - `version` 必填，必须等于服务端当前版本（乐观并发控制）
+    """
+
+    version: int
+    """
+    期望更新的当前版本号。用于乐观并发控制；不匹配时拒绝写入。
+    """
+    name: Optional[str] = None
+    """
+    人类可读名称。
+    """
+    model: Optional[ModelConfig] = None
+    """
+    模型配置。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    system: Optional[str] = None
+    """
+    System prompt。
+    """
+    mcp_servers: Optional[List[MCPServer]] = None
+    """
+    MCP 服务器列表（整体替换）。
+    """
+    tools: Optional[List[ToolItem]] = None
+    """
+    工具配置数组（整体替换）。
+    """
+    skills: Optional[List[AgentSkillRef]] = None
+    """
+    Skill 引用列表（整体替换）。
+    """
+    multiagent: Optional[MultiagentConfig] = None
+    """
+    多 Agent 编排拓扑。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据（patch）。
+    """