arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/session/managed_agents_event_params.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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_system_message_event_params import (
+    ManagedAgentsSystemMessageEventParams,
+)
+from .managed_agents_user_custom_tool_result_event_params import (
+    ManagedAgentsUserCustomToolResultEventParams,
+)
+from .managed_agents_user_define_outcome_event_params import (
+    ManagedAgentsUserDefineOutcomeEventParams,
+)
+from .managed_agents_user_interrupt_event_params import (
+    ManagedAgentsUserInterruptEventParams,
+)
+from .managed_agents_user_message_event_params import (
+    ManagedAgentsUserMessageEventParams,
+)
+from .managed_agents_user_tool_confirmation_event_params import (
+    ManagedAgentsUserToolConfirmationEventParams,
+)
+from .managed_agents_user_tool_result_event_params import (
+    ManagedAgentsUserToolResultEventParams,
+)
+
+ManagedAgentsEventParams = TypeAliasType(
+    "ManagedAgentsEventParams",
+    Annotated[
+        Union[
+            ManagedAgentsUserMessageEventParams,
+            ManagedAgentsSystemMessageEventParams,
+            ManagedAgentsUserInterruptEventParams,
+            ManagedAgentsUserToolConfirmationEventParams,
+            ManagedAgentsUserToolResultEventParams,
+            ManagedAgentsUserCustomToolResultEventParams,
+            ManagedAgentsUserDefineOutcomeEventParams,
+        ],
+        Field(discriminator="type"),
+    ],
+)
+"""
+客户端可提交的 7 种事件 tagged union（discriminator = `type`）。
+SDK marshal 变体时自动注入 `"type": "<value>"`，调用方不必手填该字段。
+
+变体名的 `.` 通过反引号 escape，但 discriminator 值就是原始形态
+（如 `"user.message"`）。
+"""

arkruntime/types/session/managed_agents_file_rubric_params.py

@@ -0,0 +1,23 @@
+# 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 arkruntime._models import BaseModel
+
+
+class ManagedAgentsFileRubricParams(BaseModel):
+    """
+    通过 Files API 上传后引用的 rubric 文件。
+    """
+
+    file_id: str
+    """
+    file id，形如 `file_...`。
+    """
+    type: Literal["file"]

arkruntime/types/session/managed_agents_image_block.py

@@ -0,0 +1,25 @@
+# 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 arkruntime._models import BaseModel
+
+from .image_source import ImageSource
+
+
+class ManagedAgentsImageBlock(BaseModel):
+    """
+    图片块。
+    """
+
+    source: ImageSource
+    """
+    图片来源。
+    """
+    type: Literal["image"]

arkruntime/types/session/managed_agents_message_content_block.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 typing import Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_document_block import ManagedAgentsDocumentBlock
+from .managed_agents_image_block import ManagedAgentsImageBlock
+from .managed_agents_text_block import ManagedAgentsTextBlock
+
+ManagedAgentsMessageContentBlock = TypeAliasType(
+    "ManagedAgentsMessageContentBlock",
+    Annotated[
+        Union[
+            ManagedAgentsTextBlock, ManagedAgentsImageBlock, ManagedAgentsDocumentBlock
+        ],
+        Field(discriminator="type"),
+    ],
+)
+"""
+`user.message` 的 content 列表元素 tagged union（discriminator = `type`）。
+支持 3 种模态：`text` / `image` / `document`。
+"""

arkruntime/types/session/managed_agents_rubric.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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_file_rubric_params import ManagedAgentsFileRubricParams
+from .managed_agents_text_rubric_params import ManagedAgentsTextRubricParams
+
+ManagedAgentsRubric = TypeAliasType(
+    "ManagedAgentsRubric",
+    Annotated[
+        Union[ManagedAgentsFileRubricParams, ManagedAgentsTextRubricParams],
+        Field(discriminator="type"),
+    ],
+)
+"""
+评测 rubric tagged union——`file` 引用 / 内联 `text`。
+"""

arkruntime/types/session/managed_agents_search_result_block.py

