arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/embedding/embedding_item.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 Literal
+
+from arkruntime._models import BaseModel
+
+from .embedding import Embedding
+
+
+class EmbeddingItem(BaseModel):
+    """
+    A single embedding produced for one input.
+    """
+
+    embedding: Embedding
+    """
+    The embedding vector.
+    """
+    index: int
+    """
+    The index of this embedding in the request `input` array.
+    """
+    object: Literal["embedding"]
+    """
+    The object type. Always `embedding`.
+    """

arkruntime/types/embedding/embedding_request.py

@@ -0,0 +1,39 @@
+# 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 .embedding_input import EmbeddingInput
+from .encoding_format import EncodingFormat
+
+
+class EmbeddingRequest(BaseModel):
+    model: str
+    """
+    Endpoint ID of the model to use.
+    """
+    input: EmbeddingInput
+    """
+    Input text to embed, as a string or array of strings. To embed
+    multiple inputs in one request, pass an array.
+    """
+    encoding_format: Optional[EncodingFormat] = None
+    """
+    The format embeddings are returned in. Defaults to `float`.
+    """
+    dimensions: Optional[int] = None
+    """
+    Override the embedding dimensionality.
+    """
+    user: Optional[str] = None
+    """
+    A unique identifier representing the end-user, which can help the
+    service monitor and detect abuse.
+    """

arkruntime/types/embedding/embedding_request_param.py

@@ -0,0 +1,37 @@
+# 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 typing_extensions import Required, TypedDict
+
+from .embedding_input_param import EmbeddingInputParam
+from .encoding_format import EncodingFormat
+
+
+class EmbeddingRequestParam(TypedDict, total=False):
+    model: Required[str]
+    """Endpoint ID of the model to use."""
+
+    input: Required[EmbeddingInputParam]
+    """
+    Input text to embed, as a string or array of strings. To embed
+    multiple inputs in one request, pass an array.
+    """
+
+    encoding_format: Optional[EncodingFormat]
+    """The format embeddings are returned in. Defaults to `float`."""
+
+    dimensions: Optional[int]
+    """Override the embedding dimensionality."""
+
+    user: Optional[str]
+    """
+    A unique identifier representing the end-user, which can help the
+    service monitor and detect abuse.
+    """

arkruntime/types/embedding/embedding_response.py

@@ -0,0 +1,41 @@
+# 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 .embedding_item import EmbeddingItem
+from .embedding_usage import EmbeddingUsage
+
+
+class EmbeddingResponse(BaseModel):
+    id: str
+    """
+    A unique identifier for the embedding response.
+    """
+    object: Literal["list"]
+    """
+    The object type. Always `list`.
+    """
+    created: int
+    """
+    Unix timestamp (in seconds) of when the response was created.
+    """
+    model: str
+    """
+    The model that produced the embeddings.
+    """
+    data: List[EmbeddingItem]
+    """
+    The list of embeddings, one per input.
+    """
+    usage: EmbeddingUsage
+    """
+    Token usage information for the request.
+    """

arkruntime/types/embedding/embedding_usage.py

@@ -0,0 +1,24 @@
+# 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 EmbeddingUsage(BaseModel):
+    """
+    Token usage information for an embedding request.
+    """
+
+    prompt_tokens: int
+    """
+    The number of tokens consumed by the prompt.
+    """
+    total_tokens: int
+    """
+    The total number of tokens used by the request.
+    """

arkruntime/types/embedding/encoding_format.py

@@ -0,0 +1,14 @@
+# 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 EncodingFormat(str, Enum):
+    float = "float"
+    base64 = "base64"

arkruntime/types/environment/__init__.py

