arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/chat/reasoning_effort.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 ReasoningEffort(str, Enum):
+    none = "none"
+    minimal = "minimal"
+    low = "low"
+    medium = "medium"
+    high = "high"
+    xhigh = "xhigh"
+    max = "max"

arkruntime/types/chat/request_service_tier.py

@@ -0,0 +1,15 @@
+# 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 RequestServiceTier(str, Enum):
+    auto = "auto"
+    default = "default"
+    fast = "fast"

arkruntime/types/chat/response_format_type.py

@@ -0,0 +1,15 @@
+# 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 ResponseFormatType(str, Enum):
+    text = "text"
+    json_object = "json_object"
+    json_schema = "json_schema"

arkruntime/types/chat/response_service_tier.py

@@ -0,0 +1,15 @@
+# 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 ResponseServiceTier(str, Enum):
+    default = "default"
+    scale = "scale"
+    fast = "fast"

arkruntime/types/chat/thinking.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 import Optional
+
+from arkruntime._models import BaseModel
+
+from .thinking_mode import ThinkingMode
+
+
+class Thinking(BaseModel):
+    type: Optional[ThinkingMode] = None

arkruntime/types/chat/thinking_mode.py

@@ -0,0 +1,15 @@
+# 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 ThinkingMode(str, Enum):
+    enabled = "enabled"
+    disabled = "disabled"
+    auto = "auto"

arkruntime/types/chat/thinking_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 import Optional
+
+from typing_extensions import TypedDict
+
+from .thinking_mode import ThinkingMode
+
+
+class ThinkingParam(TypedDict, total=False):
+    type: Optional[ThinkingMode]

arkruntime/types/chat/tool_choice_mode.py

@@ -0,0 +1,15 @@
+# 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 ToolChoiceMode(str, Enum):
+    auto = "auto"
+    none = "none"
+    required = "required"

arkruntime/types/chat/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["function"])

arkruntime/types/chat/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["function"]

arkruntime/types/chat/video_image_pixel_limit.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 arkruntime._models import BaseModel
+
+
+class VideoImagePixelLimit(BaseModel):
+    max_pixels: Optional[int] = None
+    min_pixels: Optional[int] = None

arkruntime/types/chat/video_image_pixel_limit_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 import Optional
+
+from typing_extensions import TypedDict
+
+
+class VideoImagePixelLimitParam(TypedDict, total=False):
+    max_pixels: Optional[int]
+
+    min_pixels: Optional[int]

arkruntime/types/completion_usage.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2025 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+# License text: https://github.com/volcengine/ark-runtime-python/blob/main/LICENSE
+
+from pydantic import BaseModel
+from typing import Optional
+
+__all__ = ["CompletionUsage", "PromptTokensDetails"]
+
+
+class PromptTokensDetails(BaseModel):
+    cached_tokens: int
+    """Number of tokens hit cache."""
+    provisioned_tokens: Optional[int] = None
+    """Number of tokens provisioned in the prompt."""
+    audio_tokens: Optional[int] = None
+    """Number of audio tokens in the prompt."""
+
+
+class CompletionTokensDetails(BaseModel):
+    reasoning_tokens: Optional[int] = None
+    """Tokens generated by the model for reasoning."""
+    provisioned_tokens: Optional[int] = None
+    """Number of tokens provisioned in the generated completion."""
+    audio_tokens: Optional[int] = None
+    """Number of audio tokens in the generated completion."""
+
+
+class CompletionUsage(BaseModel):
+    completion_tokens: int
+    """Number of tokens in the generated completion."""
+
+    prompt_tokens: int
+    """Number of tokens in the prompt."""
+
+    total_tokens: int
+    """Total number of tokens used in the request (prompt + completion)."""
+
+    prompt_tokens_details: Optional[PromptTokensDetails] = None
+    """Prompt tokens details."""
+
+    completion_tokens_details: Optional[CompletionTokensDetails] = None
+    """Breakdown of tokens used in a completion."""

arkruntime/types/content_generation/__init__.py

