arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/images/create_image_generation_request_param.py

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

arkruntime/types/images/image_data_item.py

@@ -0,0 +1,58 @@
+# 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 .bounding_box import BoundingBox
+from .image_error import ImageError
+from .output_format import OutputFormat
+
+
+class ImageDataItem(BaseModel):
+    """
+    One generated image. Exactly one of `url` / `b64_json` is set, depending on the request `response_format`.
+    """
+
+    url: Optional[str] = None
+    """
+    URL of the generated image. Set when `response_format=url`.
+    """
+    b64_json: Optional[str] = None
+    """
+    Base64-encoded image bytes. Set when `response_format=b64_json`.
+    """
+    size: Optional[str] = None
+    """
+    Resolved output size for this image (e.g. `1024x1024`).
+    """
+    error: Optional[ImageError] = None
+    """
+    Per-image failure (set when this slot failed while others succeeded).
+    """
+    output_format: Optional[OutputFormat] = None
+    """
+    Actual container/codec used for this image.
+    """
+    z_index: Optional[int] = None
+    """
+    Layer stacking order. The base image is `0`; layers follow bottom-up.
+    """
+    bounding_box: Optional[BoundingBox] = None
+    """
+    Layer region in the base image. Omitted for the base image.
+    """
+    name: Optional[str] = None
+    """
+    Model-generated layer label. Omitted for the base image.
+    """
+    description: Optional[str] = None
+    """
+    Model-generated semantic description. Omitted for the base image.
+    """

arkruntime/types/images/image_error.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 ImageError(BaseModel):
+    code: str
+    """
+    Machine-readable error code.
+    """
+    message: str
+    """
+    Human-readable error message.
+    """

arkruntime/types/images/image_generation_response.py

@@ -0,0 +1,43 @@
+# 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 .image_data_item import ImageDataItem
+from .image_error import ImageError
+from .tool import Tool
+from .usage import Usage
+
+
+class ImageGenerationResponse(BaseModel):
+    model: str
+    """
+    Model that produced the result.
+    """
+    created: int
+    """
+    Unix timestamp (seconds) when the response was produced.
+    """
+    data: Optional[List[ImageDataItem]] = None
+    """
+    Generated images. Empty when the request failed entirely.
+    """
+    tools: Optional[List[Tool]] = None
+    """
+    Tools that were invoked.
+    """
+    usage: Optional[Usage] = None
+    """
+    Token / image usage.
+    """
+    error: Optional[ImageError] = None
+    """
+    Top-level failure (set when no images could be produced).
+    """

arkruntime/types/images/image_generation_stream_event.py

@@ -0,0 +1,74 @@
+# 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 .image_error import ImageError
+from .image_generation_stream_event_type import ImageGenerationStreamEventType
+from .tool import Tool
+from .usage import Usage
+
+
+class ImageGenerationStreamEvent(BaseModel):
+    """
+    One frame of the SSE response on POST /images/generations when
+    `stream=true`. Wire format:
+    event: <type>
+    data:  <json>
+
+    Three event types share this single struct (same shape as the legacy
+    IDL); switch on `type` to decide which optional fields are populated:
+
+    - `image_generation.partial_succeeded` → `image_index`, `url` *or*
+    `b64_json`, `size`.
+    - `image_generation.partial_failed`    → `image_index`, `error`.
+    - `image_generation.completed`         → `tools`, `usage`. No `image_*`.
+    """
+
+    type: ImageGenerationStreamEventType
+    """
+    Discriminator.
+    """
+    model: str
+    """
+    Model that produced the result.
+    """
+    created: int
+    """
+    Unix timestamp (seconds) when the event was produced.
+    """
+    image_index: Optional[int] = None
+    """
+    0-based index of the image this event refers to (partial_* only).
+    """
+    url: Optional[str] = None
+    """
+    URL of the partially-generated image (partial_succeeded, response_format=url).
+    """
+    b64_json: Optional[str] = None
+    """
+    Base64-encoded image bytes (partial_succeeded, response_format=b64_json).
+    """
+    size: Optional[str] = None
+    """
+    Resolved size of the partial image, e.g. `1024x1024`.
+    """
+    tools: Optional[List[Tool]] = None
+    """
+    Tools invoked during the stream (completed only).
+    """
+    usage: Optional[Usage] = None
+    """
+    Token / image usage (completed only).
+    """
+    error: Optional[ImageError] = None
+    """
+    Per-event failure (partial_failed; also surfaces top-level failures).
+    """

arkruntime/types/images/image_generation_stream_event_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 ImageGenerationStreamEventType(str, Enum):
+    """
+    Discriminator on `ImageGenerationStreamEvent.type`.
+    """
+
+    image_generation_partial_succeeded = "image_generation.partial_succeeded"
+    image_generation_partial_failed = "image_generation.partial_failed"
+    image_generation_completed = "image_generation.completed"

arkruntime/types/images/optimize_prompt_mode.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 OptimizePromptMode(str, Enum):
+    """
+    Prompt-optimizer mode trade-off (quality vs latency).
+    """
+
+    standard = "standard"
+    fast = "fast"

arkruntime/types/images/optimize_prompt_options.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .optimize_prompt_mode import OptimizePromptMode
+
+
+class OptimizePromptOptions(BaseModel):
+    mode: Optional[OptimizePromptMode] = None
+    """
+    Optimizer mode trade-off (quality vs latency).
+    """