@@ -0,0 +1,38 @@
+# 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, Literal
+
+from arkruntime._models import BaseModel
+
+from .search_result_citations import SearchResultCitations
+from .search_result_content import SearchResultContent
+
+
+class ManagedAgentsSearchResultBlock(BaseModel):
+    """
+    搜索结果块——多个 SearchResultContent 文本片段 + 元信息。
+    """
+
+    citations: SearchResultCitations
+    """
+    citation 控制。
+    """
+    content: List[SearchResultContent]
+    """
+    结果内容片段。
+    """
+    source: str
+    """
+    结果来源标识。
+    """
+    title: str
+    """
+    结果标题。
+    """
+    type: Literal["search_result"]

arkruntime/types/session/managed_agents_session_event.py

@@ -0,0 +1,34 @@
+# 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 ManagedAgentsSessionEvent(BaseModel):
+    """
+    会话流上的一个事件。`type` 是判别式，其余字段随 type 变化。SDK 层建议
+    把这个模型作为出流事件的公共 envelope；具体 variant 的 payload 可以在
+    消费侧按 `type` 再解构。`event_start` / `event_delta` 的强类型结构见
+    `ManagedAgentsStreamPreviewEvent`；这两种瞬时预览帧不携带 `id` /
+    `processed_at`。
+    """
+
+    type: str
+    """
+    事件类型判别式，例如 `agent.message` / `event_start` / `event_delta` / `session.status_idle`。
+    """
+    id: Optional[str] = None
+    """
+    事件 id（服务端在 ingest 阶段 stamp，形如 `sevt-<ts>-<rand>`）。
+    """
+    processed_at: Optional[str] = None
+    """
+    事件产生时间（RFC 3339）。
+    """

arkruntime/types/session/managed_agents_start_event.py

@@ -0,0 +1,31 @@
+# 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 arkruntime._models import BaseModel
+
+from .managed_agents_start_event_preview import ManagedAgentsStartEventPreview
+
+
+class ManagedAgentsStartEvent(BaseModel):
+    """
+    `event_start`：打开一次 buffered 事件的流式预览。该帧仅在流式接口通过
+    `event_deltas` opt-in 后出现，不进入事件历史，也不携带顶层 `id` /
+    `processed_at`。通常由相同 id 的完整 buffered 事件收尾；若模型请求中途
+    结束，则由对应的 `span.model_request_end` 关闭预览。
+    """
+
+    type: Literal["event_start"]
+    """
+    固定 `"event_start"`。
+    """
+    event: ManagedAgentsStartEventPreview
+    """
+    被预览的 `agent.message` 或 `agent.thinking`。
+    """

arkruntime/types/session/managed_agents_start_event_preview.py

@@ -0,0 +1,27 @@
+# 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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_agent_message_preview import ManagedAgentsAgentMessagePreview
+from .managed_agents_agent_thinking_preview import ManagedAgentsAgentThinkingPreview
+
+ManagedAgentsStartEventPreview = TypeAliasType(
+    "ManagedAgentsStartEventPreview",
+    Annotated[
+        Union[ManagedAgentsAgentMessagePreview, ManagedAgentsAgentThinkingPreview],
+        Field(discriminator="type"),
+    ],
+)
+"""
+`event_start.event` 的 tagged union。目标事件的 `type` 决定后续
+`event_delta` 应累积到 `agent.message` 还是 `agent.thinking`。
+"""

arkruntime/types/session/managed_agents_stream_preview_event.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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_delta_event import ManagedAgentsDeltaEvent
+from .managed_agents_start_event import ManagedAgentsStartEvent
+
+ManagedAgentsStreamPreviewEvent = TypeAliasType(
+    "ManagedAgentsStreamPreviewEvent",
+    Annotated[
+        Union[ManagedAgentsStartEvent, ManagedAgentsDeltaEvent],
+        Field(discriminator="type"),
+    ],
+)
+"""
+流式预览新增的两种 SSE 帧。
+"""

arkruntime/types/session/managed_agents_system_content_block.py