@@ -0,0 +1,36 @@
+# 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 .create_environment_request import CreateEnvironmentRequest
+from .delete_environment_response import DeleteEnvironmentResponse
+from .env_config import EnvConfig
+from .env_config_type import EnvConfigType
+from .environment import Environment
+from .environment_scope import EnvironmentScope
+from .list_environments_response import ListEnvironmentsResponse
+from .networking_config import NetworkingConfig
+from .networking_type import NetworkingType
+from .packages_config import PackagesConfig
+from .update_environment_request import UpdateEnvironmentRequest
+
+__all__ = [
+    "CreateEnvironmentRequest",
+    "DeleteEnvironmentResponse",
+    "EnvConfig",
+    "EnvConfigType",
+    "Environment",
+    "EnvironmentScope",
+    "ListEnvironmentsResponse",
+    "NetworkingConfig",
+    "NetworkingType",
+    "PackagesConfig",
+    "UpdateEnvironmentRequest",
+]
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/environment/_init_extras_shim.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Hand-written extras shim for the environment API (empty stub).
+
+Preserved across regen via the Makefile rsync --exclude=*_shim.py rule.
+Add re-exports here as needed.
+"""
+
+from __future__ import annotations
+
+__all__: list[str] = []

arkruntime/types/environment/create_environment_request.py

@@ -0,0 +1,41 @@
+# 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, Optional
+
+from arkruntime._models import BaseModel
+
+from .env_config import EnvConfig
+from .environment_scope import EnvironmentScope
+
+
+class CreateEnvironmentRequest(BaseModel):
+    """
+    创建 Environment 的请求体。
+    """
+
+    name: str
+    """
+    人类可读名称。
+    """
+    config: Optional[EnvConfig] = None
+    """
+    运行环境配置。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据。
+    """
+    scope: Optional[EnvironmentScope] = None
+    """
+    一期未启用；仅协议占位。
+    """

arkruntime/types/environment/delete_environment_response.py

@@ -0,0 +1,24 @@
+# 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 DeleteEnvironmentResponse(BaseModel):
+    """
+    Delete Environment 响应体。
+    """
+
+    id: str
+    """
+    被删除的 Environment ID。
+    """
+    type: str
+    """
+    对象类型标识。
+    """

arkruntime/types/environment/env_config.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 Dict, Optional
+
+from arkruntime._models import BaseModel
+
+from .env_config_type import EnvConfigType
+from .networking_config import NetworkingConfig
+from .packages_config import PackagesConfig
+
+
+class EnvConfig(BaseModel):
+    """
+    Environment 的运行环境配置。按 `type` 区分 cloud / self_hosted。
+    """
+
+    type: EnvConfigType
+    """
+    运行环境类型。
+    """
+    networking: Optional[NetworkingConfig] = None
+    """
+    容器出网策略。
+    """
+    packages: Optional[PackagesConfig] = None
+    """
+    启动时预装的依赖包。
+    """
+    env: Optional[Dict[str, str]] = None
+    """
+    容器启动时注入的环境变量。
+    """

arkruntime/types/environment/env_config_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 EnvConfigType(str, Enum):
+    """
+    Environment 运行环境类型。
+    """
+
+    cloud = "cloud"
+    self_hosted = "self_hosted"

arkruntime/types/environment/environment.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 Dict, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .env_config import EnvConfig
+from .environment_scope import EnvironmentScope
+
+
+class Environment(BaseModel):
+    """
+    ARK Managed Agents 控制面 Environment 资源。
+    """
+
+    id: str
+    """
+    Environment ID。
+    """
+    type: Literal["environment"]
+    """
+    固定 `"environment"`。
+    """
+    name: str
+    """
+    人类可读名称。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    config: Optional[EnvConfig] = None
+    """
+    运行环境配置。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据。
+    """
+    scope: Optional[EnvironmentScope] = None
+    """
+    一期未启用；仅协议占位。
+    """
+    created_at: str
+    """
+    RFC 3339 时间。
+    """
+    updated_at: str
+    """
+    RFC 3339 时间。
+    """

arkruntime/types/environment/environment_scope.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 EnvironmentScope(str, Enum):
+    """
+    Environment 作用域。一期未启用；仅协议占位。
+    """
+
+    organization = "organization"
+    account = "account"

arkruntime/types/environment/list_environments_response.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 List, Optional
+
+from arkruntime._models import BaseModel
+
+from .environment import Environment
+
+
+class ListEnvironmentsResponse(BaseModel):
+    """
+    List Environments 响应体。
+    """
+
+    data: List[Environment]
+    """
+    本页 Environment 列表。
+    """
+    next_page: Optional[str] = None
+    """
+    下一页 cursor（opaque）。
+    - 存在 → 还有更多数据，把此值作为下次请求的 `page` 参数
+    - 不存在 → 已列尽
+    """

