arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/chat/chat_completion_stream_options_param.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 typing import Optional
+
+from typing_extensions import TypedDict
+
+
+class ChatCompletionStreamOptionsParam(TypedDict, total=False):
+    include_usage: Optional[bool]
+    """Whether to include token usage info in the final stream chunk."""
+
+    chunk_include_usage: Optional[bool]
+    """Whether to include token usage info in every stream chunk."""

arkruntime/types/chat/chat_completion_stream_response.py

@@ -0,0 +1,34 @@
+# 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
+
+from .chat_completion_service_status import ChatCompletionServiceStatus
+from .chat_completion_stream_response_choice import ChatCompletionStreamResponseChoice
+from .completion_usage import CompletionUsage
+from .response_service_tier import ResponseServiceTier
+
+
+class ChatCompletionStreamResponse(BaseModel):
+    id: str
+    model: str
+    created: int
+    object: Literal["chat.completion.chunk"]
+    """
+    The object type. Always `chat.completion.chunk`.
+    """
+    choices: List[ChatCompletionStreamResponseChoice]
+    usage: Optional[CompletionUsage]
+    """
+    Usage statistics. Only present on the final chunk (or every chunk
+    when `stream_options.chunk_include_usage` is set); otherwise `null`.
+    """
+    service_tier: Optional[ResponseServiceTier] = None
+    service_status: Optional[ChatCompletionServiceStatus] = None

arkruntime/types/chat/chat_completion_stream_response_choice.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 Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_stream_choice_logprobs import ChatCompletionStreamChoiceLogprobs
+from .chat_completion_stream_response_delta import ChatCompletionStreamResponseDelta
+from .finish_reason import FinishReason
+from .moderation_hit_type import ModerationHitType
+
+
+class ChatCompletionStreamResponseChoice(BaseModel):
+    index: int
+    delta: ChatCompletionStreamResponseDelta
+    finish_reason: Optional[FinishReason] = None
+    """
+    The reason the model stopped generating tokens.
+    """
+    moderation_hit_type: Optional[ModerationHitType] = None
+    logprobs: Optional[ChatCompletionStreamChoiceLogprobs] = None

arkruntime/types/chat/chat_completion_stream_response_delta.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 List, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_message_tool_call_chunk import ChatCompletionMessageToolCallChunk
+
+
+class ChatCompletionStreamResponseDelta(BaseModel):
+    role: Optional[str] = None
+    """
+    The role of the author of this message.
+    """
+    content: Optional[str] = None
+    """
+    The contents of the chunk message.
+    """
+    reasoning_content: Optional[str] = None
+    """
+    The reasoning content delta.
+    """
+    encrypted_content: Optional[str] = None
+    """
+    Encrypted reasoning content delta.
+    """
+    tool_calls: Optional[List[ChatCompletionMessageToolCallChunk]] = None
+    """
+    The tool calls generated by the model.
+    """

arkruntime/types/chat/chat_completion_token_logprob.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 List, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_token_logprob_top_logprob import (
+    ChatCompletionTokenLogprobTopLogprob,
+)
+
+
+class ChatCompletionTokenLogprob(BaseModel):
+    token: str
+    logprob: float
+    bytes: Optional[List[int]]
+    """
+    A list of integers representing the UTF-8 bytes representation of
+    the token. May be `null` if there is no bytes representation.
+    """
+    top_logprobs: List[ChatCompletionTokenLogprobTopLogprob]

arkruntime/types/chat/chat_completion_token_logprob_top_logprob.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 List
+
+from arkruntime._models import BaseModel
+
+
+class ChatCompletionTokenLogprobTopLogprob(BaseModel):
+    token: str
+    logprob: float
+    bytes: List[int]

arkruntime/types/chat/chat_completion_tool.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
+
+from .function_object import FunctionObject
+from .tool_type import ToolType
+
+
+class ChatCompletionTool(BaseModel):
+    type: ToolType
+    """
+    The type of the tool. Currently, only `function` is supported.
+    """
+    function: FunctionObject

arkruntime/types/chat/chat_completion_tool_choice.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 Union
+
+from typing_extensions import TypeAliasType
+
+from .chat_completion_named_tool_choice import ChatCompletionNamedToolChoice
+from .tool_choice_mode import ToolChoiceMode
+
+ChatCompletionToolChoice = TypeAliasType(
+    "ChatCompletionToolChoice", Union[ToolChoiceMode, ChatCompletionNamedToolChoice]
+)