@@ -0,0 +1,23 @@
+# 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 Annotated
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_text_block import ManagedAgentsTextBlock
+
+ManagedAgentsSystemContentBlock = TypeAliasType(
+    "ManagedAgentsSystemContentBlock",
+    Annotated[ManagedAgentsTextBlock, Field(discriminator="type")],
+)
+"""
+`system.message` 的 content 列表元素——目前仅支持文本块，保留 union 语义以便
+未来无破坏性扩展（image / document 等）。
+"""

arkruntime/types/session/managed_agents_system_message_event_params.py

@@ -0,0 +1,34 @@
+# 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, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .managed_agents_system_content_block import ManagedAgentsSystemContentBlock
+
+
+class ManagedAgentsSystemMessageEventParams(BaseModel):
+    """
+    `system.message`：把 system 侧的显式消息插入到 turn 输入（用于 rubric
+    补充、外部 world state 灌注等场景）。`content` 是文本 block 列表。
+    """
+
+    content: Optional[List[ManagedAgentsSystemContentBlock]] = None
+    """
+    消息 content：目前仅支持文本块。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id；SDK 通常从 URL 路径推断，此字段可省。
+    """
+    session_thread_id: Optional[str] = None
+    """
+    目标 session_thread_id（可选）。
+    """
+    type: Literal["system.message"]

arkruntime/types/session/managed_agents_text_block.py

@@ -0,0 +1,23 @@
+# 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 arkruntime._models import BaseModel
+
+
+class ManagedAgentsTextBlock(BaseModel):
+    """
+    文本块。用于 user.message / tool_result / system.message 的 content 列表。
+    """
+
+    text: str
+    """
+    文本内容。
+    """
+    type: Literal["text"]

arkruntime/types/session/managed_agents_text_rubric_params.py

@@ -0,0 +1,23 @@
+# 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 arkruntime._models import BaseModel
+
+
+class ManagedAgentsTextRubricParams(BaseModel):
+    """
+    直接以字符串内联的 rubric 文本。
+    """
+
+    content: str
+    """
+    rubric 内容。
+    """
+    type: Literal["text"]

arkruntime/types/session/managed_agents_tool_result_content_block.py

@@ -0,0 +1,34 @@
+# 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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .managed_agents_document_block import ManagedAgentsDocumentBlock
+from .managed_agents_image_block import ManagedAgentsImageBlock
+from .managed_agents_search_result_block import ManagedAgentsSearchResultBlock
+from .managed_agents_text_block import ManagedAgentsTextBlock
+
+ManagedAgentsToolResultContentBlock = TypeAliasType(
+    "ManagedAgentsToolResultContentBlock",
+    Annotated[
+        Union[
+            ManagedAgentsTextBlock,
+            ManagedAgentsImageBlock,
+            ManagedAgentsDocumentBlock,
+            ManagedAgentsSearchResultBlock,
+        ],
+        Field(discriminator="type"),
+    ],
+)
+"""
+`user.tool_result.content` / `user.custom_tool_result.content` 允许的 block
+类型 tagged union：`text` / `image` / `document` / `search_result`。
+"""

arkruntime/types/session/managed_agents_user_custom_tool_result_event_params.py

@@ -0,0 +1,44 @@
+# 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, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .managed_agents_tool_result_content_block import (
+    ManagedAgentsToolResultContentBlock,
+)
+
+
+class ManagedAgentsUserCustomToolResultEventParams(BaseModel):
+    """
+    `user.custom_tool_result`：custom tool（非 MCP / 非 builtin）执行结果。
+    `custom_tool_use_id` 由 agent.custom_tool_use 提供，与 tool_use 路径区分。
+    """
+
+    custom_tool_use_id: str
+    """
+    关联的 custom_tool_use_id。
+    """
+    content: Optional[List[ManagedAgentsToolResultContentBlock]] = None
+    """
+    工具输出的多模态 block 列表。
+    """
+    is_error: Optional[bool] = None
+    """
+    工具是否失败。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id。
+    """
+    session_thread_id: Optional[str] = None
+    """
+    目标 session_thread_id。
+    """
+    type: Literal["user.custom_tool_result"]

