arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/file/file_create_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 Optional
+
+from arkruntime._models import BaseModel
+
+from .preprocess_configs import PreprocessConfigs
+from .purpose import Purpose
+from .tos_storage import TosStorage
+
+
+class FileCreateRequest(BaseModel):
+    purpose: Purpose
+    """
+    The intended purpose of the uploaded file.
+    """
+    preprocess_configs: Optional[PreprocessConfigs] = None
+    """
+    Preprocessing configuration to apply at upload time.
+    """
+    expire_at: Optional[int] = None
+    """
+    Unix timestamp (seconds) after which the file should be purged.
+    Defaults to 7 days from upload when omitted.
+    """
+    url: Optional[str] = None
+    """
+    Alternative file source. Accepts http/https or `tos://` schemes.
+    Mutually exclusive with the binary `file` part.
+    """
+    tos: Optional[TosStorage] = None
+    """
+    User-owned TOS bucket destination. Required when `url` is provided;
+    optional with binary upload.
+    """

arkruntime/types/file/file_create_request_param.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 Optional
+
+from typing_extensions import Required, TypedDict
+
+from .preprocess_configs_param import PreprocessConfigsParam
+from .purpose import Purpose
+from .tos_storage_param import TosStorageParam
+
+
+class FileCreateRequestParam(TypedDict, total=False):
+    purpose: Required[Purpose]
+    """The intended purpose of the uploaded file."""
+
+    preprocess_configs: Optional[PreprocessConfigsParam]
+    """Preprocessing configuration to apply at upload time."""
+
+    expire_at: Optional[int]
+    """
+    Unix timestamp (seconds) after which the file should be purged.
+    Defaults to 7 days from upload when omitted.
+    """
+
+    url: Optional[str]
+    """
+    Alternative file source. Accepts http/https or `tos://` schemes.
+    Mutually exclusive with the binary `file` part.
+    """
+
+    tos: Optional[TosStorageParam]
+    """
+    User-owned TOS bucket destination. Required when `url` is provided;
+    optional with binary upload.
+    """

arkruntime/types/file/file_deleted.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 Literal
+
+from arkruntime._models import BaseModel
+
+
+class FileDeleted(BaseModel):
+    """
+    Response for a successful file deletion.
+    """
+
+    object: Literal["file"]
+    """
+    The object type. Always `file`.
+    """
+    id: str
+    """
+    Id of the deleted file.
+    """
+    deleted: bool
+    """
+    True when the deletion succeeded.
+    """

arkruntime/types/file/file_error.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 arkruntime._models import BaseModel
+
+
+class FileError(BaseModel):
+    """
+    Error envelope returned for files whose processing failed.
+    """
+
+    code: str
+    """
+    Machine-readable error code.
+    """
+    message: str
+    """
+    Human-readable error message.
+    """
+    param: str
+    """
+    The request parameter associated with the error, if any.
+    """
+    type: str
+    """
+    Error type identifier.
+    """

arkruntime/types/file/file_list_response.py

@@ -0,0 +1,42 @@
+# 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 .file_object import FileObject
+
+
+class FileListResponse(BaseModel):
+    """
+    Cursor-paginated response for `GET /files`.
+    """
+
+    object: Literal["file"]
+    """
+    The object type. The Ark file list endpoint returns `file` here
+    (a non-standard convention) rather than `list`. Kept as the literal the
+    server actually emits so generated enums in all SDKs decode cleanly.
+    """
+    data: List[FileObject]
+    """
+    The list of file objects on this page.
+    """
+    first_id: str
+    """
+    Id of the first item in `data`, useful for prepending pages.
+    """
+    last_id: str
+    """
+    Id of the last item in `data`, useful as the `after` cursor.
+    """
+    has_more: bool
+    """
+    True when more items are available after `last_id`.
+    """

arkruntime/types/file/file_object.py