arkruntime/types/chat/chat_completion_tool_choice_function.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 arkruntime._models import BaseModel
+
+
+class ChatCompletionToolChoiceFunction(BaseModel):
+    name: str

arkruntime/types/chat/chat_completion_tool_choice_function_param.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_extensions import Required, TypedDict
+
+
+class ChatCompletionToolChoiceFunctionParam(TypedDict, total=False):
+    name: Required[str]

arkruntime/types/chat/chat_completion_tool_choice_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 TypeAlias, Union
+
+from .chat_completion_named_tool_choice_param import ChatCompletionNamedToolChoiceParam
+from .tool_choice_mode import ToolChoiceMode
+
+ChatCompletionToolChoiceParam: TypeAlias = Union[
+    ToolChoiceMode, ChatCompletionNamedToolChoiceParam
+]

arkruntime/types/chat/chat_completion_tool_param.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_extensions import Required, TypedDict
+
+
+from .function_object_param import FunctionObjectParam
+from .tool_type_param import ToolTypeParam
+
+
+class ChatCompletionToolParam(TypedDict, total=False):
+    type: Required[ToolTypeParam]
+    """The type of the tool. Currently, only `function` is supported."""
+
+    function: Required[FunctionObjectParam]

arkruntime/types/chat/completion_tokens_details.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 CompletionTokensDetails(BaseModel):
+    reasoning_tokens: int
+    """
+    Reasoning tokens emitted by the model.
+    """

arkruntime/types/chat/completion_usage.py

@@ -0,0 +1,35 @@
+# 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 .completion_tokens_details import CompletionTokensDetails
+from .prompt_tokens_details import PromptTokensDetails
+
+
+class CompletionUsage(BaseModel):
+    prompt_tokens: int
+    """
+    Number of tokens in the prompt.
+    """
+    completion_tokens: int
+    """
+    Number of tokens in the generated completion.
+    """
+    total_tokens: int
+    """
+    Total tokens used (prompt + completion).
+    """
+    prompt_tokens_details: PromptTokensDetails
+    """
+    A detailed breakdown of the prompt tokens.
+    """
+    completion_tokens_details: CompletionTokensDetails
+    """
+    A detailed breakdown of the completion tokens.
+    """

arkruntime/types/chat/error.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 arkruntime._models import BaseModel
+
+
+class Error(BaseModel):
+    code: str
+    """
+    A machine-readable error code.
+    """
+    message: str
+    """
+    A human-readable description of the error.
+    """
+    param: str
+    """
+    The parameter that caused the error, if applicable.
+    """
+    type: str
+    """
+    The error type.
+    """

arkruntime/types/chat/error_response.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 arkruntime._models import BaseModel
+
+from .error import Error
+
+
+class ErrorResponse(BaseModel):
+    error: Error

arkruntime/types/chat/finish_reason.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 FinishReason(str, Enum):
+    stop = "stop"
+    length = "length"
+    tool_calls = "tool_calls"
+    content_filter = "content_filter"

arkruntime/types/chat/function_object.py

@@ -0,0 +1,35 @@
+# 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
+
+
+class FunctionObject(BaseModel):
+    name: str
+    """
+    The name of the function to be called. Must be a-z, A-Z, 0-9, or
+    contain underscores and dashes, with a maximum length of 64.
+    """
+    description: Optional[str] = None
+    """
+    A description of what the function does, used by the model to choose
+    when and how to call the function.
+    """
+    parameters: Optional[Dict[str, object]] = None
+    """
+    The parameters the function accepts, described as a JSON Schema
+    object. Omitting `parameters` defines a function with an empty
+    parameter list.
+    """
+    strict: Optional[bool] = None
+    """
+    Whether to enable strict schema adherence when generating the function
+    call.
+    """

arkruntime/types/chat/function_object_param.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 typing_extensions import Required, TypedDict
+
+
+class FunctionObjectParam(TypedDict, total=False):
+    name: Required[str]
+    """
+    The name of the function to be called. Must be a-z, A-Z, 0-9, or
+    contain underscores and dashes, with a maximum length of 64.
+    """
+
+    description: Optional[str]
+    """
+    A description of what the function does, used by the model to choose
+    when and how to call the function.
+    """
+
+    parameters: Optional[Dict[str, object]]
+    """
+    The parameters the function accepts, described as a JSON Schema
+    object. Omitting `parameters` defines a function with an empty
+    parameter list.
+    """
+
+    strict: Optional[bool]
+    """
+    Whether to enable strict schema adherence when generating the function
+    call.
+    """