arkruntime/types/session/managed_agents_user_define_outcome_event_params.py

@@ -0,0 +1,45 @@
+# 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, Optional
+
+from arkruntime._models import BaseModel
+
+from .managed_agents_rubric import ManagedAgentsRubric
+
+
+class ManagedAgentsUserDefineOutcomeEventParams(BaseModel):
+    """
+    `user.define_outcome`：声明本 session 的目标 / 评估 rubric，runtime 终局
+    跑评测时使用。`max_iterations` 范围 1..=20，缺省由 server 解析为 3。
+    """
+
+    description: str
+    """
+    目标描述。
+    """
+    outcome_id: Optional[str] = None
+    """
+    outcome id（客户端自定义 unique key）；缺省时由服务端在事件入库前 stamp
+    一个 `outc-<ts>-<rand>` 形态的 id 出来（见 ark-agent-event
+    eventservice.go::ensureUserEventID 的 envelope-level mint 逻辑），
+    因此 wire 上此字段是 optional，不是 required。
+    """
+    rubric: ManagedAgentsRubric
+    """
+    评测 rubric。
+    """
+    max_iterations: Optional[int] = None
+    """
+    最大迭代次数，1–20；缺省 server 解析为 3。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id。
+    """
+    type: Literal["user.define_outcome"]

arkruntime/types/session/managed_agents_user_interrupt_event_params.py

@@ -0,0 +1,31 @@
+# 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, Optional
+
+from arkruntime._models import BaseModel
+
+
+class ManagedAgentsUserInterruptEventParams(BaseModel):
+    """
+    `user.interrupt`：打断当前进行中的 turn。
+    """
+
+    reason: Optional[str] = None
+    """
+    打断原因（可选）。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id；SDK 通常从 URL 路径推断。
+    """
+    session_thread_id: Optional[str] = None
+    """
+    目标 session_thread_id（可选）。
+    """
+    type: Literal["user.interrupt"]

arkruntime/types/session/managed_agents_user_message_event_params.py

@@ -0,0 +1,34 @@
+# 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, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .managed_agents_message_content_block import ManagedAgentsMessageContentBlock
+
+
+class ManagedAgentsUserMessageEventParams(BaseModel):
+    """
+    `user.message`：发一条用户输入到 agent。`content` 是多模态 block 列表。
+
+    关于 `content` optional 语义：CMA / utoipa 把 `content` 标 required，但 wire
+    层实际 sonic.Unmarshal 后 nil slice 与显式 `[]` 等价，服务端把两者都视作
+    "no-op user.message"（旧客户端的 keepalive/ping 调用依赖它）。因此这里
+    declare 成 optional，让 SDK 可以 marshal 出不带 `content` 字段的 wire body。
+    """
+
+    content: Optional[List[ManagedAgentsMessageContentBlock]] = None
+    """
+    消息 content：多模态 block 列表（text / image / document）。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id；SDK 通常从 URL 路径推断，此字段可省。
+    """
+    type: Literal["user.message"]

arkruntime/types/session/managed_agents_user_tool_confirmation_event_params.py

@@ -0,0 +1,46 @@
+# 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, Optional
+
+from arkruntime._models import BaseModel
+
+from .tool_confirmation_result import ToolConfirmationResult
+
+
+class ManagedAgentsUserToolConfirmationEventParams(BaseModel):
+    """
+    `user.tool_confirmation`：响应 agent 发起的 tool 调用授权请求；
+    runtime 收到后放行 / 拒绝当前 tool_use。
+    """
+
+    result: ToolConfirmationResult
+    """
+    授权结果。
+    """
+    tool_use_id: str
+    """
+    关联的 tool_use_id。
+    """
+    deny_message: Optional[str] = None
+    """
+    `deny` 时的说明信息。
+    """
+    session_id: Optional[str] = None
+    """
+    目标 session id。
+    """
+    session_thread_id: Optional[str] = None
+    """
+    目标 session_thread_id。
+    """
+    turn_id: Optional[str] = None
+    """
+    关联的 turn id。
+    """
+    type: Literal["user.tool_confirmation"]