@@ -0,0 +1,66 @@
+# 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 .audio_role import AudioRole
+from .audio_url import AudioURL
+from .content_generation_task import ContentGenerationTask
+from .content_item import ContentItem
+from .content_type import ContentType
+from .create_content_generation_task_request import CreateContentGenerationTaskRequest
+from .create_content_generation_task_response import CreateContentGenerationTaskResponse
+from .draft_task import DraftTask
+from .image_role import ImageRole
+from .image_url import ImageURL
+from .list_content_generation_tasks_response import ListContentGenerationTasksResponse
+from .reasoning_effort import ReasoningEffort
+from .task_content import TaskContent
+from .task_error import TaskError
+from .task_status import TaskStatus
+from .task_usage import TaskUsage
+from .tool import Tool
+from .tool_type import ToolType
+from .tool_usage import ToolUsage
+from .video_role import VideoRole
+from .video_url import VideoURL
+
+__all__ = [
+    "AudioRole",
+    "AudioURL",
+    "ContentGenerationTask",
+    "ContentItem",
+    "ContentType",
+    "CreateContentGenerationTaskRequest",
+    "CreateContentGenerationTaskResponse",
+    "DraftTask",
+    "ImageRole",
+    "ImageURL",
+    "ListContentGenerationTasksResponse",
+    "ReasoningEffort",
+    "TaskContent",
+    "TaskError",
+    "TaskStatus",
+    "TaskUsage",
+    "Tool",
+    "ToolType",
+    "ToolUsage",
+    "VideoRole",
+    "VideoURL",
+]
+from .audio_url_param import AudioURLParam
+from .content_item_param import ContentItemParam
+from .create_content_generation_task_request_param import (
+    CreateContentGenerationTaskRequestParam,
+)
+from .draft_task_param import DraftTaskParam
+from .image_url_param import ImageURLParam
+from .tool_param import ToolParam
+from .tool_type_param import ToolTypeParam
+from .video_url_param import VideoURLParam
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/content_generation/_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 content_generation 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/content_generation/audio_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
+
+AudioRole = TypeAliasType("AudioRole", Literal["reference_audio"])
+"""
+Role hint for an audio content entry.
+"""

arkruntime/types/content_generation/audio_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 AudioURL(BaseModel):
+    url: str
+    """
+    URL of the audio asset.
+    """

arkruntime/types/content_generation/audio_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 AudioURLParam(TypedDict, total=False):
+    url: Required[str]
+    """URL of the audio asset."""

arkruntime/types/content_generation/content_generation_task.py

@@ -0,0 +1,125 @@
+# 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 .reasoning_effort import ReasoningEffort
+from .task_content import TaskContent
+from .task_error import TaskError
+from .task_status import TaskStatus
+from .task_usage import TaskUsage
+from .tool import Tool
+
+
+class ContentGenerationTask(BaseModel):
+    """
+    Snapshot of a content-generation task.
+    """
+
+    id: str
+    """
+    Task identifier.
+    """
+    model: str
+    """
+    Model used to produce the result.
+    """
+    status: TaskStatus
+    """
+    Lifecycle state.
+    """
+    error: Optional[TaskError] = None
+    """
+    Populated when the task ended in `failed`.
+    """
+    content: Optional[TaskContent] = None
+    """
+    Generated artifact URLs. Populated when the task succeeded.
+    """
+    usage: Optional[TaskUsage] = None
+    """
+    Token / tool usage. Populated when the task is in a terminal state.
+    """
+    created_at: Optional[int] = None
+    """
+    Unix timestamp (seconds) when the task was created.
+    """
+    updated_at: Optional[int] = None
+    """
+    Unix timestamp (seconds) when the task last changed.
+    """
+    seed: Optional[int] = None
+    """
+    Random seed actually used by the algorithm.
+    """
+    resolution: Optional[str] = None
+    """
+    Resolution of the generated output.
+    """
+    ratio: Optional[str] = None
+    """
+    Aspect ratio of the generated output.
+    """
+    duration: Optional[int] = None
+    """
+    Duration of the generated output (seconds).
+    """
+    frames: Optional[int] = None
+    """
+    Frame count of the generated output.
+    """
+    framespersecond: Optional[int] = None
+    """
+    Frames-per-second of the generated output.
+    """
+    revised_prompt: Optional[str] = None
+    """
+    Server-side rewritten prompt, when prompt optimization ran.
+    """
+    subdivisionlevel: Optional[str] = None
+    """
+    Render-quality tier echoed back.
+    """
+    fileformat: Optional[str] = None
+    """
+    File format echoed back.
+    """
+    service_tier: Optional[str] = None
+    """
+    Service tier the task was scheduled on.
+    """
+    execution_expires_after: Optional[int] = None
+    """
+    Soft execution deadline echoed back.
+    """
+    generate_audio: Optional[bool] = None
+    """
+    Whether audio was generated.
+    """
+    draft: Optional[bool] = None
+    """
+    Whether this task is a draft.
+    """
+    draft_task_id: Optional[str] = None
+    """
+    When this task is a refinement, the upstream draft id.
+    """
+    tools: Optional[List[Tool]] = None
+    """
+    Tools that were enabled for the task.
+    """
+    reasoning_effort: Optional[ReasoningEffort] = None
+    """
+    Reasoning effort echoed back.
+    """
+    safety_identifier: Optional[str] = None
+    """
+    Safety identifier echoed back.
+    """