arkruntime/types/chat/image_detail.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 ImageDetail(str, Enum):
+    auto = "auto"
+    high = "high"
+    low = "low"
+    xhigh = "xhigh"

arkruntime/types/chat/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 ImagePixelLimit(BaseModel):
+    max_pixels: Optional[int] = None
+    min_pixels: Optional[int] = None

arkruntime/types/chat/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 ImagePixelLimitParam(TypedDict, total=False):
+    max_pixels: Optional[int]
+
+    min_pixels: Optional[int]

arkruntime/types/chat/model_fallback_status.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 ModelFallbackStatus(BaseModel):
+    fallback_triggered: bool
+    """
+    Whether a model fallback was triggered for this request.
+    """
+    original_model: str
+    """
+    The model originally requested before fallback.
+    """

arkruntime/types/chat/moderation_hit_type.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 ModerationHitType(str, Enum):
+    violence = "violence"
+    severe_violation = "severe_violation"

arkruntime/types/chat/parsed_chat_completion_shim.py

@@ -0,0 +1,52 @@
+# 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 typing import List, Generic, TypeVar, Optional
+
+from ..._models import GenericModel
+from .chat_completion_response import ChatCompletionResponse
+from .chat_completion_response_choice import ChatCompletionResponseChoice
+from .chat_completion_response_message import ChatCompletionResponseMessage
+from .parsed_function_tool_call_shim import ParsedFunctionToolCall
+
+__all__ = [
+    "ParsedChatCompletion",
+    "ParsedChoice",
+    "ParsedChatCompletionMessage",
+]
+
+
+ContentType = TypeVar("ContentType")
+
+# we need to disable this check because we're overriding properties
+# with subclasses of their types which is technically unsound as
+# properties can be mutated.
+# pyright: reportIncompatibleVariableOverride=false
+
+
+class ParsedChatCompletionMessage(
+    ChatCompletionResponseMessage, GenericModel, Generic[ContentType]
+):
+    parsed: Optional[ContentType] = None
+    """The auto-parsed message contents"""
+
+    tool_calls: Optional[List[ParsedFunctionToolCall]] = None  # type: ignore[assignment]
+    """The tool calls generated by the model, such as function calls."""
+
+
+class ParsedChoice(
+    ChatCompletionResponseChoice, GenericModel, Generic[ContentType]
+):
+    message: ParsedChatCompletionMessage[ContentType]
+    """A chat completion message generated by the model."""
+
+
+class ParsedChatCompletion(
+    ChatCompletionResponse, GenericModel, Generic[ContentType]
+):
+    choices: List[ParsedChoice[ContentType]]  # type: ignore[assignment]
+    """A list of chat completion choices.
+
+    Can be more than one if `n` is greater than 1.
+    """

arkruntime/types/chat/parsed_function_tool_call_shim.py

@@ -0,0 +1,29 @@
+# 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 typing import Optional
+
+from .chat_completion_message_tool_call import ChatCompletionMessageToolCall
+from .chat_completion_message_tool_call_function import (
+    ChatCompletionMessageToolCallFunction,
+)
+
+__all__ = ["ParsedFunctionToolCall", "ParsedFunction"]
+
+# we need to disable this check because we're overriding properties
+# with subclasses of their types which is technically unsound as
+# properties can be mutated.
+# pyright: reportIncompatibleVariableOverride=false
+
+
+class ParsedFunction(ChatCompletionMessageToolCallFunction):
+    parsed_arguments: Optional[object] = None
+    """
+    The arguments to call the function with.
+    """
+
+
+class ParsedFunctionToolCall(ChatCompletionMessageToolCall):
+    function: ParsedFunction
+    """The function that the model called."""

arkruntime/types/chat/prompt_tokens_details.py

@@ -0,0 +1,34 @@
+# 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 PromptTokensDetails(BaseModel):
+    cached_tokens: int
+    """
+    Cached prompt tokens.
+    """
+    text_tokens: Optional[int] = None
+    """
+    Prompt tokens consumed by text inputs.
+    """
+    image_tokens: Optional[int] = None
+    """
+    Prompt tokens consumed by image inputs.
+    """
+    audio_tokens: Optional[int] = None
+    """
+    Prompt tokens consumed by audio inputs.
+    """
+    audio_cached_tokens: Optional[int] = None
+    """
+    Cached prompt tokens consumed by audio inputs.
+    """