arkruntime/types/images/optimize_prompt_options_param.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 typing import Optional
+
+from typing_extensions import TypedDict
+
+from .optimize_prompt_mode import OptimizePromptMode
+
+
+class OptimizePromptOptionsParam(TypedDict, total=False):
+    mode: Optional[OptimizePromptMode]
+    """Optimizer mode trade-off (quality vs latency)."""

arkruntime/types/images/output_format.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 OutputFormat(str, Enum):
+    """
+    Container/codec for the generated image bytes.
+    """
+
+    jpeg = "jpeg"
+    png = "png"

arkruntime/types/images/response_format.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 ResponseFormat(str, Enum):
+    """
+    How generated image bytes are returned.
+    """
+
+    url = "url"
+    b64_json = "b64_json"

arkruntime/types/images/sequential_image_generation_mode.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 SequentialImageGenerationMode(str, Enum):
+    """
+    Whether the model may emit multiple images for one prompt.
+    """
+
+    auto = "auto"
+    disabled = "disabled"

arkruntime/types/images/sequential_image_generation_options.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+
+class SequentialImageGenerationOptions(BaseModel):
+    max_images: Optional[int] = None
+    """
+    Upper bound on images returned for a single prompt.
+    """

arkruntime/types/images/sequential_image_generation_options_param.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 Optional
+
+from typing_extensions import TypedDict
+
+
+class SequentialImageGenerationOptionsParam(TypedDict, total=False):
+    max_images: Optional[int]
+    """Upper bound on images returned for a single prompt."""

arkruntime/types/images/tool.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 arkruntime._models import BaseModel
+
+from .tool_type import ToolType
+
+
+class Tool(BaseModel):
+    type: ToolType
+    """
+    Tool identifier. Currently only `web_search` is supported.
+    """

arkruntime/types/images/tool_param.py

@@ -0,0 +1,17 @@
+# 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_extensions import Required, TypedDict
+
+
+from .tool_type_param import ToolTypeParam
+
+
+class ToolParam(TypedDict, total=False):
+    type: Required[ToolTypeParam]
+    """Tool identifier. Currently only `web_search` is supported."""

arkruntime/types/images/tool_type.py

@@ -0,0 +1,13 @@
+# 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
+
+ToolType = TypeAliasType("ToolType", Literal["web_search"])

arkruntime/types/images/tool_type_param.py

@@ -0,0 +1,11 @@
+# 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, TypeAlias
+
+ToolTypeParam: TypeAlias = Literal["web_search"]

arkruntime/types/images/tool_usage.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+
+class ToolUsage(BaseModel):
+    web_search: Optional[int] = None
+    """
+    Number of web-search invocations consumed.
+    """

arkruntime/types/images/usage.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .tool_usage import ToolUsage
+
+
+class Usage(BaseModel):
+    input_images: int
+    """
+    Number of reference images supplied by the client.
+    """
+    generated_images: int
+    """
+    Number of images returned in `data`.
+    """
+    output_tokens: Optional[int] = None
+    """
+    Output tokens consumed (for prompt rewriting / reasoning).
+    """
+    total_tokens: Optional[int] = None
+    """
+    Total tokens consumed by the request.
+    """
+    tool_usage: Optional[ToolUsage] = None
+    """
+    Per-tool usage breakdown.
+    """

arkruntime/types/memory/__init__.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 .actor import Actor
+from .actor_type import ActorType
+from .create_memory_request import CreateMemoryRequest
+from .create_memory_store_request import CreateMemoryStoreRequest
+from .delete_memory_response import DeleteMemoryResponse
+from .delete_memory_store_response import DeleteMemoryStoreResponse
+from .list_memories_order_by import ListMemoriesOrderBy
+from .list_memories_response import ListMemoriesResponse
+from .list_memory_stores_response import ListMemoryStoresResponse
+from .memory import Memory
+from .memory_list_item import MemoryListItem
+from .memory_list_item_type import MemoryListItemType
+from .memory_store import MemoryStore
+from .update_memory_request import UpdateMemoryRequest
+from .update_memory_store_request import UpdateMemoryStoreRequest
+
+__all__ = [
+    "Actor",
+    "ActorType",
+    "CreateMemoryRequest",
+    "CreateMemoryStoreRequest",
+    "DeleteMemoryResponse",
+    "DeleteMemoryStoreResponse",
+    "ListMemoriesOrderBy",
+    "ListMemoriesResponse",
+    "ListMemoryStoresResponse",
+    "Memory",
+    "MemoryListItem",
+    "MemoryListItemType",
+    "MemoryStore",
+    "UpdateMemoryRequest",
+    "UpdateMemoryStoreRequest",
+]
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/memory/_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 memory 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/memory/actor.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 arkruntime._models import BaseModel
+
+from .actor_type import ActorType
+
+
+class Actor(BaseModel):
+    """
+    操作者，结构化表示。本期 `type` 恒为 `user_actor`。
+    """
+
+    type: ActorType
+    """
+    Actor 类型。
+    """
+    user_id: str
+    """
+    用户 ID。
+    """

arkruntime/types/memory/actor_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
+
+ActorType = TypeAliasType("ActorType", Literal["user_actor"])
+"""
+Actor 类型。本期恒为 `user_actor`。
+"""