arkruntime/types/content_generation/content_item.py

@@ -0,0 +1,54 @@
+# 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 .audio_url import AudioURL
+from .content_type import ContentType
+from .draft_task import DraftTask
+from .image_url import ImageURL
+from .video_url import VideoURL
+
+
+class ContentItem(BaseModel):
+    """
+    One element of a generation request `content` list. Exactly one of
+    `text` / `image_url` / `video_url` / `audio_url` / `draft_task` must be
+    set, matching the value of `type`.
+    """
+
+    type: ContentType
+    """
+    Discriminator for which payload field is set.
+    """
+    text: Optional[str] = None
+    """
+    Text content. Required when `type` is `text`.
+    """
+    image_url: Optional[ImageURL] = None
+    """
+    Image content. Required when `type` is `image_url`.
+    """
+    video_url: Optional[VideoURL] = None
+    """
+    Video content. Required when `type` is `video_url`.
+    """
+    audio_url: Optional[AudioURL] = None
+    """
+    Audio content. Required when `type` is `audio_url`.
+    """
+    draft_task: Optional[DraftTask] = None
+    """
+    Draft-task reference. Required when `type` is `draft_task`.
+    """
+    role: Optional[str] = None
+    """
+    Optional role tag (e.g. `first_frame`, `reference_image`).
+    """

arkruntime/types/content_generation/content_item_param.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 Optional
+
+from typing_extensions import Required, TypedDict
+
+from .audio_url_param import AudioURLParam
+from .content_type import ContentType
+from .draft_task_param import DraftTaskParam
+from .image_url_param import ImageURLParam
+from .video_url_param import VideoURLParam
+
+
+class ContentItemParam(TypedDict, total=False):
+    """
+    One element of a generation request `content` list. Exactly one of
+    `text` / `image_url` / `video_url` / `audio_url` / `draft_task` must be
+    set, matching the value of `type`.
+    """
+
+    type: Required[ContentType]
+    """Discriminator for which payload field is set."""
+
+    text: Optional[str]
+    """Text content. Required when `type` is `text`."""
+
+    image_url: Optional[ImageURLParam]
+    """Image content. Required when `type` is `image_url`."""
+
+    video_url: Optional[VideoURLParam]
+    """Video content. Required when `type` is `video_url`."""
+
+    audio_url: Optional[AudioURLParam]
+    """Audio content. Required when `type` is `audio_url`."""
+
+    draft_task: Optional[DraftTaskParam]
+    """Draft-task reference. Required when `type` is `draft_task`."""
+
+    role: Optional[str]
+    """Optional role tag (e.g. `first_frame`, `reference_image`)."""

arkruntime/types/content_generation/content_type.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 ContentType(str, Enum):
+    """
+    Discriminator for an entry in the request `content` list.
+    """
+
+    text = "text"
+    image_url = "image_url"
+    video_url = "video_url"
+    audio_url = "audio_url"
+    draft_task = "draft_task"