arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/content_generation/create_content_generation_task_request.py

@@ -0,0 +1,106 @@
+# 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 .content_item import ContentItem
+from .reasoning_effort import ReasoningEffort
+from .tool import Tool
+
+
+class CreateContentGenerationTaskRequest(BaseModel):
+    model: str
+    """
+    The model identifier to use.
+    """
+    content: List[ContentItem]
+    """
+    Ordered list of content inputs (text / image / video / audio / draft).
+    """
+    callback_url: Optional[str] = None
+    """
+    Webhook URL invoked when the task transitions to a terminal state.
+    """
+    return_last_frame: Optional[bool] = None
+    """
+    Whether to also return a still of the last generated frame.
+    """
+    service_tier: Optional[str] = None
+    """
+    Service tier hint (e.g. `default`, `priority`).
+    """
+    execution_expires_after: Optional[int] = None
+    """
+    Soft execution deadline in seconds since task creation.
+    """
+    generate_audio: Optional[bool] = None
+    """
+    Generate audio alongside the video.
+    """
+    camera_fixed: Optional[bool] = None
+    """
+    Lock the camera; disables motion.
+    """
+    watermark: Optional[bool] = None
+    """
+    Embed a watermark in the generated video.
+    """
+    seed: Optional[int] = None
+    """
+    Random seed for reproducible generation.
+    """
+    resolution: Optional[str] = None
+    """
+    Output resolution (e.g. `720p`, `1080p`).
+    """
+    ratio: Optional[str] = None
+    """
+    Output aspect ratio (e.g. `16:9`).
+    """
+    duration: Optional[int] = None
+    """
+    Duration of the generated video in seconds.
+    """
+    frames: Optional[int] = None
+    """
+    Total number of frames (alternative to `duration`).
+    """
+    subdivision_level: Optional[str] = None
+    """
+    Render-quality tier (e.g. `high`, `medium`, `low`).
+    """
+    file_format: Optional[str] = None
+    """
+    Output file format (e.g. `mp4`, `glb`).
+    """
+    draft: Optional[bool] = None
+    """
+    Mark this task as a draft (cheaper, lower-quality).
+    """
+    optimize_prompt: Optional[bool] = None
+    """
+    Run the prompt-optimization pass before generation.
+    """
+    tools: Optional[List[Tool]] = None
+    """
+    Tools the model may invoke during generation.
+    """
+    reasoning_effort: Optional[ReasoningEffort] = None
+    """
+    Hint for how much reasoning the model should do.
+    """
+    human_face_mode: Optional[str] = None
+    """
+    Human-face handling mode (e.g. `strict`, `relaxed`).
+    """
+    safety_identifier: Optional[str] = None
+    """
+    End-user identifier for safety/abuse signals.
+    """

arkruntime/types/content_generation/create_content_generation_task_request_param.py

@@ -0,0 +1,83 @@
+# 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 .content_item_param import ContentItemParam
+from .reasoning_effort import ReasoningEffort
+from .tool_param import ToolParam
+
+
+class CreateContentGenerationTaskRequestParam(TypedDict, total=False):
+    model: Required[str]
+    """The model identifier to use."""
+
+    content: Required[List[ContentItemParam]]
+    """Ordered list of content inputs (text / image / video / audio / draft)."""
+
+    callback_url: Optional[str]
+    """Webhook URL invoked when the task transitions to a terminal state."""
+
+    return_last_frame: Optional[bool]
+    """Whether to also return a still of the last generated frame."""
+
+    service_tier: Optional[str]
+    """Service tier hint (e.g. `default`, `priority`)."""
+
+    execution_expires_after: Optional[int]
+    """Soft execution deadline in seconds since task creation."""
+
+    generate_audio: Optional[bool]
+    """Generate audio alongside the video."""
+
+    camera_fixed: Optional[bool]
+    """Lock the camera; disables motion."""
+
+    watermark: Optional[bool]
+    """Embed a watermark in the generated video."""
+
+    seed: Optional[int]
+    """Random seed for reproducible generation."""
+
+    resolution: Optional[str]
+    """Output resolution (e.g. `720p`, `1080p`)."""
+
+    ratio: Optional[str]
+    """Output aspect ratio (e.g. `16:9`)."""
+
+    duration: Optional[int]
+    """Duration of the generated video in seconds."""
+
+    frames: Optional[int]
+    """Total number of frames (alternative to `duration`)."""
+
+    subdivision_level: Optional[str]
+    """Render-quality tier (e.g. `high`, `medium`, `low`)."""
+
+    file_format: Optional[str]
+    """Output file format (e.g. `mp4`, `glb`)."""
+
+    draft: Optional[bool]
+    """Mark this task as a draft (cheaper, lower-quality)."""
+
+    optimize_prompt: Optional[bool]
+    """Run the prompt-optimization pass before generation."""
+
+    tools: Optional[List[ToolParam]]
+    """Tools the model may invoke during generation."""
+
+    reasoning_effort: Optional[ReasoningEffort]
+    """Hint for how much reasoning the model should do."""
+
+    human_face_mode: Optional[str]
+    """Human-face handling mode (e.g. `strict`, `relaxed`)."""
+
+    safety_identifier: Optional[str]
+    """End-user identifier for safety/abuse signals."""

arkruntime/types/content_generation/create_content_generation_task_response.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 arkruntime._models import BaseModel
+
+
+class CreateContentGenerationTaskResponse(BaseModel):
+    id: str
+    """
+    Identifier of the newly created task.
+    """