@@ -0,0 +1,71 @@
+# 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 .file_error import FileError
+from .preprocess_configs import PreprocessConfigs
+from .purpose import Purpose
+from .status import Status
+
+
+class FileObject(BaseModel):
+    """
+    File metadata returned by upload, retrieve, and list operations.
+    """
+
+    object: Literal["file"]
+    """
+    The object type. Always `file`.
+    """
+    id: str
+    """
+    Server-generated file id.
+    """
+    purpose: Purpose
+    """
+    The intended purpose of the uploaded file.
+    """
+    filename: str
+    """
+    Original filename of the uploaded file.
+    """
+    bytes: Optional[int] = None
+    """
+    Size of the file in bytes.
+    """
+    mime_type: Optional[str] = None
+    """
+    Detected or declared MIME type of the file.
+    """
+    created_at: int
+    """
+    Unix timestamp (seconds) when the file was created.
+    """
+    expire_at: int
+    """
+    Unix timestamp (seconds) after which the file is purged.
+    """
+    status: Status
+    """
+    Lifecycle status of the file.
+    """
+    download_url: Optional[str] = None
+    """
+    Pre-signed download URL pointing at the underlying TOS object.
+    """
+    error: Optional[FileError] = None
+    """
+    Failure details. Only set when `status` is `failed`.
+    """
+    preprocess_configs: Optional[PreprocessConfigs] = None
+    """
+    Preprocessing configuration applied at upload time.
+    """

arkruntime/types/file/order.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 Order(str, Enum):
+    """
+    Sort order for list endpoints.
+    """
+
+    asc = "asc"
+    desc = "desc"

arkruntime/types/file/preprocess_configs.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .video import Video
+
+
+class PreprocessConfigs(BaseModel):
+    """
+    Preprocessing configuration for an uploaded file.
+    """
+
+    video: Optional[Video] = None
+    """
+    Video preprocessing configuration.
+    """

arkruntime/types/file/preprocess_configs_param.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 typing import Optional
+
+from typing_extensions import TypedDict
+
+from .video_param import VideoParam
+
+
+class PreprocessConfigsParam(TypedDict, total=False):
+    """
+    Preprocessing configuration for an uploaded file.
+    """
+
+    video: Optional[VideoParam]
+    """Video preprocessing configuration."""

arkruntime/types/file/purpose.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 Purpose(str, Enum):
+    """
+    The intended purpose of an uploaded file.
+    """
+
+    user_data = "user_data"
+    agent = "agent"

arkruntime/types/file/status.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 Status(str, Enum):
+    """
+    Lifecycle status of a file in the storage backend.
+    """
+
+    active = "active"
+    processing = "processing"
+    failed = "failed"

arkruntime/types/file/tos_storage.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
+
+
+class TosStorage(BaseModel):
+    """
+    User-owned TOS bucket destination. When provided, files are stored in
+    the user's bucket instead of the default storage and do not count
+    against the 20GB free quota.
+    """
+
+    bucket: Optional[str] = None
+    """
+    TOS bucket name.
+    """
+    prefix: Optional[str] = None
+    """
+    Optional key prefix inside the bucket.
+    """

arkruntime/types/file/tos_storage_param.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 Optional
+
+from typing_extensions import TypedDict
+
+
+class TosStorageParam(TypedDict, total=False):
+    """
+    User-owned TOS bucket destination. When provided, files are stored in
+    the user's bucket instead of the default storage and do not count
+    against the 20GB free quota.
+    """
+
+    bucket: Optional[str]
+    """TOS bucket name."""
+
+    prefix: Optional[str]
+    """Optional key prefix inside the bucket."""

arkruntime/types/file/video.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 Video(BaseModel):
+    """
+    Video preprocessing configuration.
+    """
+
+    fps: Optional[float] = None
+    """
+    Frames-per-second sampling target for video preprocessing.
+    """
+    model: Optional[str] = None
+    """
+    Optional video preprocessing model identifier.
+    """

arkruntime/types/file/video_param.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 Optional
+
+from typing_extensions import TypedDict
+
+
+class VideoParam(TypedDict, total=False):
+    """
+    Video preprocessing configuration.
+    """
+
+    fps: Optional[float]
+    """Frames-per-second sampling target for video preprocessing."""
+
+    model: Optional[str]
+    """Optional video preprocessing model identifier."""

arkruntime/types/images/__init__.py