arkruntime/types/environment/networking_config.py

@@ -0,0 +1,37 @@
+# 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 .networking_type import NetworkingType
+
+
+class NetworkingConfig(BaseModel):
+    """
+    容器出网策略。
+    """
+
+    type: NetworkingType
+    """
+    出网策略类型。
+    """
+    allow_mcp_servers: Optional[bool] = None
+    """
+    是否允许出网到 Environment/session 关联的 MCP servers。
+    """
+    allow_package_managers: Optional[bool] = None
+    """
+    是否允许出网到常见包管理器 (pip / apt / npm 等) 的官方镜像。
+    """
+    allowed_hosts: Optional[List[str]] = None
+    """
+    显式允许的出网域名列表；`limited` 模式下与 `allow_*` 白名单叠加生效。
+    未设置时仅走 `allow_*` 语义控制。
+    """

arkruntime/types/environment/networking_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 NetworkingType(str, Enum):
+    """
+    容器出网策略。
+    """
+
+    unrestricted = "unrestricted"
+    limited = "limited"

arkruntime/types/environment/packages_config.py

@@ -0,0 +1,47 @@
+# 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
+
+
+class PackagesConfig(BaseModel):
+    """
+    启动时预装的依赖包。版本通过包管理器自身语义指定 (e.g. pip 用
+    `"pkg==1.0.0"`；不指定版本则装最新)。
+    """
+
+    type: Optional[Literal["packages"]] = None
+    """
+    固定 `"packages"`；标识这是 Packages 配置。
+    """
+    pip: Optional[List[str]] = None
+    """
+    pip 依赖条目列表。
+    """
+    apt: Optional[List[str]] = None
+    """
+    apt 包名列表。
+    """
+    npm: Optional[List[str]] = None
+    """
+    npm 包名列表。
+    """
+    cargo: Optional[List[str]] = None
+    """
+    cargo crate 名列表。
+    """
+    gem: Optional[List[str]] = None
+    """
+    RubyGems gem 名列表。
+    """
+    go: Optional[List[str]] = None
+    """
+    go module import 路径列表。
+    """

arkruntime/types/environment/update_environment_request.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 Dict, Optional
+
+from arkruntime._models import BaseModel
+
+from .env_config import EnvConfig
+from .environment_scope import EnvironmentScope
+
+
+class UpdateEnvironmentRequest(BaseModel):
+    """
+    更新 Environment 的请求体。语义：
+    - 省略字段 = 保留原值
+    - `description` 显式空字符串或 null = 清空
+    - `config` 嵌套字段按 patch 处理
+    - `metadata` 走 patch
+    """
+
+    name: Optional[str] = None
+    """
+    人类可读名称。
+    """
+    config: Optional[EnvConfig] = None
+    """
+    运行环境配置。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据。
+    """
+    scope: Optional[EnvironmentScope] = None
+    """
+    一期未启用；仅协议占位。
+    """

arkruntime/types/file/__init__.py

@@ -0,0 +1,40 @@
+# 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 .file_create_request import FileCreateRequest
+from .file_deleted import FileDeleted
+from .file_error import FileError
+from .file_list_response import FileListResponse
+from .file_object import FileObject
+from .order import Order
+from .preprocess_configs import PreprocessConfigs
+from .purpose import Purpose
+from .status import Status
+from .tos_storage import TosStorage
+from .video import Video
+
+__all__ = [
+    "FileCreateRequest",
+    "FileDeleted",
+    "FileError",
+    "FileListResponse",
+    "FileObject",
+    "Order",
+    "PreprocessConfigs",
+    "Purpose",
+    "Status",
+    "TosStorage",
+    "Video",
+]
+from .file_create_request_param import FileCreateRequestParam
+from .preprocess_configs_param import PreprocessConfigsParam
+from .tos_storage_param import TosStorageParam
+from .video_param import VideoParam
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/file/_init_extras_shim.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Hand-written extras shim for the file API (empty stub).
+
+Preserved across regen via the Makefile rsync --exclude=*_shim.py rule.
+Add re-exports here as needed.
+"""
+
+from __future__ import annotations
+
+__all__: list[str] = []