arkruntime/types/content_generation/draft_task.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 arkruntime._models import BaseModel
+
+
+class DraftTask(BaseModel):
+    id: str
+    """
+    Identifier of the draft task to refine.
+    """

arkruntime/types/content_generation/draft_task_param.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 typing_extensions import Required, TypedDict
+
+
+class DraftTaskParam(TypedDict, total=False):
+    id: Required[str]
+    """Identifier of the draft task to refine."""

arkruntime/types/content_generation/image_role.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 enum import Enum
+
+
+class ImageRole(str, Enum):
+    """
+    Role hint for an image content entry (first frame, last frame, etc).
+    """
+
+    first_frame = "first_frame"
+    last_frame = "last_frame"
+    reference_image = "reference_image"
+    mask = "mask"

arkruntime/types/content_generation/image_url.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 arkruntime._models import BaseModel
+
+
+class ImageURL(BaseModel):
+    url: str
+    """
+    URL of the image.
+    """

arkruntime/types/content_generation/image_url_param.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 typing_extensions import Required, TypedDict
+
+
+class ImageURLParam(TypedDict, total=False):
+    url: Required[str]
+    """URL of the image."""

arkruntime/types/content_generation/list_content_generation_tasks_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 typing import List
+
+from arkruntime._models import BaseModel
+
+from .content_generation_task import ContentGenerationTask
+
+
+class ListContentGenerationTasksResponse(BaseModel):
+    total: int
+    """
+    Total number of tasks matching the filter (across all pages).
+    """
+    items: List[ContentGenerationTask]
+    """
+    Page of tasks.
+    """

arkruntime/types/content_generation/reasoning_effort.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 enum import Enum
+
+
+class ReasoningEffort(str, Enum):
+    low = "low"
+    medium = "medium"
+    high = "high"
+    max = "max"

arkruntime/types/content_generation/task_content.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 Optional
+
+from arkruntime._models import BaseModel
+
+
+class TaskContent(BaseModel):
+    """
+    Generated artifact references attached to a finished task.
+    """
+
+    video_url: Optional[str] = None
+    """
+    URL of the generated video.
+    """
+    file_url: Optional[str] = None
+    """
+    URL of a generated non-video file (e.g. 3D mesh).
+    """
+    last_frame_url: Optional[str] = None
+    """
+    URL of the last-frame image, when `return_last_frame` was requested.
+    """

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

arkruntime/types/content_generation/task_status.py

@@ -0,0 +1,21 @@
+# 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 TaskStatus(str, Enum):
+    """
+    Lifecycle state of a content-generation task.
+    """
+
+    queued = "queued"
+    running = "running"
+    cancelled = "cancelled"
+    succeeded = "succeeded"
+    failed = "failed"

arkruntime/types/content_generation/task_usage.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 .tool_usage import ToolUsage
+
+
+class TaskUsage(BaseModel):
+    completion_tokens: int
+    """
+    Tokens consumed by the completion.
+    """
+    total_tokens: int
+    """
+    Total tokens consumed by the request.
+    """
+    tool_usage: Optional[ToolUsage] = None
+    """
+    Per-tool usage breakdown.
+    """

arkruntime/types/content_generation/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/content_generation/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/content_generation/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/content_generation/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/content_generation/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/content_generation/video_role.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
+
+VideoRole = TypeAliasType("VideoRole", Literal["reference_video"])
+"""
+Role hint for a video content entry.
+"""

arkruntime/types/content_generation/video_url.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 arkruntime._models import BaseModel
+
+
+class VideoURL(BaseModel):
+    url: str
+    """
+    URL of the video asset.
+    """

arkruntime/types/content_generation/video_url_param.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 typing_extensions import Required, TypedDict
+
+
+class VideoURLParam(TypedDict, total=False):
+    url: Required[str]
+    """URL of the video asset."""

arkruntime/types/embedding/__init__.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 .embedding import Embedding
+from .embedding_input import EmbeddingInput
+from .embedding_item import EmbeddingItem
+from .embedding_request import EmbeddingRequest
+from .embedding_response import EmbeddingResponse
+from .embedding_usage import EmbeddingUsage
+from .encoding_format import EncodingFormat
+
+__all__ = [
+    "Embedding",
+    "EmbeddingInput",
+    "EmbeddingItem",
+    "EmbeddingRequest",
+    "EmbeddingResponse",
+    "EmbeddingUsage",
+    "EncodingFormat",
+]
+from .embedding_input_param import EmbeddingInputParam
+from .embedding_request_param import EmbeddingRequestParam
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/embedding/_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 embedding 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/embedding/embedding.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 List, Union
+
+from typing_extensions import TypeAliasType
+
+Embedding = TypeAliasType("Embedding", Union[List[float], str])
+"""
+An embedding vector returned by the API. The shape depends on the
+request's `encoding_format`: a list of floats when `float`, or a
+base64-encoded string when `base64`.
+"""

arkruntime/types/embedding/embedding_input.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 List, Union
+
+from typing_extensions import TypeAliasType
+
+EmbeddingInput = TypeAliasType("EmbeddingInput", Union[str, List[str]])
+"""
+Input text(s) to embed. A single string embeds one input; an array of
+strings embeds each element independently. Each string is limited to
+100,000 bytes and arrays to 256 items.
+"""

arkruntime/types/embedding/embedding_input_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 List, TypeAlias, Union
+
+EmbeddingInputParam: TypeAlias = Union[str, List[str]]
+"""
+Input text(s) to embed. A single string embeds one input; an array of
+strings embeds each element independently. Each string is limited to
+100,000 bytes and arrays to 256 items.
+"""