@@ -0,0 +1,55 @@
+# 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 .bounding_box import BoundingBox
+from .create_image_generation_request import CreateImageGenerationRequest
+from .image_data_item import ImageDataItem
+from .image_error import ImageError
+from .image_generation_response import ImageGenerationResponse
+from .image_generation_stream_event import ImageGenerationStreamEvent
+from .image_generation_stream_event_type import ImageGenerationStreamEventType
+from .optimize_prompt_mode import OptimizePromptMode
+from .optimize_prompt_options import OptimizePromptOptions
+from .output_format import OutputFormat
+from .response_format import ResponseFormat
+from .sequential_image_generation_mode import SequentialImageGenerationMode
+from .sequential_image_generation_options import SequentialImageGenerationOptions
+from .tool import Tool
+from .tool_type import ToolType
+from .tool_usage import ToolUsage
+from .usage import Usage
+
+__all__ = [
+    "BoundingBox",
+    "CreateImageGenerationRequest",
+    "ImageDataItem",
+    "ImageError",
+    "ImageGenerationResponse",
+    "ImageGenerationStreamEvent",
+    "ImageGenerationStreamEventType",
+    "OptimizePromptMode",
+    "OptimizePromptOptions",
+    "OutputFormat",
+    "ResponseFormat",
+    "SequentialImageGenerationMode",
+    "SequentialImageGenerationOptions",
+    "Tool",
+    "ToolType",
+    "ToolUsage",
+    "Usage",
+]
+from .create_image_generation_request_param import CreateImageGenerationRequestParam
+from .optimize_prompt_options_param import OptimizePromptOptionsParam
+from .sequential_image_generation_options_param import (
+    SequentialImageGenerationOptionsParam,
+)
+from .tool_param import ToolParam
+from .tool_type_param import ToolTypeParam
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/images/_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 images 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/images/bounding_box.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 List, Optional
+
+from arkruntime._models import BaseModel
+
+
+class BoundingBox(BaseModel):
+    """
+    A layer's region in the base image, ordered as
+    `[left, top, right, bottom]`.
+    """
+
+    absolute: Optional[List[int]] = None
+    """
+    Coordinates in base-image pixels, with the origin at the top left.
+    """
+    normalized: Optional[List[int]] = None
+    """
+    Coordinates scaled to the integer range `[0, 1000]`.
+    """

arkruntime/types/images/create_image_generation_request.py

@@ -0,0 +1,88 @@
+# 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 .optimize_prompt_options import OptimizePromptOptions
+from .output_format import OutputFormat
+from .response_format import ResponseFormat
+from .sequential_image_generation_mode import SequentialImageGenerationMode
+from .sequential_image_generation_options import SequentialImageGenerationOptions
+from .tool import Tool
+
+
+class CreateImageGenerationRequest(BaseModel):
+    model: str
+    """
+    The model identifier to use.
+    """
+    prompt: str
+    """
+    Text prompt describing the desired image.
+    """
+    image: Optional[List[str]] = None
+    """
+    Reference / edit images. Each entry is a URL or a `data:` URI.
+    """
+    stream: Optional[bool] = None
+    """
+    Stream partial images as they are generated (server-sent events).
+    """
+    response_format: Optional[ResponseFormat] = None
+    """
+    How generated image bytes are returned. Defaults to `url`.
+    """
+    seed: Optional[int] = None
+    """
+    Random seed for reproducible generation.
+    """
+    guidance_scale: Optional[float] = None
+    """
+    Classifier-free guidance scale for the text prompt.
+    """
+    image_guidance_scale: Optional[float] = None
+    """
+    Classifier-free guidance scale for reference images (edit / R2I).
+    """
+    size: Optional[str] = None
+    """
+    Output size hint (e.g. `1024x1024`, `1K`, `2K`, or `auto`). `auto` is supported for layer decomposition.
+    """
+    watermark: Optional[bool] = None
+    """
+    Embed a watermark in the generated image.
+    """
+    sequential_image_generation: Optional[SequentialImageGenerationMode] = None
+    """
+    Multi-image generation mode.
+    """
+    sequential_image_generation_options: Optional[SequentialImageGenerationOptions] = (
+        None
+    )
+    """
+    Tuning for `sequential_image_generation`.
+    """
+    optimize_prompt_options: Optional[OptimizePromptOptions] = None
+    """
+    Prompt-optimizer quality/latency options.
+    """
+    tools: Optional[List[Tool]] = None
+    """
+    Tools the model may invoke during generation.
+    """
+    output_format: Optional[OutputFormat] = None
+    """
+    Container/codec for the generated image bytes.
+    """
+    layer_decomposition: Optional[bool] = None
+    """
+    Decompose one reference image into a base image and independently
+    composable layers. Supported models return layer metadata in `data`.
+    """